6.1.3 Resources
29.5183GPP5G SystemAccess and Mobility Management ServicesRelease 18Stage 3TS
6.1.3.1 Overview
Figure 6.1.3.1-1: Resource URI structure of the Namf_Communication API
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description (Mapped Service Operations) |
|
Individual ueContext |
/ue-contexts/{ueContextId} |
||
|
PUT |
CreateUEContext |
||
|
/ue-contexts/{ueContextId}/release |
release |
ReleaseUEContext |
|
|
/ue-contexts/{ueContextId}/assign-ebi |
assign-ebi |
EBIAssignment |
|
|
/ue-contexts/{ueContextId}/transfer |
transfer |
UEContextTransfer |
|
|
/ue-contexts/{ueContextId}/transfer-update |
transfer-update |
RegistrationStatusUpdate |
|
|
/ue-contexts/{ueContextId}/relocate |
relocate |
RelocateUEContext |
|
|
/ue-contexts/{ueContextId}/cancel-relocate |
cancel-relocate |
CancelRelocateUEContext |
|
|
n1N2Message collection |
/ue-contexts/{ueContextId}/n1-n2-messages |
POST |
N1N2MessageTransfer |
|
N1N2 Subscriptions Collection for Individual UE Contexts |
/ue-contexts/{ueContextId}/n1-n2-messages/subscriptions |
POST |
N1N2MessageSubscribe |
|
N1N2 Individual Subscription |
/ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} |
DELETE |
N1N2MessageUnSubscribe |
|
subscriptions collection |
/subscriptions |
POST |
AMFStatusChangeSubscribe |
|
individual subscription |
/subscriptions/{subscriptionId} |
PUT |
AMFStatusChangeSubscribe |
|
DELETE |
AMFStatusChangeUnSubscribe |
||
|
Non UE N2Messages collection |
/non-ue-n2-messages/transfer |
transfer |
NonUEN2MessageTransfer |
|
Non UE N2Messages Subscriptions collection |
/non-ue-n2-messages/subscriptions |
POST |
NonUEN2InfoSubscribe |
|
Non UE N2 Message Notification Individual Subscription |
/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} |
DELETE |
NonUEN2InfoUnsubscribe |
6.1.3.2 Resource: Individual ueContext
6.1.3.2.1 Description
This resource represents the an individual ueContext identified by the ueContextId.
This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.2.2 Resource Definition
Resource URI:{apiRoot}/namf-comm/<apiVersion>/ue-contexts/{ueContextId}
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
String |
See clause 6.1.1 |
|
apiVersion |
String |
See clause 6.1.1. |
|
ueContextId |
String |
Represents the 5G Globally Unique Temporary Identifier (See 3GPP TS 23.501 [2] clause 5.9.4) Pattern: "5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}" Or represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)" |
When the ueContextId is composed by UE’s SUPI or PEI, UE’s PEI shall be used for the case:
– If the UE is emergency registration and the UE is UICCless;
– If the UE is emergency registration but SUPI is not authenticated.
For other cases, UE’s SUPI shall be used.
6.1.3.2.3 Resource Standard Methods
6.1.3.2.3.1 PUT
This ueContextId identifies the individual ueContext resource is composed by UE’s SUPI or PEI, See table 6.1.3.2.2-1.
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UeContextCreateData |
M |
1 |
Defines the UE Context to be created. |
Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
UeContextCreatedData |
M |
1 |
201 Created |
This case represents the successful creation of a new UE Context. Upon success, a response body is returned containing the newly created UE Context. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI , or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
UeContextCreateError |
O |
0..1 |
403 Forbidden |
This case represents the creation of a new UE Context is not successful. The "cause" attribute may be used to indicate one of the following application errors: – HANDOVER_FAILURE |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm/<apiVersion>/ue-contexts/{ueContextId} |
|
3gpp-Sbi-Producer-Id |
string |
C |
0..1 |
This header shall be included when the UE Context is created in a target AMF other than the initial AMF sending the response. When included, this header shall indicate the target AMF serving the created UE Context. |
Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4 Resource Custom Operations
6.1.3.2.4.1 Overview
Table 6.1.3.2.4.1-1: Custom operations
|
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
|
release |
/ue-contexts/{ueContextId}/release |
POST |
Release an existing individual ueContext resource. It is used for the Release UE Context service operation. |
|
assign-ebi |
/ue-contexts/{ueContextId}/assign-ebi |
POST |
Assign EPS bearer ID(s) towards EPS bearer(s) mapped from QoS Flow(s), for a PDU session for the UE. It is used for EBIAssignment service operation. |
|
transfer |
/ue-contexts/{ueContextId}/transfer |
POST |
Transfer an existing individual ueContext resource from old AMF to new AMF. It is used for the UEContextTransfer service operation. |
|
transfer-update |
/ue-contexts/{ueContextId}/transfer-update |
POST |
Update the source AMF about the status of UE registration at the target AMF. It is used for the RegistrationStatusUpdate service operation. |
|
relocate |
/ue-contexts/{ueContextId}/relocate |
POST |
Relocate an existing individual ueContext resource. It is used for the RelocateUEContext service operation. |
6.1.3.2.4.2 Operation: release (POST)
6.1.3.2.4.2.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE’s SUPI or PEI, See table 6.1.3.2.2-1.
6.1.3.2.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2.
Table 6.1.3.2.4.2.2-1: Data structures supported by the (POST) release Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UEContextRelease |
M |
1 |
The information used for releasing of the UE Context |
Table 6.1.3.2.4.2.2-2: Data structures supported by the (POST) release Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
This case represents the handover is cancelled successfully. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be used to indicate one of the following application errors: – UNSPECIFIED – SUPI_OR_PEI_UNKNOWN See table 6.1.7.3-1 for the description of this error. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The "cause" attribute may be used to indicate one of the following application errors: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of this error. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4.3 Operation: assign-ebi (POST)
6.1.3.2.4.3.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE’s SUPI or PEI, see Table 6.1.3.2.2-1.
6.1.3.2.4.3.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.3.2-2.
Table 6.1.3.2.4.3.2-1: Data structures supported by the (POST) assign-ebi Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
AssignEbiData |
M |
1 |
The information required for AMF to allocate EPS bearer ID(s) or to update the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated. |
Table 6.1.3.2.4.3.2-2: Data structures supported by the (POST) assign-ebi Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
AssignedEbiData |
M |
1 |
200 OK |
Represent successful assignment of EPS bearer ID service operation, with the assigned EBIs included, or represent successful update of the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated. AMF may allocate only a subset of the requested EBIs, when not enough available EBI(s) can be allocated, e.g. when other PDU sessions with higher ARP have occupied too many EBIs. If the POST request body contained "releasedEbiList" the AMF shall release those EBI(s) and shall include the "releaseEbiList" IE in the POST response body. (NOTE 2) |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
AssignEbiError |
O |
0..1 |
403 Forbidden |
This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to: – EBI_EXHAUSTED, if the number of EBIs allocated for the UE has already reached the maximum limit. – EBI_REJECTED_LOCAL_POLICY, if the EBI allocation is rejected due to local policies at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3]. – EBI_REJECTED_NO_N26, if the EBI allocation was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface as specified in clause 5.17.2.3.1 of 3GPP TS 23.501 [2]. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
This error shall only be returned by an SCP for errors it originates. |
|
AssignEbiError |
O |
0..1 |
409 Conflict |
This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to: – TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure. – TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing N2 handover procedure or an ongoing Xn handover procedure. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: When receiving EBI assignment request during Xn Handover or N2 Handover, the AMF may either reject the request with the TEMPORARY_REJECT_HANDOVER_ONGOING application error in a 409 Conflict response or proceed with assigning EBIs with a 200 OK response. In the latter case, upon receipt of the 200 OK response, the SMF shall take the assigned EBIs into account in subsequent processing. |
||||
Table 6.1.3.2.4.3.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.3.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4.4 Operation: transfer (POST)
6.1.3.2.4.4.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE’s 5G-GUTI or SUPI, see Table 6.1.3.2.2-1.
6.1.3.2.4.4.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.4.2-2.
Table 6.1.3.2.4.4.2-1: Data structures supported by the (POST) transfer Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UeContextTransferReqData |
M |
1 |
Represents to start transferring of an individual ueContext resource from old AMF to new AMF. |
Table 6.1.3.2.4.4.2-2: Data structures supported by the (POST) transfer Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
UeContextTransferRspData |
M |
1 |
200 OK |
Indicates the transferring of the individual ueContext resource is started successfully. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
Indicates that AMF can understand the request but cannot fulfil the request due to errors. If the integrity check of the included complete registration message fails at the source AMF the "cause" attribute is set to: – INTEGRITY_CHECK_FAIL. See table 6.1.7.3-1 for the description of these errors. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.4.4.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.4.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4.5 Operation: transfer-update (POST)
6.1.3.2.4.5.1 Description
This ueContextId identifies the individual ueContext resource is composed by UE’s 5G-GUTI, see Table 6.1.3.2.2-1.
6.1.3.2.4.5.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2.
Table 6.1.3.2.4.5.2-1: Data structures supported by the (POST) transfer-update Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UeRegStatusUpdateReqData |
M |
1 |
Represents to the update of status on the transferring of an individual ueContext resource from old AMF to new AMF. |
Table 6.1.3.2.4.5.2-2: Data structures supported by the (POST) transfer-update Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
UeRegStatusUpdateRspData |
M |
1 |
200 OK |
Indicates the update of UE context transfer status is successful at the source AMF. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
Indicates that AMF can understand the request but cannot fulfil the request due to errors. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to: – CONTEXT_NOT_FOUND |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.4.5.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.5.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4.6 Operation: relocate (POST)
6.1.3.2.4.6.1 Description
The ueContextId identifying the individual ueContext resource is composed by UE’s SUPI or PEI, see Table 6.1.3.2.2-1.
6.1.3.2.4.6.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.6.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2.
Table 6.1.3.2.4.6.2-1: Data structures supported by the (POST) relocate Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UeContextRelocateData |
M |
1 |
Defines the UE Context to be relocated to a new AMF. |
Table 6.1.3.2.4.6.2-2: Data structures supported by the (POST) relocate Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
UeContextRelocatedData |
M |
1 |
201 Created |
This case represents the successful relocation of UE Context to a new AMF. Upon success, a response body is returned containing the newly created UE Context in new AMF. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetail |
O |
0..1 |
403 Forbidden |
This case represents an unsuccessful relocation of UE Context to a new AMF. The "cause" attribute may be used to indicate one of the following application errors: – HANDOVER_FAILURE |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.4.6.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.6.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.2.4.7 Operation: cancel-relocate (POST)
6.1.3.2.4.7.1 Description
This ueContextId identifying the individual ueContext resource is composed by UE’s SUPI or PEI, See table 6.1.3.2.2-1.
6.1.3.2.4.7.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.2.4.7.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.7-2.
Table 6.1.3.2.4.7.2-1: Data structures supported by the (POST) release Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UEContextCancelRelocateData |
M |
1 |
The information used for cancellation of UE Context Relocation. |
Table 6.1.3.2.4.2.7-2: Data structures supported by the (POST) release Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
This case represents the handover is cancelled successfully. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, .the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be used to indicate one of the following application errors: – UNSPECIFIED – SUPI_OR_PEI_UNKNOWN See table 6.1.7.3-1 for the description of this error. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The "cause" attribute may be used to indicate one of the following application errors: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of this error. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.2.4.2.7-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.4.2.7-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.3 Resource: N1N2 Subscriptions Collection for Individual UE Contexts
6.1.3.3.1 Description
This resource represents the collection under an individual UE context for storing the subscriptions for notifications of UE specific N1 and N2 message types. This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/{ueContextId}/n1-n2-messages/subscriptions
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
Table 6.1.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
|
ueContextId |
string |
Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)" |
6.1.3.3.3 Resource Standard Methods
6.1.3.3.3.1 POST
This method creates an individual N1/N2 information subscription resource for UE related N1/N2 information. This method is used by NF Service Consumers (e.g. PCF) to subscribe for notifications about UE related N1/N2 Information.
This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3.
Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
UeN1N2InfoSubscriptionCreateData |
C |
0..1 |
Representation of the subscription for N1 and/or N2 information notification. It shall contain the information regarding N1 and/or N2 information to be notified and the callback URI for the respective notifications. |
Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
UeN1N2InfoSubscriptionCreatedData |
C |
0..1 |
201 Created |
This case represents the successful creation of the subscription for N1 and/or N2 information notification. Upon success, a response body is returned containing the representation describing the status of the request. The Location header shall contain the location (URI) of the created subscription resource. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.3.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm/<apiVersion>/{ueContextId}/ue-contexts/n1-n2-messages/subscriptions/{subscriptionId} |
Table 6.1.3.3.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.3.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.3.4 Resource Custom Operations
There are no custom operations supported on this resource.
6.1.3.4 Resource: N1N2 Individual Subscription
6.1.3.4.1 Description
This resource represents the individual subscription for the subscription for notifications of UE specific N1 and N2 message types.
This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.4.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.1.3.4.2-1.
Table 6.1.3.4.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
|
ueContextId |
string |
Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)" |
|
subscriptionId |
string |
Represents the individual subscription to the UE specific N1/N2 message notification. |
6.1.3.4.3 Resource Standard Methods
6.1.3.4.3.1 DELETE
This method deletes an individual N1/N2 message notification subscription resource for an individual UE. This method is used by NF Service Consumers (e.g. PCF) to unsubscribe for notifications about UE related N1/N2 information.
This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3.
Table 6.1.3.4.3.1-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.1.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
|||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to: – SUBSCRIPTION_NOT_FOUND |
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.4.4 Resource Custom Operations
There are no custom operations supported on this resource.
6.1.3.5 Resource: N1N2 Messages Collection
6.1.3.5.1 Description
This resource represents the collection on which UE related N1 messages and N2 information transfer are initiated and the N1 information for the UE is stored temporarily until the UE is reachable. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.5.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/ue-contexts/{ueContextId}/n1-n2-messages
This resource shall support the resource URI variables defined in table 6.1.3.5.2-1.
Table 6.1.3.5.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
|
ueContextId |
string |
Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15}|imeisv-[0-9]{16})" Or represents the LCS Correlation ID (see 3GPP TS 29.572 [25] clause 6.1.6.3.2) (NOTE) pattern: "(cid-.{1,255})" |
|
NOTE: The LCS Correlation ID shall only be applied when transferring LCS related UE-Specific N1 and/or N2 messages. |
||
6.1.3.5.3 Resource Standard Methods
6.1.3.5.3.1 POST
This method initiates a N1 message and/or N2 message transfer at the AMF and may create a resource to store the N1 and/or N2 message as specified in clause 5.2.2.3.1.2, e.g. if asynchronous type communication is invoked or if the UE is paged.
This method shall support the request data structures specified in table 6.1.3.5.3.1-1 and the response data structures and response codes specified in table 6.1.3.5.3.1-2.
Table 6.1.3.5.3.1-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
N1N2MessageTransferReqData |
M |
1 |
This contains: – N1 message, if the NF Service Consumer requests to transfer an N1 message to the UE or; – N2 information, if the NF Service Consumer requests to transfer an N2 information to the 5G-AN or; – both, if the NF Service Consumer requests to transfer both an N1 message to the UE and an N2 information to the 5G-AN. |
Table 6.1.3.5.3.1-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
N1N2MessageTransferRspData |
M |
1 |
202 Accepted |
This case represents the successful storage of the N1/N2 information at the AMF when asynchronous communication is invoked or when the AMF pages the UE. If the AMF pages the UE, it shall store the N1/N2 message information until the UE responds to paging. The cause included in the response body shall be set to one of the following values: – WAITING_FOR_ASYNCHRONOUS_TRANSFER – ATTEMPTING_TO_REACH_UE The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. |
|
N1N2MessageTransferRspData |
M |
1 |
200 OK |
This represents the cases where: – the AMF is able to successfully transfer the N1/N2 message to the UE and/or the AN; – the AMF skips sending and discards the N1 message when UE is in CM-IDLE and the "skipInd" is set to "true" in the request; or – the AMF skips sending and discards the N2 message as well as the possibly included N1 message, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request. The cause included in the response body shall be to one of the following values: – N1_N2_TRANSFER_INITIATED – N1_MSG_NOT_TRANSFERRED – N2_MSG_NOT_TRANSFERRED |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
When the related UE context is not fully available at the target NF Service Consumer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case), the "cause" attribute shall be set to: – NF_CONSUMER_REDIRECT_ONE_TXN See table 6.1.7.3-1 for the description of these errors The Location header of the response shall be set to URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be used to indicate one of the following application errors: – UE_IN_NON_ALLOWED_AREA – UE_WITHOUT_N1_LPP_SUPPORT – UNSPECIFIED – SM_CONTEXT_RELOCATION_REQUIRED See table 6.1.7.3-1 for the description of these errors. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When the related UE is not found in the NF Service Consumer (e.g. AMF), the "cause" attribute shall be set to: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
|
N1N2MessageTransferError |
O |
0..1 |
409 Conflict |
This represents the case where the AMF rejects the N1N2MessageTransfer request due to one of the following reasons. The cause attribute of the ProblemDetails structure shall be set to: – HIGHER_PRIORITY_REQUEST_ONGOING, if there is already an ongoing paging procedure with higher or same priority; – TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]); – TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing Xn or N2 handover procedure (see clause 4.9.1.2.1 and 4.9.1.3.1 of 3GPP TS 23.502 [3]). – UE_IN_CM_IDLE_STATE, if this is a request to transfer a N2 PDU Session Resource Modify Request or a N2 PDU Session Resource Release Command to a 5G-AN, and if the UE is in CM-IDLE state at the AMF for the Access Network Type associated to the PDU session. – MAX_ACTIVE_SESSIONS_EXCEEDED, if the RAT type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources. – REJECTION_DUE_TO_PAGING_RESTRICTION, if Paging Restrictions information restricts the N1N2MessageTransfer request from causing paging as specified in 3GPP TS 23.501 [2] clause 5.38.5 See table 6.1.7.3-1 for the description of these errors. |
|
N1N2MessageTransferError |
O |
0..1 |
504 Gateway Timeout |
This represents the case where the UE is not reachable at the AMF and the AMF is unable to page the UE. The cause attribute of the ProblemDetails structure shall be set to: – UE_NOT_REACHABLE, if the UE is not reachable for paging; See table 6.1.7.3-1 for the description of these errors. |
|
ProblemDetails |
O |
0..1 |
504 Gateway Timeout |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.5.3.1-3: Headers supported by the 202 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
The URI of the resource located on the AMF to which the status of the N1N2 message transfer is held |
Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.6 Resource: subscriptions collection
6.1.3.6.1 Description
This resource represents a collection of subscriptions of NF service consumers to the status change of the AMF identified by the GUAMI(s).
This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.6.2 Resource Definition
Resource URI:{apiRoot}/namf-comm/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 6.1.3.6.2-1.
Table 6.1.3.6.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
6.1.3.6.3 Resource Standard Methods
6.1.3.6.3.1 POST
This method creates a new subscription. This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1.
Table 6.1.3.6.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3.
Table 6.1.3.6.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
SubscriptionData |
M |
1 |
The request body contains the input parameters for the subscription. These parameters include, e.g.: – GUAMI(s) – amfStatusUri |
Table 6.1.3.6.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
SubscriptionData |
M |
1 |
201 Created |
This case represents the successful creation of a subscription. Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be used to indicate one of the following application errors: – UNSPECIFIED See table 6.1.7.3-1 for the description of this error. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.6.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm/<apiVersion>/subscriptions/{subscriptionId} |
Table 6.1.3.6.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.6.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.7 Resource: individual subscription
6.1.3.7.1 Description
This resource represents an individual subscription of a NF service consumer to the status change of the AMF identified by the GUAMI(s).
This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.7.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.1.3.7.2-1.
Table 6.1.3.7.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
|
subscriptionId |
string |
Represents a specific subscription |
6.1.3.7.3 Resource Standard Methods
6.1.3.7.3.1 DELETE
This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1.
Table 6.1.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3.
Table 6.1.3.7.3.1-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.1.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
204 No Content |
This case represents a successful deletion of the subscription. |
|||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to: – SUBSCRIPTION_NOT_FOUND |
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.7.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.7.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.7.3.2 PUT
This method replaces an existing subscription completely. This method shall support the URI query parameters specified in table 6.1.3.7.3.2-1.
Table 6.1.3.7.3.2-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.7.3.2-2 and the response data structures and response codes specified in table 6.1.3.7.3.2-3.
Table 6.1.3.7.3.2-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
SubscriptionData |
M |
1 |
The request body contains the input parameters for the subscription. These parameters include, e.g.: – GUAMI(s) – amfStatusUri |
Table 6.1.3.7.3.2-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
SubscriptionData |
M |
1 |
200 OK |
This case represents a successful replacement of the subscription. |
|
n/a |
204 No Content |
Represents the events subscription modification provided by the NF Service Consumer is accepted entirely. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
This case represents the failure update of an existing subscription. |
|
NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.7.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.7.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.8 Resource: Non UE N2 Messages Collection
6.1.3.8.1 Description
This resource represents the collection on which custom operations to transfer the N2 message towards the 5G-AN are specified. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.8.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/non-ue-n2-messages
This resource shall support the resource URI variables defined in table 6.1.3.8.2-1.
Table 6.1.3.8.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
String |
See clause 6.1.1 |
|
apiVersion |
String |
See clause 6.1.1. |
6.1.3.8.3 Resource Standard Methods
There are no resource standard methods for the non-ue-n2-messages collection resource in this release of this specification.
6.1.3.8.4 Resource Custom Operations
6.1.3.8.4.1 Overview
Table 6.1.3.8.4.1-1: Custom operations
|
Operation Name |
Custom operaration URI |
Mapped HTTP method |
Description |
|
transfer |
{resourceUri}/transfer |
POST |
Transfer the N2 message to 5G-AN. |
6.1.3.8.4.2 Operation: transfer
6.1.3.8.4.2.1 Description
The {resourceUri}/transfer custom operation is used to initiate a non UE associated N2 information transfer to the identified 5G-AN nodes. This custom operation uses the HTTP POST method.
6.1.3.8.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.8.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.8.4.2.2-2.
Table 6.1.3.8.4.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
N2InformationTransferReqData |
M |
1 |
Representation of the data to be sent to the 5G-AN node(s) by the AMF. |
Table 6.1.3.8.4.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
N2InformationTransferRspData |
M |
1 |
200 OK |
Indicates AMF has successfully initiated the transferring of N2 Information to the AN.. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
N2InformationTransferError |
O |
0..1 |
400 Bad Request |
The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
N2InformationTransferError |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be set to one of the following application errors: – UNSPECIFIED See table 6.1.7.3-1 for the description of these errors. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
N2InformationTransferError |
O |
0..1 |
404 Not Found |
The "cause" attribute may be set to one of the following application errors: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
|
N2InformationTransferError |
O |
0..1 |
500 Internal Server Error |
The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. |
|
ProblemDetails |
O |
0..1 |
500 Internal Server Error |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
N2InformationTransferError |
O |
0..1 |
503 Service Unavailable |
The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. |
|
ProblemDetails |
O |
0..1 |
503 Service Unavailable |
This error shall only be returned by an SCP or a SEPP for errors they originate. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.8.4.2.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.8.4.2.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.9 Resource: Non UE N2 Messages Subscriptions Collection
6.1.3.9.1 Description
This resource represents the collection on which individual subscriptions for non UE N2 messages from the 5G-AN are stored. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.9.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/non-ue-n2-messages/subscriptions
This resource shall support the resource URI variables defined in table 6.1.3.9.2-1.
Table 6.1.3.9.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
6.1.3.9.3 Resource Standard Methods
6.1.3.9.3.1 POST
This method creates an individual N2 information subscription resource for non UE related N2 information. This method is used by NF Service Consumers (e.g. LMF, CBCF/PWS-IWF) to subscribe for notifications about non UE related N2 Information from a specific 5G-AN node, or from any 5G-AN node.
This method shall support the request data structures specified in table 6.1.3.9.3.1-2 and the response data structures and response codes specified in table 6.1.3.9.3.1-3.
Table 6.1.3.9.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
NonUeN2InfoSubscriptionCreateData |
M |
1 |
Representation of the subscription for N2 information notification. |
Table 6.1.3.9.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
NonUeN2InfoSubscriptionCreatedData |
M |
1 |
201 Created |
This case represents the successful creation of the subscription for N2 information notification. Upon success, a response body is returned containing the representation describing the status of the request. The Location header shall carry the location (URI) of the created subscription resource. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
If the NF Service Consumer is not authorized to subscribe for non UE N2 message notifications, the AMF shall return this status code with the ProblemDetails |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.9.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm/<apiVersion>/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} |
Table 6.1.3.9.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.9.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.9.4 Resource Custom Operations
There are no custom operations supported on this resource.
6.1.3.10 Resource: Non UE N2 Message Notification Individual Subscription
6.1.3.10.1 Description
This resource represents the individual subscription for the notifications of non UE specific N2 message types (e.g. NRPPa, PWS Notifications).
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.10.2 Resource Definition
Resource URI: {apiRoot}/namf-comm/<apiVersion>/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}
This resource shall support the resource URI variables defined in table 6.1.3.10.2-1.
Table 6.1.3.7.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
|
apiVersion |
string |
See clause 6.1.1. |
|
n2NotifySubscriptionId |
string |
Represents the individual subscription to the non UE specific N2 message notification. |
6.1.3.10.3 Resource Standard Methods
6.1.3.10.3.1 DELETE
This method deletes an individual N2 message notification subscription resource for non UE associated N2 information. This method is used by NF Service Consumers (e.g. LMF) to unsubscribe for notifications about non UE related N2 information.
This method shall support the request data structures specified in table 6.1.3.10.3.1-2 and the response data structures and response codes specified in table 6.1.3.10.3.1-3.
Table 6.1.3.10.3.1-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.1.3.10.3.1-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
|||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the resource corresponding to the SubscriptionId cannot be found the AMF shall return this status code. The "cause" attribute is set to: – SUBSCRIPTION_NOT_FOUND |
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
||||
Table 6.1.3.10.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.1.3.10.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.1.3.10.4 Resource Custom Operations
There are no custom operations supported on this resource.