Name | Data type | Definition |
---|---|---|
apiRoot | string | See clause 6.1.1. |
pduSessionRef | string | PDU session reference assigned by the H-SMF or SMF during the Create service operation. |
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 |
Data type | P | Cardinality | Description |
---|---|---|---|
HsmfUpdateData | M | 1 | Representation of the updates to apply to the PDU session. |
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. (NOTE 2) |
RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (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 TS 29.500. |
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 content, 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:
|
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 content, 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:
|
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 TS 29.500. |
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 content, 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 TS 29.500 or to one of the following application 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 content, 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 TS 29.500 other than those specified in the Table above also apply, with a ProblemDetails data type (see clause 5.2.7 of TS 29.500).
NOTE 2:
RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of TS 29.500.
|
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
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. |
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. (NOTE 3) |
RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 3) |
NOTE 1:
The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of TS 29.500 other than those specified in the Table above also apply, with a ProblemDetails data type (see clause 5.2.7 of TS 29.500).
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 or SEPP, see clause 6.10.9.1 of TS 29.500.
|
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Data type | P | Cardinality | Description |
---|---|---|---|
TransferMoDataReqData | M | 1 | Representation of the content of a Transfer MO Data Request |
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. (NOTE 2) |
RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) |
NOTE 1:
The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of TS 29.500 other than those specified in the Table above also apply, with a ProblemDetails data type (see clause 5.2.7 of TS 29.500).
NOTE 2:
RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of TS 29.500.
|
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Data type | P | Cardinality | Description |
---|---|---|---|
RetrieveData | M | 1 | Representation of the content of a Retrieve Request |
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. (NOTE 2) |
RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) |
ProblemDetails | O | 0..1 | 504 Gateway Timeout |
The "cause" attribute may be set to one of the following application errors:
|
NOTE 1:
The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of TS 29.500 other than those specified in the Table above also apply, with a ProblemDetails data type (see clause 5.2.7 of TS 29.500).
NOTE 2:
RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of TS 29.500.
|
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |
Name | Data type | P | Cardinality | Description |
---|---|---|---|---|
Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in TS 29.500. |
3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected. |