6 API Definitions
29.5323GPP5G Multicast-Broadcast Session Management Services5G SystemRelease 17Stage 3TS
6.1 Nmbsmf_TMGI Service API
6.1.1 Introduction
The Nmbsmf_TMGI service shall use the Nmbsmf_TMGI API.
The API URI of the Nmbsmf_TMGI API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "nmbsmf-tmgi".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
6.1.2 Usage of HTTP
6.1.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Nmbsmf_TMGI API is contained in Annex A.
6.1.2.2 HTTP standard headers
6.1.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
6.1.2.2.2 Content type
JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
6.1.2.3 HTTP custom headers
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
6.1.3 Resources
6.1.3.1 Overview
Figure 6.1.3.1-1 describes the resource URI structure of the Nmbsmf_TMGI API.
Figure 6.1.3.1-1: Resource URI structure of the Nmbsmf_TMGI API
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
|
Resource purpose/name |
Resource URI (relative path after API URI) |
HTTP method or custom operation |
Description (service operation) |
|
|
TMGI collection |
/tmgi |
POST |
Allocate |
|
|
DELETE |
Deallocate |
6.1.3.2 Resource: TMGI collection
6.1.3.2.1 Description
This resource represents the collection of the individual TMGI values that can be assigned by the MB-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}/nmbsmf-tmgi/<apiVersion>/tmgi
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.1.1 |
6.1.3.2.3 Resource Standard Methods
6.1.3.2.3.1 POST
This method requests the MB-SMF to allocate one or more TMGIs with Nmbsmf_TMGI_Allocate service operation.
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TmgiAllocate |
M |
1 |
Representation of one or more TMGIs to be allocated by the MB-SMF. The Request Body shall contain: – the requested number of TMGIs (one or more), if TMGIs are requested to be allocated; or – a list of TMGIs, if the expiration time of previously allocated TMGI(s) needs to be refreshed. |
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 |
|
TmgiAllocated |
C |
1 |
200 OK |
Successful allocation of one or more TMGI(s) and their expiration time. Alternatively, if the expiration time of the previously allocated TMGI(s) needs to be refreshed, the Response Body shall contain the list of the TMGI(s) and their new expiration time. |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
When used to represent an unsuccessful TMGI allocation or TMGI refreshment, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – MANDATORY_IE_INCORRECT, if the required TMGI number for TMGI allocation is not valid. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful TMGI allocation or TMGI refreshment, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_TMGI, if the TMGI to be refreshed is expired or not found in the MB-SMF. |
|
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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: 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 POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.1.3.2.3.1-5: Headers supported by the 200 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.1.3.2.3.1-6: Links supported by the 200 Response Code on this endpoint
|
Name |
Resource name |
HTTP method or custom operation |
Link parameter(s) |
Description |
Table 6.1.3.2.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.3.1-8: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.1.3.2.3.2 DELETE
This method deallocates one or more of the previously allocated individual TMGIs in the MB-SMF with Nmbsmf_TMGI_Deallocate service operation.
This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1.
Table 6.1.3.2.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tmgi-list |
array(Tmgi) |
M |
1..N |
The list of the TMGIs, which shall be deallocated by MB-SMF. |
This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3.
Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.1.3.2.3.2-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
This case represents a successful deletion of TMGI list. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful deletion of TMGI, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_TMGI, if the TMGI to be deleted is not found in MB-SMF. |
|
NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: 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.2-4: Headers supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.1.3.2.3.2-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 MB-SMF or MB-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 NF (service) instance ID towards which the request is redirected |
Table 6.1.3.2.3.2-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 MB-SMF or MB-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 NF (service) instance ID towards which the request is redirected |
6.1.3.2.4 Resource Custom Operations
None.
6.1.4 Custom Operations without associated resources
None.
6.1.5 Notifications
None.
6.1.6 Data Model
6.1.6.1 General
This clause specifies the application data model supported by the API.
Table 6.1.6.1-1 specifies the data types defined for the Nmbsmf_TMGI service based interface protocol.
Table 6.1.6.1-1: Nmbsmf_TMGI specific Data Types
|
Data type |
Clause defined |
Description |
Applicability |
|
TmgiAllocate |
6.1.6.2.2 |
TMGI Allocation Request Payload. |
|
|
TmgiAllocated |
6.1.6.2.3 |
TMGI Allocation Response Payload. |
Table 6.1.6.1-2 specifies data types re-used by the Nmbsmf_TMGI service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmbsmf service based interface.
Table 6.1.6.1-2: Nmbsmf_TMGI re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
Tmgi |
3GPP TS 29.571 [18] |
TMGI |
|
|
DateTime |
3GPP TS 29.571 [18] |
Date and time |
|
|
Nid |
3GPP TS 29.571 [18] |
NID, which is used in SNPN scenarios |
6.1.6.2 Structured data types
6.1.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.1.6.2.2 Type: TmgiAllocate
Table 6.1.6.2.2-1: Definition of type TmgiAllocate
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tmgiNumber |
integer |
C |
0..1 |
This IE shall be present if TMGI allocation is requested. When present, this IE shall indicate the number of TMGIs requested to be allocated. Minimum: 1. Maximum: 255. |
|
|
tmgiList |
array(Tmgi) |
C |
1..N |
This IE shall be present if the expiration time of previously allocated TMGIs needs to be refreshed. When present, this IE shall contain the list of TMGI(s) to be refreshed. |
6.1.6.2.3 Type: TmgiAllocated
Table 6.1.6.2.3-1: Definition of type TmgiAllocated
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tmgiList |
array(Tmgi) |
M |
1..N |
One or more TMGIs allocated by MB-SMF. (NOTE) |
|
|
expirationTime |
DateTime |
M |
1 |
Expiration time for the allocated TMGI(s). (NOTE) |
|
|
nid |
Nid |
O |
0..1 |
When present, this IE shall contain the NID, which together with the PLMN ID included in the TMGIs, identifies the SNPN which allocated the TMGIs. (see 3GPP TS 23.003 [7] and 3GPP TS 23.501 [8] clause 5.30.2.1). |
|
|
NOTE: This attribute is necessary if the MB-SMF allocates TMGI(s) and also if the MB-SMF refreshes the expiration time of earlier allocated TMGIs. |
|||||
6.1.6.3 Simple data types and enumerations
6.1.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.1.6.3.2 Simple data types
The Nmbsmf_TMGI API does not define any simple data types in this release of the specification.
Table 6.1.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
6.1.6.3.3 Enumeration: <EnumType1>
The Nmbsmf_TMGI API does not define any enumerations in this release of the specification.
6.1.6.3.4 Void
6.1.6.4 Data types describing alternative data types or combinations of data types
None.
6.1.6.5 Binary data
None.
6.1.7 Error Handling
6.1.7.1 General
For the Nmbsmf_TMGI API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
In addition, the requirements in the following clauses are applicable for the Nmbsmf_TMGI API.
6.1.7.2 Protocol Errors
No specific procedures for the Nmbsmf_TMGI service are specified.
6.1.7.3 Application Errors
The application errors defined for the Nmbsmf_TMGI service are listed in Table 6.1.7.3-1.
Table 6.1.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
|
UNKNOWN_TMGI |
404 Not Found |
The requested TMGI Allocate or TMGI Deallocate service operation failed, because requested TMGI expired or cannot be found. |
6.1.8 Feature negotiation
The optional features in table 6.1.8-1 are defined for the Nmbsmf_TMGI API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 6.1.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
6.1.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmbsmf_TMGI API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmbsmf_TMGI API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmbsmf_TMGI service.
The Nmbsmf_TMGI API defines a single scope "nmbsmf-tmgi" for the entire service, and it does not define any additional scopes at resource or operation level.
6.1.10 HTTP redirection
An HTTP request may be redirected to a different MB-SMF service instance, within the same MB-SMF or a different MB-SMF of an MB-SMF set, e.g. when an MB-SMF service instance is part of an MB-SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]).
An SCP that reselects a different MB-SMF producer instance will return the NF Instance ID of the new MB-SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
If an MB-SMF within an MB-SMF set redirects a service request to a different MB-SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MB-SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
6.2 Nmbsmf_MBSSession Service API
6.2.1 Introduction
The Nmbsmf_MBSSession shall use the Nmbsmf_MBSSession API.
The API URI of the Nmbsmf_MBSSession API shall be:
{apiRoot}/<apiName>/<apiVersion>/
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "nmbsmf_mbssession".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 5.3.
6.2.2 Usage of HTTP
6.2.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Nmbsmf_MBSSession API is contained in Annex A.
6.2.2.2 HTTP standard headers
6.2.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
6.2.2.2.2 Content type
The following content types shall be supported:
– JSON, as defined in IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
– The "Problem Details" JSON object, as defined in IETF RFC 7807 [13], shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json".
Multipart messages shall also be supported (see clause 6.2.2.4) using the content type "multipart/related", comprising:
– one JSON body part with the "application/json" content type; and
– one binary body part with 3gpp vendor specific content subtypes.
The 3gpp vendor specific content subtypes defined in Table 6.5.2.2.2-1 shall be supported.
Table 6.2.2.2.2-1: 3GPP vendor specific content subtypes
|
content subtype |
Description |
|
vnd.3gpp.ngap |
Binary encoded payload, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [20] (ASN.1 encoded). |
|
NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (i.e. NGAP information) without having to rely on metadata in the JSON payload. |
|
See clause 6.2.2.4 for the binary payloads supported in the binary body part of multipart messages.
6.2.2.3 HTTP custom headers
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
6.2.2.4 HTTP multipart messages
HTTP multipart messages shall be supported, to transfer opaque N2 Information in the following service operations (and HTTP messages):
– ContextUpdate Request and Response (POST).
HTTP multipart messages shall include one JSON body part and one binary body parts comprising:
– N2 MBS Session Management information (see clause 6.2.6.5).
The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included.
The multipart message shall include a "type" parameter (see IETF RFC 2387 [21]) specifying the media type of the root body part, i.e. "application/json".
NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [21]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message.
For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [22]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part.
6.2.3 Resources
6.2.3.1 Overview
Figure 6.2.3.1-1 describes the resource URI structure of the Nmbsmf_MBSSession API.
Figure 6.2.3.1-1: Resource URI structure of the Nmbsmf_MBSSession API
Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.2.3.1-1: Resources and methods overview
|
Resource name |
Resource URI (relative path under API URI) |
HTTP method or custom operation |
Description (service operation) |
|
MBS sessions collection |
/mbs-sessions |
POST |
Create |
|
/mbs-sessions/contexts/update |
update (POST) |
ContextUpdate |
|
|
Individual MBS session |
/mbs-sessions/{mbsSessionRef} |
PATCH |
Update |
|
DELETE |
Delete |
||
|
Subscriptions collection for MBS sessions |
/mbs-sessions/subscriptions |
POST |
StatusSubscribe (to create a subscription) (NOTE 1, NOTE 2) |
|
Individual subscription for an MBS session |
/mbs-sessions/subscriptions/{subscriptionId} |
PATCH |
StatusSubscribe (to update or renew a subscription) |
|
DELETE |
StatusUnsubscribe |
||
|
Subscriptions collection for MBS contexts |
/mbs-sessions/contexts/subscriptions |
POST |
ContextStatusSubscribe (to create a subscription) (NOTE 2) |
|
Individual subscription for an MBS context |
/mbs-sessions/contexts/subscriptions/{subscriptionId} |
PATCH |
ContextStatusSubscribe (to update or renew a subscription) |
|
DELETE |
ContextStatusUnsubscribe |
||
|
NOTE 1: A subscription to an MBS session may be performed after the MBS session is created using the POST method on this resource, or alternatively during the creation of the MBS session. NOTE 2: The StatusNotify and ContextStatusNotify service operations are defined in clause 6.2.6.1. |
|||
6.2.3.2 Resource: MBS sessions collection (Collection)
6.2.3.2.1 Description
This resource represents the collection of the individual MBS sessions created in the MB-SMF.
This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.2.3.2.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions
This resource shall support the resource URI variables defined in table 6.2.3.2.2-1.
Table 6.2.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
6.2.3.2.3 Resource Standard Methods
6.2.3.2.3.1 POST
This method creates an individual MBS session resource in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3.
Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
CreateReqData |
M |
1 |
Representation of the MBS session to be created in the MB-SMF |
Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
CreateRspData |
M |
1 |
201 Created |
Successful creation of an MBS 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – INVALID_MBS_SERVICE_INFO, if the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – FILTER_RESTRICTIONS_NOT_RESPECTED, if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – ERROR_INPUT_PARAMETERS, if the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) |
|
ExtProblemDetails |
O |
0..1 |
403 Forbidden |
When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – MBS_SESSION_ALREADY_CREATED, if MBS session to be created has already been created in the MB-SMF. – OVERLAPPING_MBS_SERVICE_AREA, if the new MBS service area overlaps with the service area of any MBS session with the same MBS session identifier. – MBS_SERVICE_INFO_NOT_AUTHORIZED, if the provided MBS Service Information is not authorized to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – MBS_POLICY_CONTEXT_DENIED, if the request is rejected due to operator policies and/or local configuration, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_TMGI, if the TMGI indicated in the mbsSessionId IE is not found in the MB-SMF. |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.2.3.1-4: Headers supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.2.3.1-5: Headers supported by the 201 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/{mbsSessionRef} |
Table 6.2.3.2.3.1-6: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.2.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.2.4 Resource Custom Operations
6.2.3.2.4.1 Overview
Table 6.2.3.2.4.1-1: Custom operations
|
Operation name |
Custom operaration URI |
Mapped HTTP method |
Description |
|
update |
/mbs-sessions/contexts/update |
POST |
ContextUpdate service operation |
6.2.3.2.4.2 Operation: update
6.2.3.2.4.2.1 Description
See clause 5.3.2.5.1.
6.2.3.2.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.2.2-2.
Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ContextUpdateReqData |
M |
1 |
Data within the ContextUpdate Request |
Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ContextUpdateRspData |
M |
1 |
200 OK |
Data in the ContextUpdate Response |
|
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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful MBS session context update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_TMGI, if the TMGI provided in the request does not exist in the MB-SMF. – UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF. – UNKNOWN_MBS_SERVICE_AREA, if the MBS service area in the request cannot be found. |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.2.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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.3 Resource: Individual MBS session (Document)
6.2.3.3.1 Description
This resource represents an individual MBS session created in the MB-SMF.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.2.3.3.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/{mbsSessionRef}
This resource shall support the resource URI variables defined in table 6.2.3.3.2-1.
Table 6.2.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
|
mbsSessionRef |
string |
MBS session reference assigned by the MB-SMF during the Create service operation |
6.2.3.3.3 Resource Standard Methods
6.2.3.3.3.1 PATCH
This method updates an individual MBS session resource in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3.
Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
array(PatchItem) |
M |
1 |
List of changes to be made to the MBS session resource (i.e. ExtMbsSession data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. |
Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – INVALID_MBS_SERVICE_INFO, if the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization, e.g if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – FILTER_RESTRICTIONS_NOT_RESPECTED, if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – ERROR_INPUT_PARAMETERS, if the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) |
|
ExtProblemDetails |
O |
0..1 |
403 Forbidden |
When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – MBS_SERVICE_INFO_NOT_AUTHORIZED, if the provided MBS Service Information is not authorized to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) – MBS_POLICY_CONTEXT_DENIED, if the request is rejected due to operator policies and/or local configuration, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23]) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF. – UNKNOWN_MBS_SERVICE_AREA, if the indicated MBS service area is not found. |
|
NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.3.3.2 DELETE
This method deletes an individual MBS session resource in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1.
Table 6.2.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3.
Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful MBS session delete, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF. |
|
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.3.4 Resource Custom Operations
None.
6.2.3.4 Resource: Subscriptions collection for MBS sessions (Collection)
6.2.3.4.1 Description
This resource represents the collection of the individual subscriptions for MBS sessions that are created in the MB-SMF with StatusSubscribe service operation.
This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.2.3.4.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/subscriptions
This resource shall support the resource URI variables defined in table 6.2.3.4.2-1.
Table 6.2.3.4.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
6.2.3.4.3 Resource Standard Methods
6.2.3.4.3.1 POST
This method creates an individual subscription resource for an MBS session in the MB-SMF with StatusSubscribe service operation.
This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1.
Table 6.2.3.4.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3.
Table 6.2.3.4.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
StatusSubscribeReqData |
M |
1 |
Data within the StatusSubscribe Request |
Table 6.2.3.4.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
StatusSubscribeRspData |
M |
1 |
201 Created |
Data within the StatusSubscribe 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful subscription to MBS session, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF. – UNKNOWN_MBS_SERVICE_AREA, if the requested MBS service area is not found. |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.4.3.1-4: Headers supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.4.3.1-5: Headers supported by the 201 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/subscriptions/{subscriptionId} |
Table 6.2.3.4.3.1-6: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.4.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.4.4 Resource Custom Operations
None.
6.2.3.5 Resource: Individual subscription for an MBS session (Document)
6.2.3.5.1 Description
This resource represents an individual subscription for an MBS session in the MB-SMF, which are updated with StatusSubscribe service operation, or are deleted with StatusUnsubscribe service operation.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.2.3.5.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.2.3.5.2-1.
Table 6.2.3.5.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
|
subscriptionId |
string |
Subscription identifier assigned by the MB-SMF during the creation of the subscription |
6.2.3.5.3 Resource Standard Methods
6.2.3.5.3.1 PATCH
This method updates an individual subscription resource for an MBS session in the MB-SMF with StatusSubscribe service operation for the subscription update (see clause 5.3.2.6.3).
This method shall support the URI query parameters specified in table 6.2.3.5.3.1-1.
Table 6.2.3.5.3.1-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.1-3.
Table 6.2.3.5.3.1-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
array(PatchItem) |
M |
1 |
It shall contain the list of changes to be made to the Status Subscription (i.e. MbsSessionSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. |
Table 6.2.3.5.3.1-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
MbsSessionSubscription |
M |
1 |
200 OK |
Upon success, a response body shall be returned containing the updated Status 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.5.3.1-4: Headers supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.5.3.1-5: Headers supported by the 200 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.5.3.1-6: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.5.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.5.3.2 DELETE
This method deletes an individual subscription resource for an MBS session in the MB-SMF with StatusUnsubscribe service operation.
This method shall support the URI query parameters specified in table 6.2.3.5.3.2-1.
Table 6.2.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.5.3.2-2 and the response data structures and response codes specified in table 6.2.3.5.3.2-3.
Table 6.2.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.5.3.2-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful deletion |
||
|
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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.5.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.5.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.5.4 Resource Custom Operations
None.
6.2.3.6 Resource: Subscriptions collection for MBS contexts (Collection)
6.2.3.6.1 Description
This resource represents the collection of the individual subscriptions for MBS contexts created in the MB-SMF.
This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.2.3.6.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/contexts/subscriptions
This resource shall support the resource URI variables defined in table 6.2.3.6.2-1.
Table 6.2.3.6.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
6.2.3.6.3 Resource Standard Methods
6.2.3.6.3.1 POST
This method creates an individual subscription resource for an MBS context in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1.
Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3.
Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ContextStatusSubscribeReqData |
M |
1 |
Data within the ContextStatusSubscribe Request |
Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ContextStatusSubscribeRspData |
M |
1 |
201 Created |
Data within the ContextStatusSubscribe 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
When used to represent an unsuccessful subscription to MBS session context, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes: – UNKNOWN_MBS_SESSION, if indicated the MBS session is not found in the MB-SMF. |
|
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.6.3.1-4: Headers supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.6.3.1-5: Headers supported by the 201 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/contexts/subscriptions/{subscriptionId} |
Table 6.2.3.6.3.1-6: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.6.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.6.4 Resource Custom Operations
None.
6.2.3.7 Resource: Individual subscription for an MBS context (Document)
6.2.3.7.1 Description
This resource represents an individual subscription for an MBS context created in the MB-SMF.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.2.3.7.2 Resource Definition
Resource URI: {apiRoot}/nmbsmf-mbssession/<apiVersion>/mbs-sessions/contexts/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.2.3.7.2-1.
Table 6.2.3.7.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
|
subscriptionId |
string |
Subscription identifier assigned by the MB-SMF during the creation of the subscription |
6.2.3.7.3 Resource Standard Methods
6.2.3.7.3.1 PATCH
This method modifies an individual subscription resource for an MBS context in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1.
Table 6.2.3.7.3.1-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3.
Table 6.2.3.7.3.1-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
array(PatchItem) |
M |
1 |
It shall contain the list of changes to be made to the Context Status Subscription (i.e. ContextStatusSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. |
Table 6.2.3.7.3.1-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ContextStatusSubscription |
M |
1 |
200 OK |
Upon success, a response body shall be returned containing the updated Context Status 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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.7.3.1-4: Headers supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.7.3.1-5: Headers supported by the 200 response code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Table 6.2.3.7.3.1-6: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.7.3.1-7: 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 MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.7.3.2 DELETE
This method deletes an individual subscription resource for an MBS context in the MB-SMF.
This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1.
Table 6.2.3.7.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3.
Table 6.2.3.7.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.7.3.2-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful deletion |
||
|
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 MB-SMF or MB-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 MB-SMF or MB-SMF (service) set. (NOTE 2) |
|
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. |
||||
Table 6.2.3.7.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
Table 6.2.3.7.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-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 MB-SMF (service) instance ID towards which the request is redirected |
6.2.3.7.4 Resource Custom Operations
None.
6.2.4 Custom Operations without associated resources
None
6.2.5 Notifications
6.2.5.1 General
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 6.2.5.1-1: Notifications overview
|
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
|
Status Notification |
{notifURI} |
POST |
StatusNotify |
|
Context Status Notification |
{notificationURI} |
POST |
ContextStatusNotify |
6.2.5.2 StatusNotify
6.2.5.2.1 Description
The Event Notification is used by the MB-SMF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications.
6.2.5.2.2 Target URI
The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.2.5.2.2-1.
Table 6.2.5.2.2-1: Callback URI variables
|
Name |
Definition |
|
notifUri |
String formatted as URI with the Callback Uri |
6.2.5.2.3 Standard Methods
6.2.5.2.3.1 POST
This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2.
Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body
|
Data type |
P |
Cardinality |
Description |
|
StatusNotifyReqData |
M |
1 |
Data within the StatusNotify Request |
Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful response |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. 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 consumer to which the notification should be sent. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. 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 consumer to which the notification should be sent. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.5.3 ContextStatusNotify
6.2.5.3.1 Description
The Event Notification is used by the MB-SMF to report one or several observed Events to a NF Service Consumer that has subscribed to such notifications.
6.2.5.3.2 Target URI
The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.2.5.3.2-1.
Table 6.2.5.3.2-1: Callback URI variables
|
Name |
Definition |
|
notifUri |
String formatted as URI with the Callback URI |
6.2.5.3.3 Standard Methods
6.2.5.3.3.1 POST
This method shall support the request data structures specified in table 6.2.5.3.3.1-1 and the response data structures and response codes specified in table 6.2.5.3.3.1-2.
Table 6.2.5.3.3.1-1: Data structures supported by the POST Request Body
|
Data type |
P |
Cardinality |
Description |
|
ContextStatusNotifyReqData |
M |
1 |
Data within the ContextStatusNotify Request |
Table 6.2.5.3.3.1-2: Data structures supported by the POST Response Body
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful response |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. 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 consumer to which the notification should be sent. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. 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 consumer to which the notification should be sent. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.5.3.3.1-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.5.3.3.1-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.6 Data Model
6.2.6.1 General
This clause specifies the application data model supported by the API.
Table 6.2.6.1-1 specifies the data types defined for the Nmbsmf_MBSSession service based interface protocol.
Table 6.2.6.1-1: Nmbsmf_MBSSession specific Data Types
|
Data type |
Clause defined |
Description |
Applicability |
|
CreateReqData |
6.2.6.2.2 |
Data within the Create Request |
|
|
CreateRspData |
6.2.6.2.3 |
Data within the Create Response |
|
|
MbsSessionExtension |
6.2.6.2.4 |
MB-SMF API specific MbsSession data type extensions |
|
|
ContextUpdateReqData |
6.2.6.2.5 |
Data within the ContexUpdate Request |
|
|
ContextUpdateRspData |
6.2.6.2.6 |
Data within the ContextUpdate Response |
|
|
StatusSubscribeReqData |
6.2.6.2.7 |
Data within the Create Subscription Request for the collection of MBS Session subscriptions (StatusSubscribe service operation). |
|
|
StatusSubscribeRspData |
6.2.6.2.8 |
Data within the Create Subscription Response (StatusSubscribe service operation). |
|
|
N2MbsSmInfo |
6.2.6.2.9 |
N2 MBS Session Management Information |
|
|
ContextStatusNotifyReqData |
6.2.6.2.10 |
Data within ContextStatusNotify Request |
|
|
StatusNotifyReqData |
6.2.6.2.11 |
Data within StatusNotify Request |
|
|
ContextStatusSubscribeReqData |
6.2.6.2.12 |
Data within ContextStatusSubscribe Request |
|
|
ContextStatusSubscription |
6.2.6.2.13 |
Context Status Subscription |
|
|
ContextStatusEvent |
6.2.6.2.14 |
Context Status Event |
|
|
ContextStatusSubscribeRspData |
6.2.6.2.15 |
Data within ContextStatusSubscribe Response |
|
|
MbsContextInfo |
6.2.6.2.16 |
MBS Context Information |
|
|
ContextStatusEventReport |
6.2.6.2.17 |
Context Status Event Report |
|
|
MulticastTransportAddressChangeInfo |
6.2.6.2.18 |
Multicast Transport Address Change Information |
|
|
QosInfo |
6.2.6.2.19 |
QoS Information |
|
|
QosFlowAddModifyRequestItem |
6.2.6.2.20 |
Individual MBS QoS flow requested to be created or modified |
|
|
QosFlowProfile |
6.2.6.2.21 |
MBS QoS flow profile |
|
|
GbrQosFlowInformation |
6.2.6.2.22 |
GBR MBS QoS flow information |
|
|
ProblemDetailsExtension |
6.2.6.2.23 |
Extensions to the ProblemDetails common data |
|
|
ContextUpdateAction |
6.2.6.3.3 |
The requested action for the MBS session context |
|
|
ContextStatusEventType |
6.2.6.3.4 |
Context Status Event Type |
|
|
ReportingMode |
6.2.6.3.5 |
Reporting Mode |
|
|
NgapIeType |
6.2.6.3.6 |
NGAP Information Element Type |
|
|
ExtMbsSession |
6.2.6.4.1 |
MbsSession common data type extended with MB-SMF API specific extensions |
|
|
ExtProblemDetails |
6.2.6.4.2 |
ProblemDetails common data type with extensions |
Table 6.2.6.1-2 specifies data types re-used by the Nmbsmf_MBSSession service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmbsmf_MBSSession service based interface.
Table 6.2.6.1-2: Nmbsmf_MBSSession re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
MbsSession |
3GPP TS 29.571 [18] |
MBS session |
|
|
Tmgi |
3GPP TS 29.571 [18] |
TMGI |
|
|
TunnelAddress |
3GPP TS 29.571 [18] |
Tunnel Address (UDP/IP) |
|
|
MbsSessionId |
3GPP TS 29.571 [18] |
MBS Session Identifier |
|
|
AreaSessionId |
3GPP TS 29.571 [18] |
Area Session Identifier used for MBS session with location dependent content |
|
|
Ssm |
3GPP TS 29.571 [18] |
Source specific IP multicast address |
|
|
Uint32 |
3GPP TS 29.571 [18] |
Unsigned 32-bit integer |
|
|
NfInstanceId |
3GPP TS 29.571 [18] |
NF Instance Identifier |
|
|
Bytes |
3GPP TS 29.571 [18] |
Base64-encoded characters |
|
|
RefToBinaryData |
3GPP TS 29.571 [18] |
Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message |
|
|
GlobalRanNodeId |
3GPP TS 29.571 [18] |
Global RAN Node Identity |
|
|
DateTime |
3GPP TS 29.571 [18] |
Date and time |
|
|
Uri |
3GPP TS 29.571 [18] |
URI |
|
|
DateTime |
3GPP TS 29.571 [18] |
Date and Time |
|
|
MbsSessionActivityStatus |
3GPP TS 29.571 [18] |
MBS Session Activity Status |
|
|
MbsServiceArea |
3GPP TS 29.571 [18] |
MBS Service Area |
|
|
MbsServiceAreaInfo |
3GPP TS 29.571 [18] |
MBS Service Area Information for a location dependent MBS session |
|
|
MbsSessionSubscription |
3GPP TS 29.571 [18] |
MBS Session Subscription |
|
|
MbsSessionEventReportList |
3GPP TS 29.571 [18] |
MBS Session Event Report List |
|
|
Qfi |
3GPP TS 29.571 [13] |
QoS Flow Identifier |
|
|
Arp |
3GPP TS 29.571 [13] |
Allocation and Retention Priority |
|
|
Dynamic5Qi |
3GPP TS 29.571 [13] |
QoS characteristics for a 5QI that is neither standardized nor pre-configured. |
|
|
NonDynamic5Qi |
3GPP TS 29.571 [13] |
QoS characteristics that replace the default QoS characteristics for a standardized or pre-configured 5QI. |
|
|
5Qi |
3GPP TS 29.571 [13] |
5G QoS Identifier |
|
|
BitRate |
3GPP TS 29.571 [13] |
Bit rate |
|
|
PacketLossRate |
3GPP TS 29.571 [13] |
Packet loss rate |
|
|
MbsSecurityContext |
3GPP TS 29.571 [18] |
MBS Security Context |
|
|
AcceptableMbsServInfo |
3GPP TS 29.537 [23] |
MBS Service Information that can be accepted by the PCF |
6.2.6.2 Structured data types
6.2.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.2.6.2.2 Type: CreateReqData
Table 6.2.6.2.2-1: Definition of type CreateReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
mbsSession |
ExtMbsSession |
M |
1 |
MBS session to be created |
6.2.6.2.3 Type: CreateRspData
Table 6.2.6.2.3-1: Definition of type CreateRspData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
mbsSession |
ExtMbsSession |
M |
1 |
Representation of the created MBS session |
|
|
eventList |
MbsSessionEventReportList |
C |
0..1 |
Event reports, if corresponding information is available. |
6.2.6.2.4 Type: MbsSessionExtension
Table 6.2.6.2.4-1: Definition of type MbsSessionExtension
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
mbsSecurityContext |
MbsSecurityContext |
O |
0..1 |
This IE may be present if security protection is applied to the MBS Session. When present, it shall contain the MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. |
|
|
contactPcfInd |
boolean |
O |
0..1 |
Indicates whether the PCF shall be contacted or not, i.e.:
When this attribute is not present, the default value is "false". This attribute may only be present in an MBS Session update request. |
6.2.6.2.5 Type: ContextUpdateReqData
Table 6.2.6.2.5-1: Definition of type ContextUpdateReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
nfcInstanceId |
NfInstanceId |
M |
1 |
NF Instance ID of the NF Service Consumer (e.g. AMF or SMF) |
|
|
mbsSessionId |
MbsSessionId |
M |
1 |
MBS session identifier (TMGI and/or SSM, and NID for an SNPN) |
|
|
areaSessionId |
AreaSessionId |
C |
0..1 |
This IE shall be present if this is a location dependent multicast MBS session. |
|
|
requestedAction |
ContextUpdateAction |
C |
0..1 |
This IE shall be set by an SMF. When present, this IE shall indicate whether to start or terminate MBS data reception. |
|
|
dlTunnelInfo |
Bytes |
C |
0..1 |
This IE shall be included by the SMF if the mbsSessionId IE is present and unicast transport is used over N19mb. When present, it shall contain Base64-encoded characters, encoding the DL F-TEID of the UPF as specified in Figure 8.22-1 of 3GPP TS 29.274 [19] (starting from octet 1). (NOTE) |
|
|
n2MbsSmInfo |
N2MbsSmInfo |
C |
0..1 |
This IE shall be included by the AMF if N2 MBS Session Management Information (container) needs to be sent to the MB-SMF. |
|
|
ranNodeId |
GlobalRanNodeId |
C |
0..1 |
This IE shall be included by the AMF. When present, it shall indicate the RAN Node ID of the RAN having sent the N2 information. |
|
|
leaveInd |
boolean |
C |
0..1 |
Leave Indication This IE shall be included by the AMF and set to true during a Release of shared delivery toward RAN node procedure, if it is the last NG-RAN controlled by the AMF serving the multicast MBS session. – true: the AMF does not control any more NG-RAN node for the multicast MBS session. |
|
|
NOTE: The SMF shall set the Interface Type in octet 5 indicating N19mb as specified in clause 8.22 of 3GPP TS 29.274 [19]. |
|||||
6.2.6.2.6 Type: ContextUpdateRspData
Table 6.2.6.2.6-1: Definition of type ContextUpdateRspData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
llSsm |
Ssm |
C |
0..1 |
This IE shall be present if the n2Info IE is absent and multicast transport is used over N19mb. When present, it shall contain the Low Layer Source Specific Multicast Address allocated by the MB-UPF. |
|
|
cTeid |
Uint32 |
C |
0..1 |
This IE shall be present if the n2Info IE is absent and multicast transport is used over N19mb. When present, it shall contain the Common TEID allocated by the MB-UPF. |
|
|
n2MbsSmInfo |
N2MbsSmInfo |
C |
0..1 |
This IE shall be present if N2 MBS Session Management Information (container) needs to be sent to the NF Service Consumer. |
6.2.6.2.7 Type: StatusSubscribeReqData
Table 6.2.6.2.7-1: Definition of type StatusSubscribeReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
subscription |
MbsSessionSubscription |
M |
1 |
MbsSession Status subscription to be created |
6.2.6.2.8 Type: StatusSubscribeRspData
Table 6.2.6.2.8-1: Definition of type StatusSubscribeRspData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
subscription |
MbsSessionSubscription |
M |
1 |
MBS Session Status subscription created |
|
|
eventList |
MbsSessionEventReportList |
C |
0..1 |
Event reports if corresponding information is available. |
6.2.6.2.9 Type: N2MbsSmInfo
Table 6.2.6.2.9-1: Definition of type N2MbsSmInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
ngapIeType |
NgapIeType |
M |
1 |
This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.2.6.3.6. |
|
|
ngapData |
RefToBinaryData |
M |
1 |
This IE shall contain the reference to the binary data part carrying the NGAP data. See clause 6.2.6.5.2 for details. |
6.2.6.2.10 Type: ContextStatusNotifyReqData
Table 6.2.6.2.10-1: Definition of type ContextStatusNotifyReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
reportList |
array(ContextStatusEventReport) |
M |
1..N |
Events to be reported |
|
|
notifyCorrelationId |
string |
C |
0..1 |
Notification Correlation ID. This IE shall be present if a Notification Correlation ID is available in the subscription. |
6.2.6.2.11 Type: StatusNotifyReqData
Table 6.2.6.2.11-1: Definition of type StatusNotifyReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eventList |
MbsSessionEventReportList |
M |
1 |
Reported MBS session events |
6.2.6.2.12 Type: ContextStatusSubscribeReqData
Table 6.2.6.2.12-1: Definition of type ContextStatusSubscribeReqData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
subscription |
ContextStatusSubscription |
M |
1 |
Context Status subscription to be created |
6.2.6.2.13 Type: ContextStatusSubscription
Table 6.2.6.2.13-1: Definition of type ContextStatusSubscription
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
nfcInstanceId |
NfInstanceId |
M |
1 |
NF Instance ID of the NF Service Consumer |
|
|
mbsSessionId |
MbsSessionId |
M |
1 |
MBS Session Identifier (i.e. TMGI or source specific IP multicast address) |
|
|
eventList |
array(ContextStatusEvent) |
M |
1..N |
Events subscribed |
|
|
notifyUri |
Uri |
M |
1 |
URI where to send event notifications |
|
|
notifyCorrelationId |
string |
O |
0..1 |
Notification Correlation ID |
|
|
expiryTime |
DateTime |
O |
0..1 |
When present in a subscription creation or modification request, it shall indicate the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications. When present in a subscription or modification response, it shall indicate the expiry time after which the subscription becomes invalid. |
6.2.6.2.14 Type: ContextStatusEvent
Table 6.2.6.2.14-1: Definition of type ContextStatusEvent
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
EventType |
ContextStatusEventType |
M |
1 |
MBS session context status event type (NOTE) |
|
|
immediateReportInd |
boolean |
O |
0..1 |
Immediate Report Indication When present, it shall be set as follows: – true: an immediate report is requested – false (default): no immediate report is requested |
|
|
reportingMode |
ReportingMode |
O |
0..1 |
When present, it shall indicate whether the events shall be reported continuously or one time only. (NOTE) |
|
|
NOTE: In this release of the specification, the SMF shall subscribe to the "QOS_INFO", "STATUS_INFO", "SERVICE_AREA_INFO", "SECURITY_INFO", "SESSION_RELEASE" and "MULT_TRANS_ADD_CHANGE" events, with the Reporting Mode set to "Continuous event reporting". |
|||||
6.2.6.2.15 Type: ContextStatusSubscribeRspData
Table 6.2.6.2.15-1: Definition of type ContextStatusSubscribeRspData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
subscription |
ContextStatusSubscription |
M |
1 |
Representation of the Context Status Subscription resource that has been created. |
|
|
reportList |
Array(ContextStatusEventReport) |
C |
1..N |
Immediate event reports, if requested in the request and if corresponding information is available. |
|
|
mbsContextInfo |
MbsContextInfo |
O |
0..1 |
MBS context information |
6.2.6.2.16 Type: MbsContextInfo
Table 6.2.6.2.16-1: Definition of type MbsContextInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
startTime |
DateTime |
O |
0..1 |
Start time of the multicast MBS session |
|
|
anyUeInd |
boolean |
O |
0..1 |
Indication that the multicast MBS session allows any UE to join. When present, it shall be set as follows: – true: any UE may join – false (default): the MBS session is not open to any UE |
|
|
llSsm |
Ssm |
O |
0..1 |
This IE may be present if multicast transport may be used over N19mb. When present, it shall contain the Low Layer Source Specific Multicast Address allocated by the MB-UPF. |
|
|
cTeid |
Uint32 |
O |
0..1 |
This IE may be present if multicast transport may be used over N19mb. When present, it shall contain the Common TEID allocated by the MB-UPF. |
|
|
mbsServiceArea |
MbsServiceArea |
C |
0..1 |
This IE shall be present for a Local MBS session. |
|
|
mbsServiceAreaInfoList |
map(MbsServiceAreaInfo) |
C |
1..N |
This IE shall be present for a location dependent MBS service. When present, one map entry shall be provided for each MBS Service Area served by the MBS session. The key of the map shall be the areaSessionId. |
6.2.6.2.17 Type: ContextStatusEventReport
Table 6.2.6.2.17-1: Definition of type ContextStatusEventReport
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eventType |
ContextStatusEventType |
M |
1 |
MBS session context status event type |
|
|
timeStamp |
DateTime |
M |
1 |
This IE shall contain the time at which the event is generated. |
|
|
qosInfo |
QosInfo |
C |
0..1 |
This IE shall be present if the eventType IE indicates "QOS_INFO". |
|
|
statusInfo |
MbsSessionActivityStatus |
C |
0..1 |
This IE shall be present if the eventType IE indicates "STATUS_INFO". |
|
|
mbsServiceArea |
MbsServiceArea |
C |
0..1 |
This IE shall be present for a Local MBS session if the eventType IE indicates "SERVICE_AREA_INFO". The receiver of this IE shall overwrite any previously stored value with the value received in this IE. |
|
|
mbsServiceAreaInfoList |
map(MbsServiceAreaInfo) |
C |
1..N |
This IE shall be present for a location dependent MBS service if the eventType IE indicates "SERVICE_AREA_INFO". When present, one map entry shall be provided for each MBS Service Area served by the MBS session. The key of the map shall be the areaSessionId. The receiver of this IE shall overwrite any previously stored value with the value received in this IE. |
|
|
multicastTransAddInfo |
MulticastTransportAddressChangeInfo |
C |
0..1 |
Multicast Transport Address Change Information This IE shall be present if the eventType IE indicates "MULT_TRANS_ADD_CHANGE". |
|
|
mbsSecurityContext |
MbsSecurityContext |
C |
0..1 |
This IE shall be present in the eventType IE indicates "SECURITY_INFO". The receiver of this IE shall overwrite any previously stored value with the value received in this IE. |
6.2.6.2.18 Type: MulticastTransportAddressChangeInfo
Table 6.2.6.2.18-1: Definition of type MulticastTransportAddressChangeInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
llSsm |
Ssm |
M |
1 |
This IE shall indicate the new multicast transport address (i.e. source IP address and destination multicast address) allocated by the MB-UPF to receive the MBS session data over the N19mb reference point. |
|
|
cTeid |
Uint32 |
M |
1 |
This IE shall contain the new Common TEID allocated by the MB-UPF to receive the MBS session data over the N19mb reference point. |
|
|
areaSessionId |
AreaSessionId |
C |
0..1 |
This IE shall be present for a location dependent MBS session. When present, it shall indicate the Area Session ID of the part of the location dependent MBS session for which the new multicast transport address is provided. |
6.2.6.2.19 Type: QosInfo
Table 6.2.6.2.19-1: Definition of type QosInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
qosFlowsAddModRequestList |
array(QosFlowAddModifyRequestItem) |
C |
1..N |
This IE shall be present if the eventType IE indicates "QOS_INFO" and MBS QoS flows are requested to be established or modified. |
|
|
qosFlowsRelRequestList |
array(Qfi) |
C |
1..N |
This IE shall be present if the eventType IE indicates "QOS_INFO" and MBS QoS flows are requested to be released. When present, it shall indicate the MBS QoS flows to be released. |
6.2.6.2.20 Type: QosFlowAddModifyRequestItem
Table 6.2.6.2.20-1: Definition of type QosFlowAddModifyRequestItem
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
qfi |
Qfi |
M |
1 |
This IE shall contain the MBS QoS Flow Identifier. |
|
|
qosFlowProfile |
QosFlowProfile |
O |
0..1 |
When present, this IE shall contain the description of the MBS QoS Flow level QoS parameters. When modifying an MBS QoS flow, the IE shall only contain the MBS QoS Flow profile’s attributes which are modified. |
6.2.6.2.21 Type: QosFlowProfile
Table 6.2.6.2.21-1: Definition of type QosFlowProfile
|
Attribute name |
Data type |
P |
Cardinality |
Description |
|
5qi |
5Qi |
M |
1 |
This IE shall contain the 5G QoS Identifier (5QI) of the MBS QoS flow. |
|
nonDynamic5Qi |
NonDynamic5Qi |
C |
0..1 |
When present, this IE shall indicate the QoS Characteristics for a standardized or pre-configured 5QI for downlink. (NOTE) |
|
dynamic5Qi |
Dynamic5Qi |
C |
0..1 |
When present, this IE shall indicate the QoS Characteristics for a Non-standardised or not pre-configured 5QI for downlink. (NOTE) |
|
arp |
Arp |
C |
0..1 |
This IE shall be present when establishing an MBS QoS flow; it may be present when modifying an MBS QoS flow. When present, this IE shall contain the Allocation and Retention Priority (ARP) assigned to the MBS QoS flow. |
|
gbrQosFlowInfo |
GbrQosFlowInformation |
C |
0..1 |
This IE shall be present when establishing a GBR MBS QoS flow or if the GBR MBS QoS flow information is modified. |
|
NOTE: Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when establishing a QoS flow. Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when modifying a QoS flow; when present, the received nonDynamic5Qi IE or dynamic5Qi IE shall replace any value received previously for this IE. |
||||
6.2.6.2.22 Type: GbrQosFlowInformation
Table 6.2.6.2.22-1: Definition of type GbrQosFlowInformation
|
Attribute name |
Data type |
P |
Cardinality |
Description |
|
maxFbrDl |
BitRate |
M |
1 |
Maximum Bit Rate in Downlink. See 3GPP TS 23.501 [2]. |
|
guaFbrDl |
BitRate |
M |
1 |
Guaranteed Bit Rate in Downlink. See 3GPP TS 23.501 [2]. |
|
maxPacketLossRateDl |
PacketLossRate |
O |
0..1 |
Maximum rate for lost packets that can be tolerated in the downlink direction. See 3GPP TS 23.501 [2]. |
6.2.6.2.23 Type: ProblemDetailsExtension
Table 6.2.6.2.23-1: Definition of type ProblemDetailsExtension
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
accMbsServiceInfo |
AcceptableMbsServInfo |
O |
0..1 |
MBS Service Information that can be accepted by the PCF |
6.2.6.3 Simple data types and enumerations
6.2.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.2.6.3.2 Simple data types
The Nmbsmf_MBSSession API does not define any simple data type in this release of the specification.
6.2.6.3.3 Enumeration: ContextUpdateAction
The enumeration ContextUpdateAction indicates the requested action for the MBS session context. It shall comply with the provisions defined in table 6.2.6.3.3-1.
Table 6.2.6.3.3-1: Enumeration ContextUpdateAction
|
Enumeration value |
Description |
Applicability |
|
"START" |
Start MBS data reception |
|
|
"TERMINATE" |
Terminate MBS data recepton |
6.2.6.3.4 Enumeration: ContextStatusEventType
Table 6.2.6.3.4-1: Enumeration ContextStatusEventType
|
Enumeration value |
Description |
Applicability |
|
"QOS_INFO" |
Subscription to be notified about the current MBS Session’s QoS information and/or change of this information (e.g. addition, modification or removal of QoS flows) |
|
|
"STATUS_INFO " |
Subscription to be notified about the current MBS Session’s status (activated or deactivated) and/or change of this information. |
|
|
"SERVICE_AREA_INFO" |
Subscription to be notified about the current MBS Service Area and/or change of this information. |
|
|
"SESSION_RELEASE" |
Subscription to be notified when the MBS session is released. |
|
|
"MULT_TRANS_ADD_CHANGE" |
Subscription to be notified about change of the N19mb multicast transport address. |
|
|
"SECURITY_INFO" |
Subscription to be notified about the current MBS Session’s Security Context information and/or change of this information |
6.2.6.3.5 Enumeration: ReportingMode
Table 6.2.6.3.5-1: Enumeration ReportingMode
|
Enumeration value |
Description |
Applicability |
|
"CONTINUOUS" |
Continuous event reporting |
|
|
"ONE_TIME" |
One-time event reporting |
6.2.6.3.6 Enumeration: NgapIeType
Table 6.5.6.3.6-1: Enumeration NgapIeType
|
Enumeration value |
Description |
|
"MBS_DIS_SETUP_REQ" |
MBS Distribution Setup Request Transfer |
|
"MBS_DIS_SETUP_RSP" |
MBS Distribution Setup Response Transfer |
|
"MBS_DIS_SETUP_FAIL" |
MBS Distribution Setup Unsuccessful Transfer |
|
"MBS_DIS_REL_REQ" |
MBS Distribution Release Request Transfer |
6.2.6.4 Data types describing alternative data types or combinations of data types
6.2.6.4.1 Type: ExtMbsSession
6.2.6.4.1-1: Definition of type ExtMbsSession as a list of to be combined data types
|
Data type |
Cardinality |
Description |
|
MbsSession |
1 |
MbsSession common data type |
|
MbsSessionExtension |
1 |
Extensions to the MbsSession common data type |
6.2.6.4.2 Type: ExtProblemDetails
6.2.6.4.2-1: Definition of type ExtProblemDetails as a list of to be combined data types
|
Data type |
Cardinality |
Description |
|
ProblemDetails |
1 |
Details of the encountered problem, as defined in 3GPP TS 29.571 [18]. |
|
ProblemDetailsExtension |
1 |
Extensions to the ProblemDetails common data type |
6.2.6.5 Binary data
6.2.6.5.1 Introduction
This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.2.2.2.2 and 6.2.2.4).
Table 6.2.6.5.1-1: Binary Data Types
|
Name |
Clause defined |
Content type |
|
N2 MBS Session Management Information |
6.2.6.5.2 |
vnd.3gpp.ngap |
6.2.6.5.2 N2 MBS Session Management Information
N2 MBS Session Management Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.5 of 3GPP TS 38.413 [20] (ASN.1 encoded), using the vnd.3gpp.ngap content-type.
N2 MBS Session Management Information may encode following NGAP IE related to MBS Session Management specified in in clause 9.3.5 of 3GPP TS 38.413 [20], as summarized in Table 6.5.6.4.2-1.
Table 6.5.6.4.2-1: N2 MBS Session Management Information content
|
NGAP IE |
Reference (3GPP TS 38.413 [20]) |
Related NGAP message |
|
MBS Distribution Setup Request Transfer |
9.3.5.7 |
DISTRIBUTION SETUP REQUEST |
|
MBS Distribution Setup Response Transfer |
9.3.5.8 |
DISTRIBUTION SETUP RESPONSE |
|
MBS Distribution Setup Unsuccessful Transfer |
9.3.5.9 |
DISTRIBUTION SETUP FAILURE |
|
MBS Distribution Release Request Transfer |
9.3.5.10 |
DISTRIBUTION RELEASE REQUEST |
6.2.6.5.3 Void
6.2.7 Error Handling
6.2.7.1 General
For the Nmbsmf_MBSSession API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
In addition, the requirements in the following clauses are applicable for the Nmbsmf_MBSSession API.
6.2.7.2 Protocol Errors
No specific procedures for the Nmbsmf_MBSSession service are specified.
6.2.7.3 Application Errors
The application errors defined for the Nmbsmf_MBSSession service are listed in Table 6.2.7.3-1.
Table 6.2.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
|
INVALID_MBS_SERVICE_INFO |
400 Bad Request |
The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization. |
|
FILTER_RESTRICTIONS_NOT_RESPECTED |
400 Bad Request |
The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected. |
|
ERROR_INPUT_PARAMETERS |
400 Bad Request |
The HTTP request is rejected because the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control. |
|
MBS_SERVICE_INFO_NOT_AUTHORIZED |
403 Forbidden |
The HTTP request is rejected because the provided MBS Service Information is not authorized to perform MBS policy authorization. |
|
MBS_POLICY_CONTEXT_DENIED |
403 Forbidden |
The HTTP request is rejected due to operator policies and/or local configuration. |
|
MBS_SESSION_ALREADY_CREATED |
403 Forbidden |
This error indicates an unsuccessful of MBS session creation, if the MBS session to be created has already been created in the MB-SMF. For a location dependent MBS session, this error shall be used if the MBS session associated to the indicated MBS session identifier and MBS service area has already been created in the MB-SMF. For non location dependent MBS session, this error shall be used if the MBS session indicated by the MBS session identifier has been created in the MB-SMF. |
|
OVERLAPPING_MBS_SERVICE_AREA |
403 Forbidden |
This error indicates an unsuccessful of MBS session creation, if the new MBS service area overlaps with the service area of any MBS session with the same MBS session identifier. |
|
UNKNOWN_TMGI |
404 Not Found |
This error indicates an unsuccessful of MBS session creation, if the TMGI provided in the request does not exist in the MB-SMF. |
|
UNKNOWN_MBS_SESSION |
404 Not Found |
This error indicates an unsuccessful MBS session update or release, if the MBS session to be updated or deleted is not found in the MB-SMF. |
|
UNKNOWN_MBS_SERVICE_AREA |
404 Not Found |
This error indicates an unsuccessful of MBS session update, if the requested MBS service area cannot be found. |
6.2.8 Feature negotiation
The optional features in table 6.2.8-1 are defined for the Nmbsmf_MBSSession API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 6.2.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
6.2.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmbsmf_MBSSession API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmbsmf_MBSSession API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmbsmf_MBSSession service.
The Nmbsmf_MBSSession API defines a single scope "nmbsmf-mbssession" for the entire service, and it does not define any additional scopes at resource or operation level.
6.2.10 HTTP redirection
An HTTP request may be redirected to a different MB-SMF service instance, within the same MB-SMF or a different MB-SMF of an MB-SMF set, e.g. when an MB-SMF service instance is part of an MB-SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]).
An SCP that reselects a different MB-SMF producer instance will return the NF Instance ID of the new MB-SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
If an MB-SMF within an MB-SMF set redirects a service request to a different MB-SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MB-SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
Annex A (normative):
OpenAPI specification