CBCF Amf
CBCF Amf
0 (2020-01)
TECHNICAL SPECIFICATION
5G;
5G System;
Access and Mobility Management Services;
Stage 3
(3GPP TS 29.518 version 15.6.0 Release 15)
3GPP TS 29.518 version 15.6.0 Release 15 1 ETSI TS 129 518 V15.6.0 (2020-01)
Reference
RTS/TSGC-0429518vf60
Keywords
5G
ETSI
Important notice
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at [Link]/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
[Link]
If you find errors in the present document, please send your comment to one of the following services:
[Link]
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2020.
All rights reserved.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
GSM® and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 2 ETSI TS 129 518 V15.6.0 (2020-01)
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server ([Link]
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Legal Notice
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 3GPP and ETSI identities can be found under [Link]
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 3 ETSI TS 129 518 V15.6.0 (2020-01)
Contents
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 4 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 5 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 6 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 7 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 8 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 9 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 10 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 11 ETSI TS 129 518 V15.6.0 (2020-01)
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:
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 12 ETSI TS 129 518 V15.6.0 (2020-01)
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] 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
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 23.501: "System Architecture 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".
[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)".
[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".
[21] 3GPP TS 29.168: "Cell Broadcast Centre interfaces with the Evolved Packet Core; Stage 3".
[22] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3".
[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".
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 13 ETSI TS 129 518 V15.6.0 (2020-01)
[26] Void.
[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".
[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".
[38] Void
[39] Void
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].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 14 ETSI TS 129 518 V15.6.0 (2020-01)
4 Overview
4.1 Introduction
Within the 5GC, the AMF offers services to the SMF, other AMF, PCF, SMSF, LMF, GMLC, CBCF, PWS-IWF and
NEF via the Namf 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 AMF and the scope of the present specification.
AMF NEF
SMF
N14
PCF
N11
N15
UDM
N8
Namf AMF
N20
SMSF
NLs
NLg
LMF
N50
GMLC
PWS-
CBCF
IWF
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 15 ETSI TS 129 518 V15.6.0 (2020-01)
The functionalities supported by the AMF are listed in clause 6.2.1 of 3GPP TS 23.501 [2].
5.1 Introduction
The table 5.1-1 shows the AMF Services and AMF Service Operations:
- 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;
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 16 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] Introduction
The Namf_Communication service supports following service operations:
- UEContextTransfer
- RegistrationStatusUpdate
- NonUeN2MessageTransfer
- NonUeN2InfoSubscribe
- NonUeN2INfoUnsubscribe
- N2InfoNotify
- EBIAssignment
- CreateUEContext
- ReleaseUEContext
- AMFStatusChangeSubscribe
- AMFStatusChangeUnsubscribe
- AMFStatusChangeNotify
[Link].1 UEContextTransfer
[Link].1.1 General
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 17 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].4. See also
Figure [Link].1.1-1.
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 payload of the request shall be an object of
"UeContextTranferReqData" data type.
If UE Context Transfer is triggered by UE initial registration or 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 payload.
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 payload of the response shall be an object of "UeContextTransferRspData"
data type, containing:
case a) the representation of the requested UE Context without PDU Session Contexts; 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 payload of the response shall be an object of
"UeContextTransferRspData" data type, containing the representation of the complete UE Context including
available PDU Session Contexts.
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 event subscriptions information in the following cases:
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).
- 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
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 18 ETSI TS 129 518 V15.6.0 (2020-01)
- 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 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 [Link].2).
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 error listed in Table [Link].4.4.2-2.
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 [Link].1.1 shall be applied
with following modifications:
- The {ueContextId} in the URI shall be composed using UE's SUPI, and
- The request body shall not include registration request message from UE.
- The (source) AMF shall skip integrity check and shall respond with the status code "200 OK "with the
complete UE Context including available PDU Session Contexts
[Link].2 RegistrationStatusUpdate
[Link].2.1 General
- Registration with AMF re-allocation procedure (see 3GPP TS 23.502 [3], clause [Link].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 [Link].1.1).
The target AMF shall update the NF Service Producer (i.e. source AMF) 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
[Link].4. See also Figure [Link].2.1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 19 ETSI TS 129 518 V15.6.0 (2020-01)
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 of the status of the UE
registration at the target AMF. The UE's 5G-GUTI is included as the UE identity.
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 payload.
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 pcfReselectionInd to true.
- 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". 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 pcfReselectionInd is set to true, the source AMF shall
terminate the AM Policy Association to the old PCF.
- shall 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.
2b. On failure, one of the HTTP status code listed in Table [Link].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 error listed
in Table [Link].4.5.2-2, where applicable.
[Link].3 CreateUEContext
[Link].3.1 General
- Inter NG-RAN node N2 based handover (see 3GPP TS 23.502 [3], clause [Link])
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 [Link].3.1). See also Figure [Link].3.1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 20 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
1. PUT …/ue-contexts/{ueContextId}(UeContextCreateData)
1. The NF Service Consumer, e.g. source AMF, shall send a PUT request, to create the ueContext in the target
AMF. The payload body 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]).
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 payload body 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
pcfReselectionInd to true. If the pcfReselectionInd 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.
The UE context shall contain event subscriptions information in the following cases:
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).
- 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 inidividual 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 [Link].2).
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].3.1-3 shall be returned. For a 4xx/5xx
response, the message body shall contain a UeContextCreateError structure, including:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 21 ETSI TS 129 518 V15.6.0 (2020-01)
- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table
[Link].3.1-3;
- NgAPCause, if available.
[Link].4 ReleaseUEContext
[Link].4.1 General
- Inter NG-RAN node N2 based handover, Cancel procedure (see 3GPP TS 23.502 [3], clause [Link])
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 [Link].4.2). See also Figure [Link].4.1-1.
NF Service
AMF
Consumer
1. POST …/ue-contexts/{ueContextId}/release(Data)
2a. 204 No Content
1. The NF Service Consumer, e.g. source AMF, shall send a POST request, to release the ueContext in the target
AMF. The payload body of the POST request shall contain any data that needs to be passed to the target AMF.
2a. On success, the target AMF shall return "204 No Content" with an empty payload body in the POST response.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].4.2.2-2.
[Link].1 N1N2MessageTransfer
[Link].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 [Link] of 3GPP TS 23.502 [3]
- Session continuity, service continuity and UP path management (see clause 4.3.5 of TS 23.502 [3])
- Inter NG-RAN node N2 based handover (see clause [Link] of TS 23.502 [3])
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 22 ETSI TS 129 518 V15.6.0 (2020-01)
- UE assisted and UE based positioning procedure (see clause [Link] of TS 23.502 [3])
- UE configuration update procedure for transparent UE policy delivery (see clause [Link] of
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 [Link].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 [Link].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
- N1 SM Information
- 5QI
- NF Instance Identifier and optionally Service Instance Identifier of the NF Service Consumer (e.g. an LMF)
- N1 SM Skipping Indication
NF Service
AMF
Consumer
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 23 ETSI TS 129 518 V15.6.0 (2020-01)
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].3.1-3 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
[Link].3.1-3;
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 [Link].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;
LCS related N1 (LPP) and/or N2 (NRPPa) information is related to 3GPP access in Rel-15.
4xx and 5xx response cases shall also apply to UEs in CM-CONNECTED state, when applicable.
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 [Link].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 [Link].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, which contains information regarding the stored N1/N2 message. 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 [Link].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 [Link] and [Link].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 [Link].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 [Link].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 [Link] and [Link].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 ype is Non-
3GPP access:
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, which holds the status of the
N1/N2 message transfer, e.g. ".../n1-n2-messages/{n1N2MessageId}". 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;
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 24 ETSI TS 129 518 V15.6.0 (2020-01)
- 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 [Link].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 [Link].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.
- Same as step 2b of Figure [Link].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 retry timer
value to the NF Service Consumer in order for the NF Service Consumer to retry the request after the expiry
of the timer. When the retry timer 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 [Link] 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;
- if this is a request to transfer 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 clause [Link]
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.
- Same as step 2b of Figure [Link].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.
- Same as step 2b of Figure [Link].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 [Link].2 and [Link].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 [Link].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 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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 25 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
1. When the AMF determines that the paging or NAS Notification has failed or the indicated non-3GPP PDU
session is not allowed to move to 3GPP access, and if the NF service consumer had provided a notification URI
(see clause [Link].1.2), the AMF shall send a POST request to the NF Service Consumer on that Notification
URI. The AMF shall include the N1N2MessageTransfer request resource URI returned earlier (see clause
[Link].1.2) 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 [Link].3.1.
The NF Service Consumer shall delete any stored representation of the N1N2MessageTransfer request resource
URI upon receiving this notification.
2. The NF Service Consumer shall send a response with "204 No Content" status code.
[Link].3 N1N2MessageSubscribe
[Link].3.1 General
The N1N2MessageSubscribe service operation is used by a NF Service Consumer (e.g. LMF or PCF) to subscribe to
the AMF for notifying N1 messages of a specific type (e.g. LPP) or N2 information of a specific type (e.g. NRPPa). For
the N1 message class is UPDP, a PCF shall subscribe for the N1 message notification with the AMF, after the AM
policy association establishment procedure between the AMF and the PCF (see clause 4.16.1 of 3GPP TS 23.502 [3]).
NOTE: Step 0 of clause [Link] 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. LMF or PCF) may subscribe to notifications of specific N1 message type (e.g. LPP or
UPDP) or N2 information type (e.g. NRPPa). 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
[Link].3.1). See also Figure [Link].3.1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 26 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
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 payload body of the POST request shall contain:
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.
[Link].4 N1N2MessageUnSubscribe
[Link].4.1 General
The N1N2MessageUnSubscribe service operation is used by a NF Service Consumer (e.g. LMF or 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 [Link].3.1), to request the deletion of the subscription for the N1 / N2 message towards the AMF.
See also Figure [Link].4.1-1.
NF Service
AMF
Consumer
1. DELETE ./namf_comm/v1/ue_contexts/{ueContextId}/n1-n2-
messages/subscriptions/{subscriptionId}
2. 204 No Content
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.
[Link].5 N1MessageNotify
[Link].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 [Link].3 of 3GPP TS 23.502 [3])
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 27 ETSI TS 129 518 V15.6.0 (2020-01)
- UE assisted and UE based positioning procedure (see clause [Link] of 3GPP TS 23.502 [3])
- UE configuration update procedure for transparent UE policy delivery (See clause [Link] 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 [Link].1, the UE initiated NAS
transport procedure is used.
The AMF shall use HTTP POST method to the N1 Notification URI provided by the NF Service Consumer via
N1N2MessageSubscribe service operation (See clause [Link].3). See also figure [Link].5.1-1.
NF Service
AMF
Consumer
1. The AMF shall send a HTTP POST request to the N1 Notification URI, and the payload body of the POST
request shall contain an N1MessageNotificatoin data structure with the subscribed N1 message.
2a. On success, "204 No Content" shall be returned and the payload body of the POST response shall be empty.
2b. On failure, one of the HTTP status code listed in Table [Link].4.1-2 shall be returned. The message body shall
contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table
[Link].4.1-2.
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 [Link].5.1 shall apply with the following modifications:
1. The initial AMF discovers the N1 Notification URI of the NF Service Consumer (e.g. the target AMF) from the
NRF (See clause [Link].4 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 [Link].5.1-1, the request payload 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);
- Information from RAN, e.g. User Location, RRC Establishment Cause and UE Context Request;
- the N1 message;
- the Allowed NSSAI together with the corresponding NSI IDs (if network slicing is used and the initial AMF
has obtained).
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 28 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].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 [Link].1), and further identify the corresponding service
instance if Service Instance Identifier was also received, and fetch N1 Notification URI from the default
subscription registered with "N1_MESSAGE" notification type and "LPP" message class (See clause [Link].4 of
3GPP TS 29.510 [29]).
2. Same as step 1 of Figure [Link].5.1-1, the request payload shall include the following information:
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 [Link].5.1 shall apply with the following modifications:
1. Same as step 1 of Figure [Link].5.1-1. The request payload shall include the following information:
[Link].6 N2InfoNotify
[Link].6.1 General
- Inter NG-RAN node N2 based handover procedure (see 3GPP TS 23.502 [3], clause [Link].3)
- Network assisted positioning procedure (See clause [Link] in 3GPP TS 23.502 [3])
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 [Link].3). See also figure [Link].6.1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 29 ETSI TS 129 518 V15.6.0 (2020-01)
1. The AMF shall send a HTTP POST request to the n2InfoNotifyUrl, and the payload body 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 payload body of the POST response shall be empty.
2b. On failure, one of the HTTP status code listed in Table [Link].3.1-2 shall be returned. The message body shall
contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table
[Link].3.1-2.
[Link].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.
The requirements specified in clause [Link].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 [Link].3), shall include a N2Info Notification URI to the
target AMF in the HTTP request message.
1. Same as step 1 of Figure [Link].6.1-1, the request payload shall contain the following information:
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 payload. The
n2NotifySubscriptionId included in the notification payload shall be the UE context Id.
- the source AMF shall release the PDU Session(s) listed in the toReleaseSessionList attribute in the payload
and 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
as specified in step 2a0 of clause [Link].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 payload.
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 30 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].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 [Link].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" information class (See
clause [Link].4 of 3GPP TS 29.510 [29]).
2. Same as step 1 of Figure [Link].6.1-1, the request payload shall contain N2 information of type NRPPa and LCS
correlation identifier.
[Link].1 NonUeN2MessageTransfer
[Link].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 [Link] in 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 [Link].4.2) on the AMF. See also figure
[Link].1.1-1.
NF Service
AMF
Consumer
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, one of the HTTP status code listed in Table [Link].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 [Link].4.2.2-2.
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 [Link].1.1 shall apply with the following modifications:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 31 ETSI TS 129 518 V15.6.0 (2020-01)
1. Same as step 1 of Figure [Link].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 "nfId" attribute.
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 [Link].1.1 shall apply with the following modifications:
1. Same as step 1 of Figure [Link].1.1-1, the request body shall include the N2 Message Container, the ratSelector
IE and optionally the taiList IE, globalRanNodeList IE, omcId IE, or sendRanResponse IE.
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, restricted to the ng-eNBs or gNBs
indicated in the globalRanNodeList 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.
2a. Same as step 2a of Figure [Link].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]).
2b. Same as step 2b of Figure [Link].1.1-1, and the POST response body shall contain following additional
information:
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 [Link].1.1 shall apply with the following modifications:
1. Same as step 1 of Figure [Link].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.
[Link].2 NonUeN2InfoSubscribe
[Link].2.1 General
The NonUeN2InfoSubscribe service operation is used by a NF Service Consumer (e.g. LMF, CBCF or PWS-IWF) to
subscribe to the AMF for notifying non UE specific N2 information of a specific type (e.g. NRPPa or PWS Indications).
An NF Service Consumer (e.g. LMF, CBCF or PWS-IWF) may subscribe to notifications of specific N2 information
type (e,g NRPPa or PWS Indications) 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 [Link].3.1). See also Figure [Link].2.1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 32 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
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 payload body of the POST request shall contain:
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.
[Link].3 NonUeN2InfoUnSubscribe
[Link].3.1 General
The NonUeN2InfoUnSubscribe service operation is used by a NF Service Consumer (e.g. LMF) to unsubscribe to the
AMF to stop notifying N2 information of a specific type (e.g. NRPPa).
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 [Link].3.1), to request the deletion of the subscription for
non UE specific N2 information notification, towards the AMF. See also Figure [Link].3.1-1.
NF Service
AMF
Consumer
1. DELETE ./namf_comm/v1/non-ue-n2-messages/subscriptions/
{n2NotifySubscriptionId}
2. 204 No Content
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.
[Link].4 NonUeN2InfoNotify
[Link].4.1 General
- Obtaining non-UE associated network assistance data (See clause [Link] in 3GPP TS 23.502 [3])
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 33 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].2). See also Figure [Link].4.1-1.
1. The AMF shall send a HTTP POST request to the N2Info Notification URI, and the payload body 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 payload body of the POST response shall be empty.
2b. On failure, one of the HTTP status code listed in Table [Link].3.1-2 shall be returned. The message body shall
contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table
[Link].3.1-2.
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 [Link].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" (see clause [Link].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 clause [Link].4 of 3GPP TS 29.510 [29]).
2. Same as step 1 of Figure [Link].4.1-1, the payload shall contain network assistance data.
The NonUeN2InfoNotify service operation shall be used during the following PWS related events:
1) The AMF has received a Write-Replace-Warning-Confirm response or a PWS-Cancel-Confirm 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 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 has responded
without including the Broadcast Cancelled Area List IE then the AMF shall populate the Broadcast Empty Area List
IE with the NG-RAN node ID and send the (aggregated) Broadcast Empty Area List to the NF Service Consumer.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 34 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].4.1 shall apply with the following modifications:
1. Same as step 1 of Figure [Link].4.1-1, the request body shall include the PWS related N2 information.
[Link].1 AMFStatusChangeSubscribe
[Link].1.1 General
This service operation is used by a NF Service Consumer to subscribe the status change of the AMF.
- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause [Link])
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 [Link].3.1).
NF Service
AMF
Consumer
1. POST …/subscriptions/(subscriptionData)
2a. 201 Created (createdSubscriptionData)
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 [Link].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 [Link].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 [Link].3.1-3.
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 [Link].3.2), as shown in Figure [Link].1.3-1:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 35 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
1. PUT …/subscriptions/{subscriptionId} (subscriptionData)
2a. 200 OK (subscriptionData)
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 payload body of the PUT response shall contain the representation
of the replaced resource.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].3.2-3.
[Link].2 AMFStatusChangeUnSubscribe
[Link].2.1 General
- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause [Link])
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 [Link].3.1).
NF Service
AMF
Consumer
1. DELETE .../subscriptions/{subscriptionId} ()
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 [Link].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 [Link].3.1-3.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 36 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].3 AMFStatusChangeNotify
[Link].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 [Link].1).
- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause [Link])
The operation is invoked by issuing a POST request to each callback URI of the different NF Service Consumer.
NF Service
AMF
Consumer
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.
2b. On failure, one of the HTTP status code listed in Table [Link].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 [Link].3.1-2.
[Link] EBIAssignment
[Link].1 General
The EBIAssignment service operation is used during the following procedures (see 3GPP TS 23.502 [3],
clause [Link]):
- UE requested PDU Session Establishment including Request Types "Initial Request" and "Existing PDU
Session" (Non-roaming and Roaming with Local Breakout (see 3GPP TS 23.502 [3], clause [Link].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 [Link].2).
- UE or network requested PDU Session Modification (non-roaming and roaming with local breakout) (see
3GPP TS 23.502 [3], clause [Link]).
- UE or network requested PDU Session Modification (home-routed roaming) (see 3GPP TS 23.502 [3],
clause [Link]).
- UE Triggered Service Request (see 3GPP TS 23.502 [3], clause [Link]) 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 [Link].3).
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 37 ETSI TS 129 518 V15.6.0 (2020-01)
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 PDU Session(s) via 3GPP access
supporting EPS interworking with N26. 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.
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 [Link].4.3). See also Figure [Link].1-1.
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, ARP list and S-NSSAI as input for the service operation.
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 sevice consumer considers
that EBI(s) have been released and reassigned.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].4.3.2-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
[Link].4.3.2-2;
- a failureDetails which describes the detailed cause phrase why the request has failed.
Event: Location-Report
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 38 ETSI TS 129 518 V15.6.0 (2020-01)
A NF subscribes to this event to receive the Last Known 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 with
the granularity as requested.
This event implements the "Location Reporting" event in table [Link]-1 of 3GPP TS 23.502 [3].
Report Type: One-Time Report (See NOTE 1), Continuous Report (See NOTE 2)
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).
Event: Presence-In-AOI-Report
A NF subscribe 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 interested area name like "LADN".
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.
Input: UE ID(s)
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, 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.
Input: UE ID(s)
Event: 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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 39 ETSI TS 129 518 V15.6.0 (2020-01)
Input: UE ID(s)
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 connectivity state of a UE or a group of UEs, and report
for updated connectivity state of a UE or any UE in the group when AMF becomes aware of a connectivity
state change of the UE.
Input: UE ID(s)
Notification; UE ID, most recent connectivity state (IDLE/CONNECTED) with access type
Event: 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.
Input: UE ID(s)
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 [Link]-1 of 3GPP TS 23.502 [3].
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 [Link]-1 of
3GPP TS 23.502 [3].
UE Type: any UE
Report Type: One-Time Report (See NOTE 3), Continuous Report (See NOTE 4)
NOTE 2: For an Immediate Report, UE Last Known Location is used to count the UEs within the area.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 40 ETSI TS 129 518 V15.6.0 (2020-01)
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 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.
This event implements the "Loss of Connectivity" event in table [Link]-1 of 3GPP TS 23.502 [3].
Input: UE ID(s)
Notification; UE ID.
[Link] Introduction
For the Namf_EventExposure service the following service operations are defined:
- Subscribe;
- Unsubscribe;
- Notify.
[Link] Subscribe
[Link].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.
The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the
subscriptions collection, see clause [Link].
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:
- 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;
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 41 ETSI TS 129 518 V15.6.0 (2020-01)
- 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.
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;
- Event Filter per applicable event, defines further options on how the event shall be reported.
NF Service
AMF
Consumer
1. POST .../subscriptions (AmfCreateEventSubscription)
1. The NF Service Consumer shall send a POST request to create a subscription resource in the AMF. The payload
body 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.
2a. 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 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 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.
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.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].3.1-3.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 42 ETSI TS 129 518 V15.6.0 (2020-01)
The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual
subscription resource (see clause [Link]) to be modified.
NF Service
AMF
Consumer
1. PATCH …/subscriptions/{subscriptionId} (AmfUpdateEventSubscriptionItem) or
PATCH …/subscriptions/{subscriptionId} (AmfUpdateEventOptionItem)
2a. 200 OK (AmfUpdatedSubscriptionData)
1. 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.
2a. 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 [Link].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.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].3.1-3.
[Link] Unsubscribe
[Link].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 [Link]) to be deleted.
NF Service
AMF
Consumer
1. DELETE …/subscriptions/{subscriptionId}
2a. 204 No Content
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 43 ETSI TS 129 518 V15.6.0 (2020-01)
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].3.2-3.
[Link] Notify
[Link].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 [Link].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
[Link].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 and if the subscription Id changes (i.e. Registration procedures and Handover procedures).
NF Service
AMF
Consumer
1. POST {eventNotificationUrl}(AmfEventNotification)
2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and
appropriate additional error information should be returned.
- paging UE if UE is in IDLE state and respond other NF after the UE enters CM-CONNECTED state.
- providing the terminating domain selection information for IMS voice to the consumer NF.
[Link] Introduction
For the Namf_MT Service the following service operations are defined:
- EnableUEReachability
- ProvideDomainSelectionInfo
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 44 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] EnableUEReachability
[Link].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 [Link]), or in CM-CONNECTED state
(see 3GPP TS 23.502 [3], clause [Link]).
The EnableUEReachability service operation shall be invoked by the NF Service Consumer (e.g. SMSF) 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 [Link]. See also figure [Link].1-1.
NF Service
AMF
Consumer
1. PUT …/{ueContextId}/ue-reachind(EnableUeReachabilityReqData)
1. The NF Service Consumer sends a PUT request to the resource representing the ueReachInd resource of the
AMF. The payload body of the PUT request shall contain an "EnableUeReachabilityReqData" object.
2a. On success:
- if the UE is in CM-CONNECTED state, the AMF shall immediately respond using "200 OK" status code,
with payload containing an "EnableUeReachabilityRspData" object.
- if the UE is in CM-IDLE state and the NAS message is to be sent over via 3GPP access, the AMF shall page
the UE. When UE becomes CM-CONNECTED, "200 OK" shall be returned with payload containing an
"EnableUeReachabilityRspData" object.
2b. On failure or redirection, one of the HTTP status code listed in Table [Link].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 [Link].3.1-3.
[Link] ProvideDomainSelectionInfo
[Link].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:
The NF Service Consumer shall invoke the service by using the HTTP GET towards the URI of the "UeContext"
resource (See clause [Link].3.1). See also figure [Link].1-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 45 ETSI TS 129 518 V15.6.0 (2020-01)
NF Service
AMF
Consumer
1. GET …/{ueContextId}?Info-class=TADS
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 payload containing an "UeContextInfo" data
structure including UE information for terminating domain selection for IMS voice.
2b. On failure, one of the HTTP status code listed in Table [Link].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
[Link].3.1-3.
- Allow NFs to request the current geodetic and optionally civic location of a target UE.
- Allow NFs to request Network Provided Location Information (NPLI) and/or local time zone corresponding to
the location of a target UE.
[Link] Introduction
For the Namf_Location Service the following service operations are defined:
- ProvidePositioningInfo;
- EventNotify; and
- ProvideLocationInfo.
[Link] ProvidePositioningInfo
[Link].1 General
The ProvidePositioningInfo service operation is used in the following procedure:
- 5GC-MT-LR Procedure without UDM Query (see 3GPP TS 23.502 [3], clause [Link])
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 46 ETSI TS 129 518 V15.6.0 (2020-01)
- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.502 [3], clause
[Link])
The ProvidePositioningInfo service operation shall be invoked by the NF Service Consumer (e.g. GMLC) to request the
current geodetic and optionally 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 [Link].4.2). See also figure [Link].1-1.
NF Service
AMF
Consumer
1. POST …/{ueContextId}/provide-pos-info(RequestPosInfo)
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 payload body of the POST request may
contain an indication of a positioning request from an emergency services client, the required QoS and
Supported GAD shapes. If the NF service consumer wants the location change information to be notified (e.g.
during a handover procedure), it also provides a callback URI on which the EventNotify service operation is
executed (see clause [Link]).
2a. On success, "200 OK" shall be returned, the payload body containing the LCS correlation identifier, the location
estimate, its age and accuracy and 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 [Link] of
3GPP TS 23.502 [3].
2b. On failure, one of the HTTP status code listed in Table [Link].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 [Link].4.2.2-2.
[Link] EventNotify
[Link].1 General
The EventNotify service operation is used in the following procedure:
- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.502 [3], clause
[Link])
The EventNotify service operation notifies the NF Service Consumer (i.e. GMLC) about a UE location related event
information related to emergency sessions, i.e. the initiation, handover or termination of an emergency session. The
notification is delivered to:
- the callback URI received from the GMLC during an earlier ProvidePositioningInfo service operation, if any;
- the callback URI registered in the NRF, if the GMLC registered to the NRF with notification endpoints for
location notifications (see clauses [Link].4 and [Link].4 of 3GPP TS 29.510 [29]);
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 47 ETSI TS 129 518 V15.6.0 (2020-01)
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
[Link].2). See also figure [Link].1-1.
NF Service
AMF
Consumer
1. POST {locationNotificationUri}(NotifiedPosInfo)
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, Civic Location and the Position methods used.
2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and
appropriate additional error information should be returned.
[Link] ProvideLocationInfo
[Link].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 [Link].4.3), as shown in figure [Link].1-1.
NF Service
AMF
Consumer
1. POST …/{ueContextId}/provide-loc-info(RequestLocInfo)
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 payload body 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 payload body of the response shall contain a
"ProvideLocInfo" data structure including the Network Provide Location Information (NPLI) of the target UE.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 48 ETSI TS 129 518 V15.6.0 (2020-01)
If "reqCurrentLoc" attribute is set to "true" and the UE is in CM-IDLE state, 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 CM-CONNECTED state, 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.
2b. On failure, one of the HTTP status code listed in table [Link].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 [Link].4.3.2-2.
6 API Definitions
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}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
[Link] General
HTTP/2, as defined in IETF RFC 7540 [19], shall be used as specified in clause 5 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.
[Link].1 General
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 49 ETSI TS 129 518 V15.6.0 (2020-01)
- 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 7807 [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 [Link]) 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 [Link].2-1 shall be supported.
See clause [Link] for the binary payloads supported in the binary body part of multipart messages.
[Link].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].
- 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:
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 50 ETSI TS 129 518 V15.6.0 (2020-01)
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
[Link] Overview
//{apiRoot}/namf-comm/<apiVersion>
/ue-contexts
/{ueContextId}
/assign-ebi
/subscriptions
/transfer
/release
/{subscriptionsId} /transfer-update
/n1-n2-messages
/non-ue-n2-messages
/transfer /{n1N2MessageId}
/subscriptions /subscriptions
/{n2NotifySubscriptionId}
/{subscriptionsId}
Table [Link]-1 provides an overview of the resources and applicable HTTP methods.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 51 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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]).
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 52 ETSI TS 129 518 V15.6.0 (2020-01)
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
ueContextId 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: "(imsi-[0-9]{5,15}|nai-.+|.+)"
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:
[Link].3.1 PUT
This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table [Link].2-1.
This method shall support the URI query parameters specified in table [Link].3.1-1.
Table [Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the PUT Request Body on this resource
Table [Link].3.1-3: Data structures supported by the PUT Response Body on this resource
Data type P
Cardinality Response Description
codes
UeContextCreatedData M 1 201 This case represents the successful creation of a new UE
Created Context.
Upon success, a response body is returned containing the
newly created UE Context.
UeContextCreateError M 1 403 This case represents the creation of a new UE Context is not
Forbidden successful.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 53 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].4.1 Overview
Mapped HTTP
Custom operation URI Description
method
{apiRoot}/namf- POST Release an existing individual ueContext
comm/<apiVersion>/ue- resource.
contexts/{ueContextId}/release It is used for the Release UE Context service
operation.
{apiRoot}/namf- POST Assign EPS bearer ID(s) towards EPS
comm/<apiVersion>/ue- bearer(s) mapped from QoS Flow(s), for a
contexts/{ueContextId}/assign-ebi PDU session for the UE.
It is used for EBIAssignment service operation.
{apiRoot}/namf- POST Transfer an existing individual ueContext
comm/<apiVersion>/ue- resource from old AMF to new AMF.
contexts/{ueContextId}/transfer It is used for the UEContextTransfer service
operation.
[Link].4.2.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table [Link].2-1.
This operation shall support the request data structures specified in table [Link].4.2.2-1 and the response data structure
and response codes specified in table [Link].4.2.2-2.
Table [Link].4.2.2-1: Data structures supported by the (POST) release Request Body on this resource
Data type P Cardinality Description
UEContextReleas M 1 The information used for releasing of the UE Context
e
Table [Link].4.2.2-2: Data structures supported by the (POST) release Response Body on this
resource
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 54 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].4.3.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, see Table [Link].2-1.
This operation shall support the request data structures specified in table [Link].4.3.2-1 and the response data structure
and response codes specified in table [Link].4.3.2-2.
Table [Link].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).
Table [Link].4.3.2-2: Data structures supported by the (POST) assign-ebi Response Body on this
resource
Data type P Cardinality Response Description
codes
AssignedEbiData M 1 200 OK Represent successful assignment of EPS bearer ID service
operation, with the assigned EBIs included.
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.
AssignEbiError M 1 403 This represents the case when none of the requested EBI(s)
Forbidden 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.
[Link].4.4.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI or SUPI, see
Table [Link].2-1.
This operation shall support the request data structures specified in table [Link].4.4.2-1 and the response data structure
and response codes specified in table [Link].4.4.2-2.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 55 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].4.4.2-1: Data structures supported by the (POST) transfer Request Body on this
resource
Data type P Cardinalit
Description
y
UeContextTransferReqData M 1 Represents to start transferring of an individual ueContext
resource from old AMF to new AMF.
Table [Link].4.4.2-2: Data structures supported by the (POST) transfer Response Body on this
resource
Data type P Cardinalit Response Description
y codes
UeContextTransferRspData M 1 200 OK Indicates the transferring of the individual
ueContext resource is started successfully.
ProblemDetails M 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.
[Link].4.5.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI, see Table [Link].2-1.
This operation shall support the request data structures specified in table [Link].4.5.2-1 and the response data structure
and response codes specified in table [Link].4.5.2-2.
Table [Link].4.5.2-1: Data structures supported by the (POST) transfer-update Request Body on this
resource
Data type P Cardinalit
Description
y
UeRegStatusUpdateReqData M 1 Represents to the update of status on the transferring of an
individual ueContext resource from old AMF to new AMF.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 56 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].4.5.2-2: Data structures supported by the (POST) transfer-update Response Body on
this resource
Data type P
Cardinalit Response Description
y codes
UeRegStatusUpdateRspDat M 1 200 OK Indicates the update of UE context transfer status
a is successful at the source AMF.
ProblemDetails M 1 403 Forbidden Indicates that AMF can understand the request
but cannot fulfil the request due to errors.
ProblemDetails M 1 404 Not Found If the AMF does not have the requested UE
context, the AMF shall return this status code. The
"cause" attribute is set to:
- CONTEXT_NOT_FOUND
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+)"
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15})"
[Link].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. LMF) to subscribe for notifications about UE related N1/N2
Information.
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the POST Request Body on this resource
Data type P Cardinality Description
UeN1N2InfoSubs C 0..1 Representation of the subscription for N1 and/or N2 information notification. It
criptionCreateDat shall contain the information regarding N1 and/or N2 information to be notified
a and the callback URI for the respective notifications.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 57 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
UeN1N2InfoSubs C 0..1 201 This case represents the successful creation of the subscription
criptionCreatedDa Created for N1 and/or N2 information notification.
ta
Upon success, a response body is returned containing the
representation describing the status of the request.
[Link].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.2 of 3GPP TS 29.501 [5]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+)"
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15})"
subscriptionId Represents the individual subscription to the UE specific N1/N2 message notification.
[Link].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. LMF) to unsubscribe for notifications about UE related N1/N2 information.
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the DELETE Request Body on this resource
Data type P Cardinality Description
n/a
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 58 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the DELETE Response Body on this resource
Data type P Cardinality Response Description
codes
n/a 204 No
Content
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+)"
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 [Link].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.
[Link].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
message if the UE is not reachable or if the UE is paged.
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-1: Data structures supported by the POST Request Body on this resource
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 59 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the POST Response Body on this resource
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 60 ETSI TS 129 518 V15.6.0 (2020-01)
ProblemDetails M 1 307 This represents the case when the related UE context is not
Temporary fully available at the target NF Service Consumer (e.g. AMF)
Redirect during a planned maintenance case (e.g. AMF planned
maintenance without UDSF case). The "cause" attribute shall
be set to one of the following application error:
- NF_CONSUMER_REDIRECT_ONE_TXN
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 61 ETSI TS 129 518 V15.6.0 (2020-01)
N1N2MessageTransferError M 1 504 This represents the case where the UE is not reachable at the
Gateway AMF and the AMF is unable to page the UE. The cause
Timeout attribute of the ProblemDetails structure shall be set to:
- UE_NOT_REACHABLE, if the UE is not reachable for
paging;
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
[Link].3.1 POST
This method creates a new subscription. This method shall support the URI query parameters specified in table
[Link].3.1-1.
Table [Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].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
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 62 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
SubscriptionData M 1 201 This case represents the successful creation of a
Created subscription.
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
subscriptionId Represents a specific subscription
[Link].3.1 DELETE
This method terminates an existing subscription. This method shall support the URI query parameters specified in table
[Link].3.1-1.
Table [Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the DELETE Request Body on this resource
Data type P Cardinality Description
n/a
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 63 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the DELETE Response Body on this resource
Data type P Cardinality Response Description
codes
204 No This case represents a successful deletion of the subscription.
Content
ProblemDetails M 1 404 Not If the AMF does not have the requested subscription, the AMF
Found shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND
[Link].3.2 PUT
This method replaces an existing subscription completely. This method shall support the URI query parameters
specified in table [Link].3.2-1.
Table [Link].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 [Link].3.2-2 and the response data structures and
response codes specified in table [Link].3.2-3.
Table [Link].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 [Link].3.2-3: Data structures supported by the PUT Response Body on this resource
Data type P Cardinality Response Description
codes
SubscriptionData M 1 200 OK This case represents a successful replacement of the
subscription.
ProblemDetails M 1 403 This case represents the failure update of an existing
Forbidden subscription.
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 64 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].4.1 Overview
Mapped HTTP
Custom operaration URI Description
method
{resourceUri}/transfer POST Transfer the N2 message to 5G-AN.
[Link].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.
This operation shall support the request data structures specified in table [Link].4.2.2-1 and the response data structure
and response codes specified in table [Link].4.2.2-2.
Table [Link].4.2.2-1: Data structures supported by the POST Request Body on this resource
Data type P Cardinality Description
N2InformationTra M 1 Representation of the data to be sent to the 5G-AN node(s) by the AMF.
nsferReqData
Table [Link].4.2.2-2: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
N2InformationTra M 1 200 OK Indicates AMF has successfully initiated the transferring of N2
nsferRspData Information to the AN..
N2InformationTra M 1 400 Bad The "cause" attribute shall be set to one of the errors defined in
nsferError Request Table [Link]-1 of 3GPP TS 29.500 [4].
N2InformationTra M 1 403 The "cause" attribute shall be set to one of the following
nsferError Forbidden application errors:
- UNSPECIFIED
See table [Link]-1 for the description of these errors.
N2InformationTra M 1 404 Not The "cause" attribute shall be set to one of the following
nsferError Found application errors:
- CONTEXT_NOT_FOUND
See table [Link]-1 for the description of these errors.
N2InformationTra M 1 500 Internal The "cause" attribute shall be set to one of the errors defined in
nsferError Server Error Table [Link]-1 of 3GPP TS 29.500 [4].
N2InformationTra M 1 503 Service The "cause" attribute shall be set to one of the errors defined in
nsferError Unavailable Table [Link]-1 of 3GPP TS 29.500 [4].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 65 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
[Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the POST Request Body on this resource
Data type P Cardinality Description
NonUeN2InfoSub M 1 Representation of the subscription for N2 information notification.
scriptionCreateDa
ta
Table [Link].3.1-3: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
NonUeN2InfoSub M 1 201 This case represents the successful creation of the subscription
scriptionCreatedD Created for N2 information notification.
ata
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.
ProblemDetails M 1 403 If the NF Service Consumer is not authorized to subscribe for
Forbidden non UE N2 message notifications, the AMF shall return this
status code with the ProblemDetails
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 66 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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 Store resource archetype (see clause C.3 of
3GPP TS 29.501 [5]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.1.1
apiVersion See clause 6.1.1.
n2NotifySubscriptionId Represents the individual subscription to the non UE specific N2 message notification.
[Link].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 [Link].3.1-2 and the response data structures
and response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the DELETE Request Body on this resource
Data type P Cardinality Description
n/a
Table [Link].3.1-3: Data structures supported by the DELETE Response Body on this resource
Data type P Cardinality Response Description
codes
n/a 204 No
Content
6.1.5 Notifications
[Link] General
The notifications provided by the Namf_Communication service are specified in this clause.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 67 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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].
[Link].3.1 POST
This method shall support the request data structures specified in table [Link].3.1-1 and the response data structures and
response codes specified in table [Link].3.1-2.
[Link].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.
This notification shall support the resource URI variables defined in table [Link].2-1.
Name Definition
n2NotifyCallbackUri Callback reference provided by the NF Service Consumer during the subscription to this
notification.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 68 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
[Link].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).
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.
[Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 69 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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.
Callback URI is provided by the NF Service Consumer during the subscription to this notification.
[Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
[Link].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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 70 ETSI TS 129 518 V15.6.0 (2020-01)
Callback URI is provided by the NF Service Consumer during the UE specific N1N2MessageTransfer operation (see
clause [Link].3.1.
[Link].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 [Link].3.1-1 and the response data structures and
response codes specified in table [Link].3.1-3.
[Link] Void
[Link] General
This clause specifies the application data model supported by the API.
Table [Link]-1 specifies the data types defined for the Namf_Communication service based interface protocol.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 71 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 72 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 73 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link]-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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 74 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
Structured data types used in Namf_Communication service are specified in this clause.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 75 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 76 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 77 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 78 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 79 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 80 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 81 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 82 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 83 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 84 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].22 Void
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 85 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 86 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 87 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 88 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 89 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 90 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 91 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 92 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 93 ETSI TS 129 518 V15.6.0 (2020-01)
keyAmfHDerivationInd boolean C 0..1 This IE shall be included, with a value "true", if the
source AMF has performed horizontal KAMF
derivation, which means a new KAMF has been
calculated.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 94 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 95 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 96 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 97 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].48 Void
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 98 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 99 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the
previous clauses.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 100 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 101 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 102 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].12 ScType
[Link].13 KeyAmfType
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 103 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see
clauses [Link].2 and [Link]).
- PDU Session Modification Command (see clause 8.3.8 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.13 of 3GPP TS 24.501 [11]) during network initiated PDU
session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]).
- UE Positioning Request messages as specified in 3GPP TS 36.355 [13] during UE assisted and UE based
positioning procedure (see clause [Link] of 3GPP TS 23.502 [3]).
- REGISTRATION REQUEST message as specified in see clause 8.2.5 of 3GPP TS 24.501 [11], during
registration procedures (see clause [Link] of 3GPP TS 23.502 [3]).
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 104 ETSI TS 129 518 V15.6.0 (2020-01)
- 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]).
[Link].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 [Link] content-type.
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 [Link].3-1.
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 [Link].3-2.
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 [Link].3-3
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 105 ETSI TS 129 518 V15.6.0 (2020-01)
For N2 information class PWS, N2 Information shall encode NGAP Messages specified in 3GPP TS 38.413 [12].
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 [Link].3-1).
- 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 it has received from
the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table [Link].3-1).
If an NG-RAN node has responded without a Broadcast Cancelled Area List, then the AMF shall populate the
Broadcast Empty Area List with the ngRanId of that NG-RAN node.
If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a WRITE-
REPLACE-WARNING-RESPONSE, then the AMF may transfer the ASN.1 (re-)encoded Message Type, Message
Identifier, Serial Number and the (aggregated) Broadcast Completed Area List in the N2 Info Container in the
N2InfoNotify.
If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a PWS-CANCEL-
RESPONSE, then the AMF may transfer the ASN.1 (re-)encoded the Message Type, Message Identifier, Serial
Number, the (aggregated) Broadcast Cancelled Area List and Broadcast Empty Area List in the N2 Info Container in
the N2InfoNotify.
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 [Link].3-2) 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 [Link].3-2), then the AMF may transfer the ASN1 encoded string from the PWS-FAILURE-
INDICATION in the N2 Info Container in the N2InfoNotify.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 106 ETSI TS 129 518 V15.6.0 (2020-01)
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
[Link] General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 107 ETSI TS 129 518 V15.6.0 (2020-01)
The NF Service Consumer shall indicate the optional features it supports for the Namf_Communication service, if any,
by including the supportedFeatures attribute in payload of the HTTP Request Message for following service operations:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 108 ETSI TS 129 518 V15.6.0 (2020-01)
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 payload 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].
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 [Link].
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 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-comm"), and it does not define any additional
scopes at resource or operation level.
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}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 109 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] General
HTTP/2, as defined in IETF RFC 7540 [19], shall be used as specified in clause 5 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.
[Link].1 General
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
- 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 7807 [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".
[Link].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
[Link] Overview
{apiRoot}/namf-evts/<apiVersion>
/subscriptions
/{subscriptionId}
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 110 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link]-1 provides an overview of the resources and applicable HTTP methods.
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.2.1
apiVersion See clause 6.2.1.
[Link].3.1 POST
This method shall support the URI query parameters specified in table [Link].3.1-1.
Table [Link].3.1-1: URI query parameters supported by the POST method on this resource
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the POST Request Body on this resource
Data type P Cardinality Description
AmfCreateEventS M 1 Describes of an AMF Event Subscription to be created
ubscription
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 111 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
AmfCreatedEventSubscription M 1 201 Represents successful creation of an AMF Event
Created Subscription
ProblemDetails M 1 403 Indicates the creation of subscription has failed due to
Forbidden application error.
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.2.1
apiVersion See clause 6.2.1.
subscriptionId String identifies an individual subscription to the AMF event exposure service
[Link].3.1 PATCH
This method shall support the URI query parameters specified in table [Link].3.1-1.
Table [Link].3.1-1: URI query parameters supported by the PATCH method on this resource
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the PATCH Request Body on this resource
Data type P Cardinality Description
AmfUpdateEventSubscriptionIte M 1..N Document describes the modification(s) to a AMF Event
m Subscription
AmfUpdateEventOptionItem M 1 Document describing the modification to the event subscription
options (e.g subscription expiry time).
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 112 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the PATCH Response Body on this resource
Data type P Cardinality Response Description
codes
AmfUpdatedEventSubsc M 1 200 OK Represents a successful update on AMF Event
ription Subscription
ProblemDetails M 1 403 Indicates the modification of subscription has failed due to
Forbidden application error.
[Link].3.2 DELETE
This method shall support the URI query parameters specified in table [Link].3.2-1.
Table [Link].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 [Link].3.2-2 and the response data structures and
response codes specified in table [Link].3.2-3.
Table [Link].3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type P Cardinality Description
n/a
Table [Link].3.2-3: Data structures supported by the DELETE Response Body on this resource
Data type P Cardinality Response Description
codes
n/a 204 No
Content
ProblemDetails M 1 404 Not Indicates the modification of subscription has failed due to
Found application error.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 113 ETSI TS 129 518 V15.6.0 (2020-01)
6.2.5 Notifications
[Link] General
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.
[Link].3.1 POST
This method shall support the request data structures specified in table [Link].3.1-1 and the response data structures and
response codes specified in table [Link].3.1-2.
[Link] General
This clause specifies the application data model supported by the API.
Table [Link]-1 specifies the data types defined for the Namf_EventExposure service based interface protocol.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 114 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link]-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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 115 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
Structured data types used in Namf_EventExposure service are specified in this clause.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 116 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 117 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 118 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 119 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 120 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 121 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].10 Void
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].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 122 ETSI TS 129 518 V15.6.0 (2020-01)
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.
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"
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 123 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the
previous clauses.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 124 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 125 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 126 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].6 Void
[Link].8 Void
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 127 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4].
The NF Service Consumer shall indicate the optional features it supports for the Namf_EventExposure service, if any,
by including the supportedFeatures attribute in payload 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 payload 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].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 128 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].
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.
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}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
[Link] General
HTTP/2, as defined in IETF RFC 7540 [19], shall be used as specified in clause 5 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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 129 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 General
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
- 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 7807 [36]). The use of the Problem Details JSON object in a
HTTP response body shall be signalled by the content type "application/problem+json".
[Link].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
[Link] Overview
//{apiRoot}/namf-mt/<apiVersion>
/ue-contexts
/{ueContextId}
/ue-reachind
Table [Link]-1 provides an overview of the resources and applicable HTTP methods.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 130 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.3.1
apiVersion See clause 6.3.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+|.+)"
[Link].3.1 PUT
This method shall support the URI query parameters specified in table [Link].3.1-1.
Table [Link].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 [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the PUT Request Body on this resource
Data type P Cardinality Description
EnableUeReacha M 1 Contain the State of the UE, the value shall be set to UE Reachable.
bilityReqData
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 131 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the PUT Response Body on this resource
Data type P Cardinality Response Description
codes
EnableUeReachabilityRspData M 1 200 OK Indicate the ueReachInd is updated to UE Reachable.
ProblemDetails M 1 307 This represents the case when the related UE context
Temporary is not fully available at the target NF Service
Redirect Consumer (e.g. AMF) during a planned maintenance
case (e.g. AMF planned maintenance without UDSF
case). The "cause" attribute shall be set to the
following application error:
- NF_CONSUMER_REDIRECT_ONE_TXN
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 132 ETSI TS 129 518 V15.6.0 (2020-01)
Name Definition
apiRoot See clause 6.3.1
apiVersion See clause 6.3.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+)"
[Link].3.1 GET
This method shall support the URI query parameters specified in table [Link].3.1-1.
Table [Link].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- SupportedFeatures C 0..1 This IE shall be present if at least one optional feature
features 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 [Link] of
3GPP TS 29.502 [16]).
This method shall support the request data structures specified in table [Link].3.1-2 and the response data structures and
response codes specified in table [Link].3.1-3.
Table [Link].3.1-2: Data structures supported by the GET Request Body on this resource
Data type P Cardinality Description
n/a
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 133 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].3.1-3: Data structures supported by the GET Response Body on this resource
Data type P Cardinality Response Description
codes
UeContextInfo M 1 200 OK This represents the operation is successful and request
UE Context information is returned.
ProblemDetails M 1 307 This represents the case when the related UE context
Temporary is not fully available at the target NF Service Consumer
Redirect (e.g. AMF) during a planned maintenance case (e.g.
AMF planned maintenance without UDSF case). The
"cause" attribute shall be set to one of the following
application error:
- NF_CONSUMER_REDIRECT_ONE_TXN
See table [Link]-1 for the description of these errors
6.3.5 Notifications
There are no notifications supported on Namf_MT service.
[Link] General
This clause specifies the application data model supported by the API.
Table [Link]-1 specifies the data types defined for the Namf_MT service based interface protocol.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 134 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link]-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.
[Link].1 Introduction
Structured data types used in Namf_MT service are specified in this clause.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 135 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the
previous clauses.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 136 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4].
The NF Service Consumer shall indicate the optional features it supports for the Namf_MT service, if any, by including
the supportedFeatures attribute in payload of the HTTP Request Message for following service operations:
- ProvideDomainSelectionInfo, as specified in clause [Link];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 payload 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].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 137 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].
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 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-mt"), and it does not define any additional scopes at resource or
operation level.
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}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
[Link] General
HTTP/2, as defined in IETF RFC 7540 [19], shall be used as specified in clause 5 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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 138 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 General
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
- 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 7807 [36]). The use of the Problem Details JSON object in a
HTTP response body shall be signalled by the content type "application/problem+json".
[Link].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
[Link] Overview
//{apiRoot}/namf-loc/<apiVersion>
/{ueContextId}
/provide-pos-info
/provide-loc-info
Table [Link]-1 provides an overview of the resources and applicable HTTP methods.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 139 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].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]).
This resource shall support the resource URI variables defined in table [Link].2-1.
Name Definition
apiRoot See clause 6.4.1
apiVersion See clause 6.4.1.
ueContextId Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15}|nai-.+|.+)"
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}|.+)"
[Link].4.1 Overview
Mapped HTTP
Custom operaration URI Description
method
{apiRoot}/namf- POST Request the positioning information of the UE.
loc/<apiVersion>/{ueContextId}/provide- It is used for the ProvidePositioningInfo
pos-info service operation.
{apiRoot}/namf- POST Request the Network Provided Location
loc/<apiVersion>/{ueContextId}/provide- Information of the UE.
loc-info
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 140 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].4.2.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI.
This operation shall support the request data structures specified in table [Link].4.2.2-1 and the response data structure
and response codes specified in table [Link].4.2.2-2.
Table [Link].4.2.2-1: Data structures supported by 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 [Link].4.2.2-2: Data structures supported by the provide-pos-info operation Response Body
Data type P Cardinality Response Description
codes
ProvidePosInfo M 1 200 OK This case represents a successful query of the UE positioning
information, the AMF returns the related information in the
response.
ProblemDetails M 1 403 The "cause" attribute shall be set to one of the following
Forbidden application errors:
- UNAUTHORIZED_REQUESTING_NETWORK
- USER_UNKNOWN
- DETACHED_USER
- POSITIONING_DENIED
- UNSPECIFIED
[Link].4.3.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE's SUPI.
This operation shall support the request data structures specified in table [Link].4.3.2-1 and the response data structure
and response codes specified in table [Link].4.3.2-2.
Table [Link].4.3.2-1: Data structures supported by the povideLocInfo operation Request Body
Data type P Cardinality Description
RequestLocInfo M 1 The information to request the NPLI of the UE.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 141 ETSI TS 129 518 V15.6.0 (2020-01)
Table [Link].4.3.2-2: Data structures supported by the provide-loc-info operation Response Body
Data type P Cardinality Response Description
codes
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.
ProblemDetails M 1 403 The "cause" attribute shall be set to one of the following
Forbidden application errors:
- UNSPECIFIED
6.4.5 Notifications
[Link] General
This clause provides the definition of the EventNotify notification of the Namf_Location service.
[Link].1 Description
This resource represents the callback reference of the NF Service Consumer (e.g. GMLC) to receive LCS event notify.
See clause [Link].1 for the description of how the AMF obtains the Callback URI of the NF Service Consumer (e.g.
GMLC).
[Link].3.1 POST
This method shall support the request data structures specified in table [Link].3.1-1 and the response data structures and
response codes specified in table [Link].3.1-2.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 142 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] General
This clause specifies the application data model supported by the API.
Table [Link]-1 specifies the data types defined for the Namf_Location service based interface protocol.
Table [Link]-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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 143 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
Structured data types used in Namf_Location service are specified in this clause.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 144 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 145 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 146 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 147 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 148 ETSI TS 129 518 V15.6.0 (2020-01)
[Link].1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the
previous clauses.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 149 ETSI TS 129 518 V15.6.0 (2020-01)
[Link] General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4].
The NF Service Consumer shall indicate the optional features it supports for the Namf_Location service, if any, by
including the supportedFeatures attribute in payload of the HTTP Request Message for following service operations:
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 payload 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].
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 150 ETSI TS 129 518 V15.6.0 (2020-01)
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 [Link].
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.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 151 ETSI TS 129 518 V15.6.0 (2020-01)
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].
- 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 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
the public 3GPP file server in the following locations (see clause 5B of the 3GPP TR 21.900 [37] for further
information):
- [Link] and
- [Link]
NOTE 2: To fetch the OpenAPI specification file after CT#83 plenary meeting for Release 15 in the above links
<Plenary> must be replaced with the date the CT Plenary occurs, in the form of year-month (yyyy-mm),
e.g. for CT#83 meeting <Plenary> must be replaced with value "2019-03" and <Release> must be
replaced with value "Rel-15".
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 152 ETSI TS 129 518 V15.6.0 (2020-01)
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-.+|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
encoding:
jsonData:
contentType: application/json
binaryDataN2Information:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt1:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 153 ETSI TS 129 518 V15.6.0 (2020-01)
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt2:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt3:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt4:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt5:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt6:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt7:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt8:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt9:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt10:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt11:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt12:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt13:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt14:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 154 ETSI TS 129 518 V15.6.0 (2020-01)
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt15:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt16:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
required: true
callbacks:
onN2MessageNotify:
'{$[Link]#/n2NotifyUri}':
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:
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: # Request parts
jsonData:
$ref: '#/components/schemas/N2InfoNotificationRspData'
binaryDataN2Information:
type: string
format: binary
encoding:
jsonData:
contentType: application/json
binaryDataN2Information:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
'204':
description: Expected response to a successful callback processing
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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'
responses:
'201':
description: UE context successfully created.
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 155 ETSI TS 129 518 V15.6.0 (2020-01)
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the
structure: {apiRoot}/namf-comm/<apiVersion>/ue-contexts/{ueContextId}'
required: true
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/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt1:
contentType: application/[Link]
headers:
Content-Id:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 156 ETSI TS 129 518 V15.6.0 (2020-01)
schema:
type: string
binaryDataN2InformationExt2:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt3:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt4:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt5:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt6:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt7:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt8:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt9:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt10:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt11:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt12:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt13:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
binaryDataN2InformationExt14:
contentType: application/[Link]
headers:
Content-Id:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 157 ETSI TS 129 518 V15.6.0 (2020-01)
schema:
type: string
binaryDataN2InformationExt15:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/UeContextCreateError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/UeContextCreateError'
'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'
'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
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-.+|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
'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'
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 158 ETSI TS 129 518 V15.6.0 (2020-01)
'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
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-.+|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'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AssignEbiError'
'403':
description: Forbidden
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'
'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
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-.+|imei-[0-
9]{15}|imeisv-[0-9]{16}|.+)$'
requestBody:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 159 ETSI TS 129 518 V15.6.0 (2020-01)
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
encoding:
jsonData:
contentType: application/json
binaryDataN2Information:
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
'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'
'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
parameters:
- name: ueContextId
in: path
description: UE Context Identifier
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 160 ETSI TS 129 518 V15.6.0 (2020-01)
required: true
schema:
type: string
pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|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'
'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'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/ue-contexts/{ueContextId}/n1-n2-messages:
post:
summary: Namf_Communication N1N2 Message Transfer (UE Specific) service Operation
tags:
- n1N2Message collection (Document)
operationId: N1N2MessageTransfer
parameters:
- name: ueContextId
in: path
description: UE Context Identifier
required: true
schema:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|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
encoding:
jsonData:
contentType: application/json
binaryDataN1Message:
contentType: application/vnd.3gpp.5gnas
headers:
Content-Id:
schema:
type: string
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 161 ETSI TS 129 518 V15.6.0 (2020-01)
binaryDataN2Information:
contentType: application/[Link]
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 to which the status of the
N1N2 message transfer is held'
required: true
schema:
type: string
'200':
description: N1N2 Message Transfer successfully initiated.
content:
application/json:
schema:
$ref: '#/components/schemas/N1N2MessageTransferRspData'
'307':
description: Temporary Redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'The URI of the resource located on the target NF Service Consumer (e.g.
AMF) to which the request is redirected'
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/N1N2MessageTransferError'
default:
description: Unexpected error
callbacks:
onN1N2TransferFailure:
'{$[Link]#/n1n2FailureTxfNotifURI}':
post:
summary: Namf_Communication N1N2Transfer Failure Notification service Operation
tags:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 162 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 163 ETSI TS 129 518 V15.6.0 (2020-01)
onN1N2MessageNotify:
'{$[Link]#/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
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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'
'{$[Link]#/n2NotifyCallbackUri}':
post:
summary: Namf_Communication N2 Info Notify (UE Specific) service Operation
tags:
- N2 Info Notify
operationId: N2InfoNotify
requestBody:
description: UE Specific N2 Informaiton 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:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 164 ETSI TS 129 518 V15.6.0 (2020-01)
contentType: application/[Link]
headers:
Content-Id:
schema:
type: string
responses:
'204':
description: Expected response to a successful callback processing
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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'
/ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId}:
delete:
summary: Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation
tags:
- N1N2 Individual Subscription (Document)
operationId: N1N2MessageUnSubscribe
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-.+|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.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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'
/non-ue-n2-messages/transfer:
post:
summary: Namf_Communication Non UE N2 Message Transfer service Operation
tags:
- Non UE N2Messages collection (Document)
operationId: NonUeN2MessageTransfer
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:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 165 ETSI TS 129 518 V15.6.0 (2020-01)
type: string
format: binary
encoding:
jsonData:
contentType: application/json
binaryDataN2Information:
contentType: application/[Link]
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'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/N2InformationTransferError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/N2InformationTransferError'
'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'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/N2InformationTransferError'
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 (Document)
operationId: NonUeN2InfoSubscribe
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NonUeN2InfoSubscriptionCreateData'
required: true
responses:
'201':
description: Non UE N2 Info Subscription successfully created.
headers:
Location:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 166 ETSI TS 129 518 V15.6.0 (2020-01)
description: 'Contains the URI of the newly created resource, according to the
structure: {apiRoot}/namf-comm/<apiVersion>/non-ue-n2-
messages/subscriptions/{n2NotifySubscriptionId}'
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NonUeN2InfoSubscriptionCreatedData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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:
description: Unexpected error
callbacks:
onN2InfoNotify:
'{$[Link]#/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 Informaiton 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/[Link]
headers:
Content-Id:
schema:
type: string
responses:
'204':
description: Expected response to a successful callback processing
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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'
/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 167 ETSI TS 129 518 V15.6.0 (2020-01)
delete:
summary: Namf_Communication Non UE N2 Info UnSubscribe service Operation
tags:
- Non UE N2 Message Notification Individual Subscription (Document)
operationId: NonUeN2InfoUnSubscribe
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.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
/subscriptions:
post:
summary: Namf_Communication AMF Status Change Subscribe service Operation
tags:
- subscriptions collection (Document)
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/<apiVersion>/subscriptions/{subscriptionId}'
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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:
description: Unexpected error
callbacks:
onAmfStatusChange:
'{$[Link]#/amfStatusUri}':
post:
summary: Amf Status Change Notify service Operation
tags:
- Amf Status Change Notify
operationId: AmfStatusChangeNotify
requestBody:
description: Amf Status Change Notification
content:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 168 ETSI TS 129 518 V15.6.0 (2020-01)
application/json:
schema:
$ref: '#/components/schemas/AmfStatusChangeNotification'
responses:
'204':
description: Expected response to a successful callback processing
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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'
/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.
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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:
description: Unexpected error
put:
summary: Namf_Communication AMF Status Change Subscribe Modify service Operation
tags:
- individual subscription (Document)
operationId: AMFStatusChangeSubscribeModfy
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:
'202':
description: N1N2 Message Subscription successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionData'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 169 ETSI TS 129 518 V15.6.0 (2020-01)
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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:
description: Unexpected error
callbacks:
OnAmfStatusChange:
'{$[Link]#/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
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
namf-comm: Access to the Namf_Communication API
schemas:
#
# STRUCTURED DATA TYPES
#
SubscriptionData:
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:
type: object
properties:
amfStatusInfoList:
type: array
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 170 ETSI TS 129 518 V15.6.0 (2020-01)
items:
$ref: '#/components/schemas/AmfStatusInfo'
minItems: 1
required:
- amfStatusInfoList
AmfStatusInfo:
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:
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'
required:
- pduSessionId
AssignedEbiData:
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
required:
- pduSessionId
- assignedEbiList
AssignEbiFailed:
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:
type: object
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 171 ETSI TS 129 518 V15.6.0 (2020-01)
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:
type: object
properties:
taiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems: 1
ratSelector:
$ref: '#/components/schemas/RatSelector'
ecgiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
minItems: 1
ncgiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
minItems: 1
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:
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'
required:
- n2InformationClass
- n2NotifyCallbackUri
NonUeN2InfoSubscriptionCreatedData:
type: object
properties:
n2NotifySubscriptionId:
type: string
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- n2NotifySubscriptionId
UeN1N2InfoSubscriptionCreateData:
type: object
properties:
n2InformationClass:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 172 ETSI TS 129 518 V15.6.0 (2020-01)
$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:
type: object
properties:
n1n2NotifySubscriptionId:
type: string
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- n1n2NotifySubscriptionId
N2InformationNotification:
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'
required:
- n2NotifySubscriptionId
N2InfoContainer:
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'
required:
- n2InformationClass
N1MessageNotification:
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'
required:
- n1MessageContainer
N1MessageContainer:
type: object
properties:
n1MessageClass:
$ref: '#/components/schemas/N1MessageClass'
n1MessageContent:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
nfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
serviceInstanceId:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 173 ETSI TS 129 518 V15.6.0 (2020-01)
type: string
required:
- n1MessageClass
- n1MessageContent
N1N2MessageTransferReqData:
type: object
properties:
n1MessageContainer:
$ref: '#/components/schemas/N1MessageContainer'
n2InfoContainer:
$ref: '#/components/schemas/N2InfoContainer'
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'
n1n2FailureTxfNotifURI:
$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'
N1N2MessageTransferRspData:
type: object
properties:
cause:
$ref: '#/components/schemas/N1N2MessageTransferCause'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- cause
RegistrationContextContainer:
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:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 174 ETSI TS 129 518 V15.6.0 (2020-01)
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
required:
- ueContext
- anType
- anN2ApId
- ranNodeId
- initialAmfName
- userLocation
AreaOfValidity:
type: object
properties:
taiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems: 0
required:
- taiList
UeContextTransferReqData:
type: object
properties:
reason:
$ref: '#/components/schemas/TransferReason'
accessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
plmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
regRequest:
$ref: '#/components/schemas/N1MessageContainer'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- reason
- accessType
UeContextTransferRspData:
type: object
properties:
ueContext:
$ref: '#/components/schemas/UeContext'
ueRadioCapability:
$ref: '#/components/schemas/N2InfoContent'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- ueContext
UeContext:
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'
routingIndicator:
type: string
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 175 ETSI TS 129 518 V15.6.0 (2020-01)
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'
usedRfsp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex'
subUeAmbr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr'
smsSupport:
$ref: '#/components/schemas/SmsSupport'
smsfId:
$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'
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'
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: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription'
minItems: 1
mmContextList:
type: array
items:
$ref: '#/components/schemas/MmContext'
minItems: 1
maxItems: 2
sessionContextList:
type: array
items:
$ref: '#/components/schemas/PduSessionContext'
minItems: 1
traceData:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData'
N2SmInformation:
type: object
properties:
pduSessionId:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 176 ETSI TS 129 518 V15.6.0 (2020-01)
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
n2InfoContent:
$ref: '#/components/schemas/N2InfoContent'
sNssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
subjectToHo:
type: boolean
required:
- pduSessionId
N2InfoContent:
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:
type: object
properties:
nfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nrppaPdu:
$ref: '#/components/schemas/N2InfoContent'
serviceInstanceId:
type: string
required:
- nfId
- nrppaPdu
PwsInformation:
type: object
properties:
messageIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
serialNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
pwsContainer:
$ref: '#/components/schemas/N2InfoContent'
sendRanResponse:
type: boolean
default: false
omcId:
$ref: '#/components/schemas/OmcIdentifier'
required:
- messageIdentifier
- serialNumber
- pwsContainer
N1N2MsgTxfrFailureNotification:
type: object
properties:
cause:
$ref: '#/components/schemas/N1N2MessageTransferCause'
n1n2MsgDataUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
required:
- cause
- n1n2MsgDataUri
N1N2MessageTransferError:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
errInfo:
$ref: '#/components/schemas/N1N2MsgTxfrErrDetail'
required:
- error
N1N2MsgTxfrErrDetail:
type: object
properties:
retryAfter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
highestPrioArp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Arp'
N2InformationTransferRspData:
type: object
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 177 ETSI TS 129 518 V15.6.0 (2020-01)
properties:
result:
$ref: '#/components/schemas/N2InformationTransferResult'
pwsRspData:
$ref: '#/components/schemas/PWSResponseData'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- result
MmContext:
type: object
properties:
accessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
nasSecurityMode:
$ref: '#/components/schemas/NasSecurityMode'
nasDownlinkCount:
$ref: '#/components/schemas/NasCount'
nasUplinkCount:
$ref: '#/components/schemas/NasCount'
ueSecurityCapability:
$ref: '#/components/schemas/UeSecurityCapability'
s1UeNetworkCapability:
$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
nsInstanceList:
type: array
items:
$ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId'
minItems: 1
expectedUEbehavior:
$ref: '#/components/schemas/ExpectedUeBehavior'
required:
- accessType
SeafData:
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:
type: object
properties:
integrityAlgorithm:
$ref: '#/components/schemas/IntegrityAlgorithm'
cipheringAlgorithm:
$ref: '#/components/schemas/CipheringAlgorithm'
required:
- integrityAlgorithm
- cipheringAlgorithm
PduSessionContext:
type: object
properties:
pduSessionId:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 178 ETSI TS 129 518 V15.6.0 (2020-01)
$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'
accessType:
$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'
vsmfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nsInstance:
$ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId'
smfServiceInstanceId:
type: string
required:
- pduSessionId
- smContextRef
- sNssai
- dnn
- accessType
NssaiMapping:
type: object
properties:
mappedSnssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
hSnssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- mappedSnssai
- hSnssai
UeRegStatusUpdateReqData:
type: object
properties:
transferStatus:
$ref: '#/components/schemas/UeContextTransferStatus'
toReleaseSessionList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
minItems: 1
pcfReselectedInd:
type: boolean
required:
- transferStatus
UeRegStatusUpdateRspData:
type: object
properties:
regStatusTransferComplete:
type: boolean
required:
- regStatusTransferComplete
AssignEbiError:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
failureDetails:
$ref: '#/components/schemas/AssignEbiFailed'
required:
- error
- failureDetails
UeContextCreateData:
type: object
properties:
ueContext:
$ref: '#/components/schemas/UeContext'
targetId:
$ref: '#/components/schemas/NgRanTargetId'
sourceToTargetData:
$ref: '#/components/schemas/N2InfoContent'
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 179 ETSI TS 129 518 V15.6.0 (2020-01)
pduSessionList:
type: array
items:
$ref: '#/components/schemas/N2SmInformation'
minItems: 1
n2NotifyUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
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
- pduSessionList
UeContextCreatedData:
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
required:
- ueContext
- targetToSourceData
- pduSessionList
UeContextCreateError:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
ngapCause:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
required:
- error
NgRanTargetId:
type: object
properties:
ranNodeId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
tai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
required:
- ranNodeId
- tai
PWSResponseData:
type: object
properties:
ngapMessageType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
serialNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
messageIdentifier:
type: integer
unknownTaiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems: 1
required:
- ngapMessageType
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 180 ETSI TS 129 518 V15.6.0 (2020-01)
- serialNumber
- messageIdentifier
PWSErrorData:
type: object
properties:
namfCause:
type: integer
required:
- namfCause
N2InformationTransferError:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
pwdErrorInfo:
$ref: '#/components/schemas/PWSErrorData'
required:
- error
NgKsi:
type: object
properties:
tsc:
$ref: '#/components/schemas/ScType'
ksi:
type: integer
minimum: 0
maximum: 6
required:
- tsc
- ksi
KeyAmf:
type: object
properties:
keyType:
$ref: '#/components/schemas/KeyAmfType'
keyVal:
type: string
required:
- keyType
- keyVal
ExpectedUeBehavior:
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:
type: object
properties:
n2InfoContent:
$ref: '#/components/schemas/N2InfoContent'
required:
- n2InfoContent
N2InfoNotificationRspData:
type: object
properties:
n2InfoContent:
$ref: '#/components/schemas/N2InfoContent'
#
# SIMPLE DATA TYPES
#
EpsBearerId:
type: integer
minimum: 0
maximum: 15
Ppi:
type: integer
minimum: 0
maximum: 7
NasCount:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 181 ETSI TS 129 518 V15.6.0 (2020-01)
5GMmCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
UeSecurityCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
S1UeNetworkCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
DrxParameter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
OmcIdentifier:
type: string
#
# ENUMERATIONS
#
StatusChange:
anyOf:
- type: string
enum:
- AMF_UNAVAILABLE
- AMF_AVAILABLE
- type: string
N2InformationClass:
anyOf:
- type: string
enum:
- SM
- NRPPa
- PWS
- PWS-BCAL
- PWS-RF
- RAN
- type: string
N1MessageClass:
anyOf:
- type: string
enum:
- 5GMM
- SM
- LPP
- SMS
- UPDP
- type: string
N1N2MessageTransferCause:
anyOf:
- type: string
enum:
- ATTEMPTING_TO_REACH_UE
- N1_N2_TRANSFER_INITIATED
- WAITING_FOR_ASYNCHRONOUS_TRANSFER
- UE_NOT_RESPONDING
- N1_MSG_NOT_TRANSFERRED
- UE_NOT_REACHABLE_FOR_SESSION
- type: string
UeContextTransferStatus:
anyOf:
- type: string
enum:
- TRANSFERRED
- NOT_TRANSFERRED
- type: string
N2InformationTransferResult:
anyOf:
- type: string
enum:
- N2_INFO_TRANSFER_INITIATED
- type: string
CipheringAlgorithm:
anyOf:
- type: string
enum:
- NEA0
- NEA1
- NEA2
- NEA3
- type: string
IntegrityAlgorithm:
anyOf:
- type: string
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 182 ETSI TS 129 518 V15.6.0 (2020-01)
enum:
- NIA0
- NIA1
- NIA2
- NIA3
- type: string
SmsSupport:
anyOf:
- type: string
enum:
- 3GPP
- NON_3GPP
- BOTH
- NONE
- type: string
ScType:
anyOf:
- type: string
enum:
- NATIVE
- MAPPED
- type: string
KeyAmfType:
anyOf:
- type: string
enum:
- KAMF
- KPRIMEAMF
- type: string
TransferReason:
anyOf:
- type: string
enum:
- INIT_REG
- MOBI_REG
- MOBI_REG_UE_VALIDATED
- type: string
PolicyReqTrigger:
anyOf:
- type: string
enum:
- LOCATION_CHANGE
- PRA_CHANGE
- SARI_CHANGE
- RFSP_INDEX_CHANGE
- ALLOWED_NSSAI_CHANGE
- type: string
RatSelector:
anyOf:
- type: string
enum:
- E-UTRA
- NR
- type: string
NgapIeType:
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
- RAN_STATUS_TRANS_CONTAINER
- SON_CONFIG_TRANSFER
- NRPPA_PDU
- UE_RADIO_CAPABILITY
- SECONDARY_RAT_USAGE
- type: string
N2InfoNotifyReason:
anyOf:
- type: string
enum:
- HANDOVER_COMPLETED
- type: string
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 183 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 184 ETSI TS 129 518 V15.6.0 (2020-01)
application/json:
schema:
$ref: '#/components/schemas/AmfEventNotification'
required: true
responses:
'204':
description: Successful acknowledgement
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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:
description: Unexpected error
onSubscriptionIdChangeEvtReport:
'{$[Link]#/subscription/subsChangeNotifyUri}':
post:
summary: Event Notificaiton Delivery For Subscription Id Change
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AmfEventNotification'
required: true
responses:
'204':
description: Successful acknowledgement
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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:
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:
- $ref: '#/components/schemas/AmfUpdateEventSubscriptionItem'
- $ref: '#/components/schemas/AmfUpdateEventOptionItem'
required: true
responses:
'200':
description: Subsription modified successfully
content:
application/json:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 185 ETSI TS 129 518 V15.6.0 (2020-01)
schema:
$ref: '#/components/schemas/AmfUpdatedEventSubscription'
'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'
'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: Subsription deleted successfully
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'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:
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:
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:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 186 ETSI TS 129 518 V15.6.0 (2020-01)
$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'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
pei:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
anyUE:
type: boolean
options:
$ref: '#/components/schemas/AmfEventMode'
required:
- eventList
- eventNotifyUri
- notifyCorrelationId
- nfId
AmfEvent:
type: object
properties:
type:
$ref: '#/components/schemas/AmfEventType'
immediateFlag:
type: boolean
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'
required:
- type
AmfEventNotification:
type: object
properties:
notifyCorrelationId:
type: string
subsChangeNotifyCorrelationId:
type: string
reportList:
type: array
items:
$ref: '#/components/schemas/AmfEventReport'
minItems: 1
AmfEventReport:
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:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 187 ETSI TS 129 518 V15.6.0 (2020-01)
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
pei:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
location:
$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'
numberOfUes:
type: integer
required:
- type
- state
- timeStamp
AmfEventMode:
type: object
properties:
trigger:
$ref: '#/components/schemas/AmfEventTrigger'
maxReports:
type: integer
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required:
- trigger
AmfEventState:
type: object
properties:
active:
type: boolean
remainReports:
type: integer
remainDuration:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
required:
- active
RmInfo:
type: object
properties:
rmState:
$ref: '#/components/schemas/RmState'
accessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
required:
- rmState
- accessType
CmInfo:
type: object
properties:
cmState:
$ref: '#/components/schemas/CmState'
accessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
required:
- cmState
- accessType
CommunicationFailure:
type: object
properties:
nasReleaseCode:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 188 ETSI TS 129 518 V15.6.0 (2020-01)
type: string
ranReleaseCode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
AmfCreateEventSubscription:
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:
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:
type: array
items:
type: object
properties:
op:
type: string
enum:
- add
- remove
- replace
path:
type: string
pattern: '\/eventList\/[0-]$|\/eventList\/[1-9][0-9]*$'
value:
$ref: '#/components/schemas/AmfEvent'
required:
- op
- path
minItems: 1
AmfUpdateEventOptionItem:
type: object
properties:
op:
type: string
enum:
- replace
path:
type: string
pattern: '\/options\/expiry$'
value:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required:
- op
- path
- value
AmfUpdatedEventSubscription:
type: object
properties:
subscription:
$ref: '#/components/schemas/AmfEventSubscription'
required:
- subscription
AmfEventArea:
type: object
properties:
presenceInfo:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 189 ETSI TS 129 518 V15.6.0 (2020-01)
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
ladnInfo:
$ref: '#/components/schemas/LadnInfo'
LadnInfo:
type: object
properties:
ladn:
type: string
presence:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState'
required:
- ladn
5gGuti:
type: string
AmfEventType:
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
- LOSS_OF_CONNECTIVITY
- type: string
AmfEventTrigger:
anyOf:
- type: string
enum:
- ONE_TIME
- CONTINUOUS
- type: string
LocationFilter :
anyOf:
- type: string
enum:
- TAI
- CELL_ID
- N3IWF
- UE_IP
- UDP_PORT
- type: string
UeReachability:
anyOf:
- type: string
enum:
- UNREACHABLE
- REACHABLE
- REGULATORY_ONLY
- type: string
RmState:
anyOf:
- type: string
enum:
- REGISTERED
- DEREGISTERED
- type: string
CmState:
anyOf:
- type: string
enum:
- IDLE
- CONNECTED
- type: string
A.4 Namf_MT
openapi: 3.0.0
info:
version: 1.0.3
title: Namf_MT
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 190 ETSI TS 129 518 V15.6.0 (2020-01)
description: |
AMF Mobile Termination Service
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
security:
- {}
- oAuth2ClientCredentials:
- namf-mt
externalDocs:
description: 3GPP TS 29.518 V15.5.0; 5G System; Access and Mobility Management Services
url: '[Link]
servers:
- url: '{apiRoot}/namf-mt/v1'
variables:
apiRoot:
default: [Link]
description: apiRoot as defined in clause 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-.+|.+)$'
- 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':
description: Temporary Redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'The URI of the resource located on the target NF Service Consumer (e.g.
AMF) to which the request is redirected'
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 191 ETSI TS 129 518 V15.6.0 (2020-01)
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'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
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':
description: Temporary Redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'The URI of the resource located on the target NF Service Consumer (e.g.
AMF) to which the request is redirected'
required: true
schema:
type: string
'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'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
'504':
$ref: 'TS29571_CommonData.yaml#/components/responses/504'
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
namf-mt: Access to the Namf_MT API
schemas:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 192 ETSI TS 129 518 V15.6.0 (2020-01)
EnableUeReachabilityReqData:
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'
required:
- reachability
EnableUeReachabilityRspData:
type: object
properties:
reachability:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- reachability
UeContextInfo:
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'
UeContextInfoClass:
anyOf:
- type: string
enum:
- TADS
- type: string
A.5 Namf_Location
openapi: 3.0.0
info:
version: 1.0.4
title: Namf_Location
description: |
AMF Location Service
© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
security:
- {}
- oAuth2ClientCredentials:
- namf-loc
externalDocs:
description: 3GPP TS 29.518 V15.6.0; 5G System; Access and Mobility Management Services
url: '[Link]
servers:
- url: '{apiRoot}/namf-loc/v1'
variables:
apiRoot:
default: [Link]
description: apiRoot as defined in clause 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
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 193 ETSI TS 129 518 V15.6.0 (2020-01)
schema:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|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/ProvidePosInfo'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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'
'504':
$ref: 'TS29571_CommonData.yaml#/components/responses/504'
default:
description: Unexpected error
callbacks:
onUELocationNotification:
'{$[Link]#/locationNotificationUri}':
post:
requestBody:
description: UE Location Event Notification
content:
application/json:
schema:
$ref: '#/components/schemas/NotifiedPosInfo'
responses:
'204':
description: Expected response to a successful callback processing
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'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'
/{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
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 194 ETSI TS 129 518 V15.6.0 (2020-01)
pattern: '^(imsi-[0-9]{5,15}|nai-.+|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'
'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'
'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-loc: Access to the Namf_Location API
schemas:
RequestPosInfo:
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'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
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'
required:
- lcsClientType
- lcsLocation
ProvidePosInfo:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 195 ETSI TS 129 518 V15.6.0 (2020-01)
type: object
properties:
locationEstimate:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
accuracyFulfilmentIndicator:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator'
ageOfLocationEstimate:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate'
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'
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'
NotifiedPosInfo:
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'
ageOfLocationEstimate:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate'
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'
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'
required:
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 196 ETSI TS 129 518 V15.6.0 (2020-01)
- locationEvent
RequestLocInfo:
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'
oldGuami:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
ProvideLocInfo:
type: object
properties:
currentLoc:
type: boolean
location:
$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'
LocationType:
anyOf:
- type: string
enum:
- CURRENT_LOCATION
- CURRENT_OR_LAST_KNOWN_LOCATION
- INITIAL_LOCATION
- type: string
LocationEvent:
anyOf:
- type: string
enum:
- EMERGENCY_CALL_ORIGINATION
- EMERGENCY_CALL_RELEASE
- EMERGENCY_CALL_HANDOVER
- type: string
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 197 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 198 ETSI TS 129 518 V15.6.0 (2020-01)
Change history
Date Meeting TDoc CR Re Cat Subject/Comment New
v 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, 0.3.0
C4-176290, C4-176291, C4-176292, C4-176293, C4-176375, C4-
176376, C4-176378, C4-176379, C4-176380 and C4-176404.
2018-01 CT4#82 C4-181393 Implementation of pCRs agreed at CT4#82, including C4-181090, 0.4.0
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
2018-03 CT4#83 C4-182437 Implementation of pCRs agreed at CT4#83, including C4-182287, 0.5.0
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
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, 1.1.0
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
2018-05 CT4#85 C4-184629 Implementation of pCRs agreed at CT4#85, including: 1.2.0
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
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 15.1.0
agreements
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 15.1.0
alignment with stage 2
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
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 199 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 200 ETSI TS 129 518 V15.6.0 (2020-01)
ETSI
3GPP TS 29.518 version 15.6.0 Release 15 201 ETSI TS 129 518 V15.6.0 (2020-01)
History
Document history
V15.0.0 September 2018 Publication
ETSI