6.1.3 Resources
29.5023GPP5G SystemRelease 16Session Management ServicesStage 3TS
6.1.3.1 Overview
Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf_PDUSession API.
Figure 6.1.3.1-1: Resource URI structure of the Nsmf_PDUSession API
NOTE: The sm-contexts and pdu-sessions collection resources can be distributed on different processing instances or hosts. Thus, the authority and/or deployment-specific string of the apiRoot of the created individual sm context and pdu-session resources’ URIs can differ from the authority and/or deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions distributed collections’ URIs.
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method or custom operation |
Description (service operation) |
SM contexts collection |
/sm-contexts |
POST |
Create SM Context |
Individual SM context |
/sm-contexts/{smContextRef}/retrieve |
retrieve (POST) |
Retrieve SM Context |
/sm-contexts/{smContextRef}/modify |
modify (POST) |
Update SM Context |
|
/sm-contexts/{smContextRef}/release |
release (POST) |
Release SM Context |
|
/sm-contexts/{smContextRef}/send-mo-data |
send-mo-data (POST) |
Send MO Data |
|
PDU sessions collection (H-SMF or SMF) |
/pdu-sessions |
POST |
Create |
Individual PDU session (H-SMF or SMF) |
/pdu-sessions/{pduSessionRef}/modify |
modify (POST) |
Update (initiated by V-SMF or I-SMF) |
/pdu-sessions/{pduSessionRef}/release |
release (POST) |
Release |
|
/pdu-sessions/{pduSessionRef}/retrieve |
retrieve (POST) |
Retrieve |
|
/pdu-sessions/{pduSessionRef}/transfer-mo-data |
transfer-mo-data (POST) |
Transfer MO Data |
|
Individual PDU session (V-SMF or I-SMF) |
{vsmfPduSessionUri}/modify or {ismfPduSessionUri}/modify |
modify (POST) |
Update (initiated by H-SMF or SMF) |
{vsmfPduSessionUri} or {ismfPduSessionUri} |
POST |
Notify Status |
|
{vsmfPduSessionUri}/transfer-mt-data or {ismfPduSessionUri}/ transfer-mt-data |
transfer-mt-data (POST) |
Transfer MT Data |
6.1.3.2 Resource: SM contexts collection
6.1.3.2.1 Description
This resource represents the collection of the individual SM contexts created in the SMF.
This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.1.3.2.2 Resource Definition
Resource URI: {apiRoot}/nsmf-pdusession/{apiVersion}/sm-contexts
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.1.1. |
apiVersion |
string |
See clause 6.1.1. |
6.1.3.2.3 Resource Standard Methods
6.1.3.2.3.1 POST
This method creates an individual SM context resource in the SMF, or in V-SMF in HR roaming scenarios.
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SmContextCreateData |
M |
1 |
Representation of the SM context to be created in the SMF. |
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SmContextCreatedData |
M |
1 |
201 Created |
Successful creation of an SM 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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
SmContextCreateError |
M |
1 |
400 Bad Request |
The "cause" attribute shall 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 for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
SmContextCreateError |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application error: – N1_SM_ERROR – N2_SM_ERROR – SNSSAI_DENIED – DNN_DENIED – PDUTYPE_DENIED – SSC_DENIED – SUBSCRIPTION_DENIED – DNN_NOT_SUPPORTED – PDUTYPE_NOT_SUPPORTED – SSC_NOT_SUPPORTED – HOME_ROUTED_ROAMING_REQUIRED – OUT_OF_LADN_SERVICE_AREA – NO_EPS_5GS_CONTINUITY – INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABLE – DEFAULT_EPS_BEARER_INACTIVE – NOT_SUPPORTED_WITH_ISMF – SERVICE_NOT_AUTHORIZED_BY_NEXT_HOP 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 for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
SmContextCreateError |
M |
1 |
404 Not Found |
The "cause" attribute shall be set to one of the following application error: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
ExtProblemDetails |
O |
0..1 |
413 Payload Too Large |
|
ExtProblemDetails |
O |
0..1 |
415 Unsupported Media Type |
|
ExtProblemDetails |
O |
0..1 |
429 Too Many Requests |
|
SmContextCreateError |
M |
1 |
500 Internal Server Error |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – INSUFFICIENT_RESOURCES_SLICE – INSUFFICIENT_RESOURCES_SLICE_DNN See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
500 Internal Server Error |
This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
SmContextCreateError |
M |
1 |
503 Service Unavailable |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – DNN_CONGESTION – S_NSSAI_CONGESTION See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
503 Service Unavailable |
This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
SmContextCreateError |
M |
1 |
504 Gateway Timeout |
The "cause" attribute shall be set to one of the following application error: – PEER_NOT_RESPONDING – NETWORK_FAILURE 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 for errors it originates. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/{apiVersion}/sm-contexts/{smContextRef} |
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 SMF or SMF (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 SMF (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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.2.4 Resource Custom Operations
None.
6.1.3.3 Resource: Individual SM context
6.1.3.3.1 Description
This resource represents an individual SM context created in the SMF.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/nsmf-pdusession/{apiVersion}/sm-contexts/{smContextRef}
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. |
smContextRef |
string |
SM context reference assigned by the SMF during the Create SM Context service operation. |
6.1.3.3.3 Resource Standard Methods
None.
6.1.3.3.4 Resource Custom Operations
6.1.3.3.4.1 Overview
Table 6.1.3.3.4.1-1: Custom operations
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
modify |
{resourceUri}/modify |
POST |
Update SM Context service operation |
release |
{resourceUri}/release |
POST |
Release SM Context service operation |
retrieve |
{resourceUri}/retrieve |
POST |
Retrieve SM Context service operation |
send-mo-data |
{resourceUri}/send-mo-data |
POST |
Send MO Data service operation |
6.1.3.3.4.2 Operation: modify
6.1.3.3.4.2.1 Description
6.1.3.3.4.2.2 Operation Definition
This custom operation updates an individual SM context resource and/or provide N1 or N2 SM information received from the UE or the AN, for a given PDU session, towards the SMF, or in V-SMF in HR roaming scenario.
This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2.
Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SmContextUpdateData |
M |
1 |
Representation of the updates to apply to the SM context. |
Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SmContextUpdatedData |
C |
0..1 |
200 OK |
Successful update of the SM context, when the SMF needs to return information in the response. |
n/a |
204 No Content |
Successful update of the SM context, when the SMF does not need to return information in the response. |
||
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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
SmContextUpdateError |
M |
1 |
400 Bad Request |
The "cause" attribute shall 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 for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
SmContextUpdateError |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application error: – N1_SM_ERROR – N2_SM_ERROR – SUBSCRIPTION_DENIED – OUT_OF_LADN_SERVICE_AREA – PRIORITIZED_SERVICES_ONLY – PDU_SESSION_ANCHOR_CHANGE 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 for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
SmContextUpdateError |
M |
1 |
404 Not Found |
The "cause" attribute shall be set to one of the following application error: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
ExtProblemDetails |
O |
0..1 |
413 Payload Too Large |
|
ExtProblemDetails |
O |
0..1 |
415 Unsupported Media Type |
|
ExtProblemDetails |
O |
0..1 |
429 Too Many Requests |
|
SmContextUpdateError |
M |
1 |
500 Internal Server Error |
The "cause" attribute shall 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 for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
SmContextUpdateError |
M |
1 |
503 Service Unavailable |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – DNN_CONGESTION – S-NSSAI_ CONGESTION See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
503 Service Unavailable |
This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.3.4.3 Operation: release
6.1.3.3.4.3.1 Description
6.1.3.3.4.3.2 Operation Definition
This custom operation releases an individual SM context resource in the SMF, or in V-SMF in HR roaming scenario
This operation shall support the request data structures specified in table 6.1.3.3.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.3.2-2.
Table 6.1.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SmContextReleaseData |
C |
0..1 |
Representation of the data to be sent to the SMF when releasing the SM context. |
Table 6.1.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SmContextReleasedData |
M |
1 |
200 OK |
Successful release of an SM context, when information needs to be returned to the NF Service Consumer (NOTE 2). |
n/a |
204 No Content |
Successful release of an SM 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 SMF or SMF (service) set. (NOTE 3) |
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 SMF or SMF (service) set. (NOTE 3) |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: The support for 200 OK shall be dependent on the support of the indicated feature. NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.3.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.3.4.4 Operation: retrieve
6.1.3.3.4.4.1 Description
6.1.3.3.4.4.2 Operation Definition
This custom operation retrieves an individual SM context resource from the SMF, from the V-SMF in HR roaming scenario or from the I-SMF.
This operation shall support the request data structures specified in table 6.1.3.3.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.4.2-2.
Table 6.1.3.3.4.4.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SmContextRetrieveData |
O |
0..1 |
Optional parameters used to retrieve the SM context, e.g. target MME capabilities, SM context type. |
Table 6.1.3.3.4.4.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
SmContextRetrievedData |
M |
1 |
200 OK |
Successful retrieval of the SM 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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
ProblemDetails |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application error: – TARGET_MME_CAPABILITY – DEFAULT_EBI_NOT_TRANSFERRED See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
504 Gateway Timeout |
The "cause" attribute may be set to one of the following application errors: – UPF_NOT_RESPONDING See table 6.1.7.3-1 for the description of these errors. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.3.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.3.4.4.2-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.3.4.5 Operation: send-mo-data
6.1.3.3.4.5.1 Description
6.1.3.3.4.5.2 Operation Definition
This custom operation enables to send mobile originated data received over NAS, for a given PDU session, towards the SMF, or the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF.
This operation shall support the request data structures specified in table 6.1.3.3.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.5.2-2.
Table 6.1.3.3.4.5.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
SendMoDataReqData |
M |
1 |
Representation of the payload of a Send MO Data Request |
Table 6.1.3.3.4.5.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful MO data transfer |
||
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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
ExtProblemDetails |
O |
0..1 |
400 Bad Request |
|
ExtProblemDetails |
O |
0..1 |
401 Unauthorized |
|
ExtProblemDetails |
O |
0..1 |
403 Forbidden |
|
ExtProblemDetails |
O |
0..1 |
404 Not Found |
|
ExtProblemDetails |
O |
0..1 |
413 Payload Too Large |
|
ExtProblemDetails |
O |
0..1 |
415 Unsupported Media Type |
|
ExtProblemDetails |
O |
0..1 |
429 Too Many Requests |
|
ExtProblemDetails |
O |
0..1 |
500 Internal Server Error |
|
ExtProblemDetails |
O |
0..1 |
503 Service Unavailable |
|
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.3.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.3.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.4 Void
6.1.3.5 Resource: PDU sessions collection (H-SMF or SMF)
6.1.3.5.1 Description
This resource represents the collection of the individual PDU sessions created in the H-SMF for HR PDU sessions or in the SMF for PDU sessions with an I-SMF.
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}/nsmf-pdusession/{apiVersion}/pdu-sessions
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. |
6.1.3.5.3 Resource Standard Methods
6.1.3.5.3.1 POST
This method creates an individual PDU session resource in the H-SMF or SMF.
This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1.
Table 6.1.3.5.3.1-1: URI query parameters supported by the 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.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3.
Table 6.1.3.5.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
PduSessionCreateData |
M |
1 |
Representation of the PDU session to be created in the H-SMF or SMF. |
Table 6.1.3.5.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PduSessionCreatedData |
M |
1 |
201 Created |
Successful creation of a PDU session. |
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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
PduSessionCreateError |
M |
1 |
400 Bad Request |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
PduSessionCreateError |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application error: – N1_SM_ERROR – SNSSAI_DENIED – DNN_DENIED – PDUTYPE_DENIED – SSC_DENIED – SUBSCRIPTION_DENIED – DNN_NOT_SUPPORTED – PDUTYPE_NOT_SUPPORTED – SSC_NOT_SUPPORTED – NO_EPS_5GS_CONTINUITY – INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABLE – NOT_SUPPORTED_WITH_ISMF 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
PduSessionCreateError |
M |
1 |
404 Not Found |
The "cause" attribute shall be set to one of the following application error: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
PduSessionCreateError |
M |
1 |
500 Internal Server Error |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – INSUFFIC_RESOURCES_SLICE – INSUFFIC_RESOURCES_SLICE_DNN See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
500 Internal Server Error |
This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
PduSessionCreateError |
M |
1 |
503 Service Unavailable |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – DNN_CONGESTION – S-NSSAI_ CONGESTION See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
503 Service Unavailable |
This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
PduSessionCreateError |
M |
1 |
504 Gateway Timeout |
The "cause" attribute shall be set to one of the following application error: – PEER_NOT_RESPONDING – NETWORK_FAILURE 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 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.5.3.1-4: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/{apiVersion}/pdu-sessions/{pduSessionRef} |
Table 6.1.3.5.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.5.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.5.4 Resource Custom Operations
6.1.3.5.4.1 Overview
Table 6.1.3.5.4.1-1: Custom operations
Custom operaration URI |
Mapped HTTP method |
Description |
n/a |
6.1.3.6 Resource: Individual PDU session (H-SMF or SMF)
6.1.3.6.1 Description
This resource represents an individual PDU session created in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.6.2 Resource Definition
Resource URI: {apiRoot}/nsmf-pdusession/{apiVersion}/pdu-sessions/{pduSessionRef}
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. |
pduSessionRef |
string |
PDU session reference assigned by the H-SMF or SMF during the Create service operation. |
6.1.3.6.3 Resource Standard Methods
None.
6.1.3.6.4 Resource Custom Operations
6.1.3.6.4.1 Overview
Table 6.1.3.6.4.1-1: Custom operations
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
modify |
{resourceUri}/modify |
POST |
Update service operation |
release |
{resourceUri}/release |
POST |
Release service operation |
transfer-mo-data |
{resourceUri}/ transfer-mo-data |
POST |
Transfer MO Data service operation |
retrieve |
{resourceUri}/retrieve |
POST |
Retrieve service operation |
6.1.3.6.4.2 Operation: modify
6.1.3.6.4.2.1 Description
6.1.3.6.4.2.2 Operation Definition
This custom operation updates an individual PDU session resource in the H-SMF or SMF and/or provide the H-SMF or SMF with information received by the V-SMF or I-SMF in N1 SM signalling from the UE.
This operation shall support the request data structures specified in table 6.1.3.6.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.2.2-2.
Table 6.1.3.6.4.2.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
HsmfUpdateData |
M |
1 |
Representation of the updates to apply to the PDU session. |
Table 6.1.3.6.4.2.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
HsmfUpdatedData |
C |
0..1 |
200 OK |
This case represents a successful update of the PDU session, when the H-SMF or SMF needs to return information in the response. |
n/a |
204 No Content |
This case represents a successful update of the PDU session, when the H-SMF or SMF does not need to return information in the response. |
||
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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
HsmfUpdateError |
M |
1 |
400 Bad Request |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
HsmfUpdateError |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application errors: – N1_SM_ERROR – SUBSCRIPTION_DENIED – PDU_SESSION_ANCHOR_CHANGE 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
HsmfUpdateError |
M |
1 |
404 Not Found |
The "cause" attribute shall be set to one of the following application error: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
HsmfUpdateError |
M |
1 |
500 Internal Server Error |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
HsmfUpdateError |
M |
1 |
503 Service Unavailable |
The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors: – DNN_CONGESTION – S-NSSAI_ CONGESTION See table 6.1.7.3-1 for the description of these errors. |
ProblemDetails |
O |
0..1 |
503 Service Unavailable |
This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table Table 6.1.3.6.4.2.2-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. 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 SMF (service) instance ID towards which the request is redirected |
Table Table 6.1.3.6.4.2.2-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. 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 SMF (service) instance ID towards which the request is redirected |
6.1.3.6.4.3 Operation: release
6.1.3.6.4.3.1 Description
6.1.3.6.4.3.2 Operation Definition
This custom operation releases an individual PDU session resource in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF.
This operation shall support the request data structures specified in table 6.1.3.6.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.3.2-2.
Table 6.1.3.6.4.3.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
ReleaseData |
C |
0..1 |
Representation of the data to be sent to the H-SMF or SMF when releasing the PDU session. |
Table 6.1.3.6.4.3.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
ReleasedData |
M |
1 |
200 OK |
Successful release of a PDU session context, when information needs to be returned to the NF Service Consumer. (NOTE 2) |
n/a |
204 No Content |
Successful release of a PDU session. |
||
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 (H-)SMF or (H-)SMF (service) set. (NOTE 3) |
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, he URI shall be an alternative URI of the resource located on an alternative service instance within the same (H-)SMF or (H-)SMF (service) set. (NOTE 3) |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: The support for 200 OK shall be dependent on the support of the indicated feature. NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.6.4.4 Operation: transfer-mo-data
6.1.3.6.4.4.1 Description
6.1.3.6.4.4.2 Operation Definition
This custom operation enables to transfer mobile originated data received from AMF, for a given PDU session, towards the H-SMF for HR roaming scenarios, or the SMF for a PDU session with an I-SMF.
This operation shall support the request data structures specified in table 6.1.3.6.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.4.2-2.
Table 6.1.3.6.4.4.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
TransferMoDataReqData |
M |
1 |
Representation of the payload of a Transfer MO Data Request |
Table 6.1.3.6.4.4.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful MO data transfer |
||
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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, he URI shall be an alternative URI of the resource located on an alternative service instance within the same (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.6.4.5 Operation: retrieve
6.1.3.6.4.5.1 Description
6.1.3.6.4.5.2 Operation Definition
This custom operation retrieves information from an individual PDU session context in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF.
This operation shall support the request data structures specified in table 6.1.3.6.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.5.2-2.
Table 6.1.3.6.4.5.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
RetrieveData |
M |
1 |
Representation of the payload of a Retrieve Request |
Table 6.1.3.6.4.5.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
RetrievedData |
M |
1 |
200 OK |
Successful retrieval of information from a PDU session 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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 (H-)SMF or (H-)SMF (service) set. (NOTE 2) |
ProblemDetails |
O |
0..1 |
504 Gateway Timeout |
The "cause" attribute may be set to one of the following application errors: – UPF_NOT_RESPONDING See table 6.1.7.3-1 for the description of these errors. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.6.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.7 Resource: Individual PDU session (V-SMF or I-SMF)
6.1.3.7.1 Description
This resource represents an individual PDU session created in the V-SMF for a HR PDU session or in the I-SMF for a PDU session with an I-SMF.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.1.3.7.2 Resource Definition
Callback URI: {vsmfPduSessionUri} or {ismfPduSessionUri}
This resource shall support the callback URI variables defined in table 6.1.3.7.2-1.
Table 6.1.3.7.2-1: Callback URI variables for this resource
Name |
Data type |
Definition |
vsmfPduSessionUri |
Uri |
PDU session reference assigned by the V-SMF during the Create service operation. |
ismfPduSessionUri |
Uri |
PDU session reference assigned by the I-SMF during the Create service operation. |
6.1.3.7.3 Resource Standard Methods
6.1.3.7.3.1 POST
This method sends a status notification to the NF Service Consumer.
This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1.
Table 6.1.3.7.3.1-1: URI query parameters supported by the 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.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 POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
StatusNotification |
M |
1 |
Representation of the status notification. |
Table 6.1.3.7.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful notification of status change |
||
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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.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 SMF or SMF (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 SMF (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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
6.1.3.7.4 Resource Custom Operations
6.1.3.7.4.1 Overview
Table 6.1.3.7.4.1-1: Custom operations
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
modify |
{vsmfPduSessionUri}/modify or {ismfPduSessionUri}/modify |
POST |
Update service operation (initiated by H-SMF or SMF) |
transfer-mt-data |
{vsmfPduSessionUri}/transfer-mt-data or {ismfPduSessionUri}/transfer-mt-data |
POST |
Transfer MT Data service operation |
6.1.3.7.4.2 Operation: modify
6.1.3.7.4.2.1 Description
6.1.3.7.4.2.2 Operation Definition
This custom operation modifies an individual PDU session resource in the V-SMF for a HR PDU session or in the I-SMF for a PDU session with an I-SMF.
This operation shall support the request data structures specified in table 6.1.3.7.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.7.4.2.2-2.
Table 6.1.3.7.4.2.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
VsmfUpdateData |
M |
1 |
Representation of the updates to apply to the PDU session. |
Table 6.1.3.7.4.2.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
VsmfUpdatedData |
M |
1 |
200 OK |
This case represents a successful update of the PDU session, when the V-SMF or I-SMF needs to return information in the response. |
n/a |
204 No Content |
This case represents a successful update of the PDU session, when the V-SMF or I-SMF does not need to return information in the response. |
||
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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
VsmfUpdateError |
M |
1 |
400 Bad Request |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
VsmfUpdateError |
M |
1 |
403 Forbidden |
The "cause" attribute shall be set to one of the following application errors: – N1_SM_ERROR – UNABLE_TO_PAGE_UE – UE_NOT_RESPONDING – REJECTED_BY_UE – REJECTED_DUE_VPLMN_POLICY – HO_TAU_IN_PROGRESS – EBI_EXHAUSTED – EBI_REJECTED_LOCAL_POLICY, if the EBI allocation was 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]. 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). |
VsmfUpdateError |
M |
1 |
404 Not Found |
The "cause" attribute shall be set to one of the following application error: – CONTEXT_NOT_FOUND See table 6.1.7.3-1 for the description of these errors. |
VsmfUpdateError |
O |
0..1 |
409 Conflict |
The "cause" attribute may be used to indicate one of the following application errors: – HIGHER_PRIORITY_REQUEST_ONGOING; – UE_IN_CM_IDLE_STATE See table 6.1.7.3-1 for the description of these errors. |
VsmfUpdateError |
M |
1 |
500 Internal Server Error |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
VsmfUpdateError |
M |
1 |
503 Service Unavailable |
The "cause" attribute shall 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. As an exception, this error may also be returned by an SMF, with an empty payload body, for a general server error other than those specified for the SMF PDUSession service logic. |
VsmfUpdateError |
M |
1 |
504 Gateway Timeout |
The "cause" attribute shall be set to one of the following application errors: – PEER_NOT_RESPONDING – NETWORK_FAILURE 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 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.7.4.2.2-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. 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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.7.4.2.2-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. 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 SMF (service) instance ID towards which the request is redirected |
6.1.3.7.4.3 Operation: transfer-mt-data
6.1.3.7.4.3.1 Description
This custom operation enables to transfer mobile terminated data received from NEF, for a given PDU session, towards the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF.
6.1.3.7.4.3.2 Operation Definition
This operation shall support the request data structures specified in Table 6.1.3.7.4.3.2-1 and the response data structure and response codes specified in Table 6.1.3.7.4.3.2-2.
Table 6.1.3.7.4.3.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
TransferMtDataReqData |
M |
1 |
Representation of the payload of a Transfer MT Data Request |
Table 6.1.3.7.4.3.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful MT data transfer |
||
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 SMF or SMF (service) set. (NOTE 2) |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if 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 SMF or SMF (service) set. (NOTE 2) |
TransferMtDataError |
M |
1 |
504 Gateway Timeout |
The "cause" attribute may be used to indicate the following application errors: – UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; Estimated Maximum Waiting Time shall be included if available; See table 6.1.7.3-1 for the description of these errors. |
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
Table 6.1.3.7.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.7.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 SMF or SMF (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 SMF (service) instance ID towards which the request is redirected |