6 API Definitions

29.6733GPP5G SystemRelease 18Stage 3TSUE radio capability management services

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

6.1 Nucmf_UECapabilityManagement Service API

6.1.1 Introduction

The Nucmf_UECapabilityManagement service shall use the Nucmf_UECapabilityManagement API.

The API URI of the Nucmf_UECapabilityManagement API shall be:

{apiRoot}/<apiName>/<apiVersion>

The request URI 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 "nucmf-uecm".

– The <apiVersion> shall be "v1".

– The <apiSpecificResourceUriPart> shall be set as described in clause 5.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 <API Name> 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].

Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising:

– one JSON body part with the "application/json" content type; and

– one or more binary body parts with 3gpp vendor specific content subtypes.

The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported.

Table 6.1.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 [15] (ASN.1 encoded).
vnd.3gpp.s1ap	Binary encoded payload, encoding S1 Application Protocol (S1AP) IEs, as specified in clause 9.2 of 3GPP TS 36.413 [17] (ASN.1 encoded).
NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSON payload.

See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages.

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 applicable.

6.1.2.4 HTTP multipart messages

HTTP multipart messages shall be supported to transfer opaque UE Radio Access Capability Information, in the following service operations (and HTTP messages):

– Resolve Response (GET Response);

– Assign Request (POST);

HTTP multipart message shall include one JSON body part and one or more binary body parts comprising the OCTET STRING of the UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]) and clause 9.2.1.27 of 3GPP TS 36.413 [17], or the UE Radio Access Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17] and as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15].

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 [10]) 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 [10]. 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 [12]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part.

6.1.3 Resources

6.1.3.1 Overview

Figure 6.1.3.1-1: Resource URI structure of the Nucmf_UECapabilityManagement API

Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.

Table 6.1.3.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method or custom operation	Description
Dictionary Entries collection	/dic-entries	POST	Nucmf_UECapabilityManagement_Assign
		GET	Nucmf_UECapabilityManagement_Resolve
Individual Dictionary Entry	/dic-entries/{dicEntryId}	GET	Nucmf_UECapabilityManagement_Resolve
Subscriptions collection	/subscriptions	POST	Nucmf_UECapabilityManagement_Subscribe
Individual subscription	/subscriptions/{subscriptionId}	DELETE	Nucmf_UECapabilityManagement_Unsubscribe

6.1.3.2 Resource: Dictionary Entries

6.1.3.2.1 Description

This resource represents the collection of the individual dictionary entries created in the UCMF, where each individual dictionary entry includes the mapping information between UE Radio Capability ID and UE Radio Access Capability Information, Type Allocation Code and Software version of a PEI.

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}/nucmf-ucm/<apiVersion>/dic-entries

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	Definition
apiRoot	See clause 6.1.1
apiVersion	See clause 6.1.1

6.1.3.2.3 Resource Standard Methods

6.1.3.2.3.1 GET

This operation retrieves the UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by querying with a Manufacturer-assigned or PLMN-assigned UE Radio Capability ID, or the TAC and the SVN as part of the IMEI/IMEISV of the UE.

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 GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
ue-radio-capa-id	UeRadioCapaId	M	1	PLMN assigned or Manufacturer assigned UE Radio Capability ID used to retrieve a dictionary entry.
rac-format	RacFormat	C	0..1	Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4.
supported-features	SupportedFeatures	C	0..1	This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

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 GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
DicEntryData	M	1	200 OK	The response body contains a dictionary entry that is matching the querying parameter.
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 UCMF or UCMF (service) set.
RedirectResponse	O	0..1	308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
ProblemDetails	O	0..1	400 Bad Request	The response body contains the error reason of the request message.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate the following application error: – NO_DICTIONARY_ENTRY_FOUND – OUT_DATED_VERSION_ID_IN_RAC_ID See table 6.1.7.3-1 for the description of this error.
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

6.1.3.2.3.2 POST

This method creates an individual dictionary entry resource in the UCMF unless such dictionary entry already exists.

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 POST method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3.

Table 6.1.3.2.3.2-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
DicEntryCreateData	M	1	Contains UE Radio Access Capability Information and type Allocation Code.

Table 6.1.3.2.3.2-3: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
DicEntryCreatedData	M	1	201 Created	The response body contains the assigned UE Radio Capability ID.
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 UCMF or UCMF (service) set.
RedirectResponse	O	0..1	308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
ProblemDetails	O	0..1	400 Bad Request	The response body contains the error reason of the request message.
NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Table 6.1.3.2.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Table 6.1.3.2.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

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.3.3 Resource: Individual Dictionary Entry

6.1.3.3.1 Description

This resource represents an individual Dictionary Entry for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, identified by the Dictionary Entry ID.

This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).

6.1.3.3.2 Resource Definition

Resource URI:{apiRoot}/nucmf-ucm/<apiVersion>/dic-entries/{dicEntryId}

This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.

Table 6.1.3.3.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
apiVersion	See clause 6.1.1.
dicEntryId	Integer with range 1-4294967295.

6.1.3.3.3 Resource Standard Methods

6.1.3.3.3.1 GET

This operation retrieves an individual dictionary entry resource for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, stored in the UCMF, identified by the dicEntryId.

This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.

Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description	Applicability
rac-format	RacFormat	C	0..1	Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4.
supported-features	SupportedFeatures	C	0..1	This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

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 GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
DicEntryData	M	1	200 OK	The response body contains a dictionary entry for the given Dictionary Entry ID.
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 UCMF or UCMF (service) set.
RedirectResponse	O	0..1	308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate the following application error: – NO_DICTIONARY_ENTRY_FOUND See table 6.1.7.3-1 for the description of this error.
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

6.1.3.4 Resource: Subscriptions collection

6.1.3.4.1 Description

This resource represents a collection of subscriptions in the UCMF, created by NF service consumers of Nucmf_UECapabilityManagement service.

This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).

6.1.3.4.2 Resource Definition

Resource URI: {apiRoot}/nucmf-ucm/<apiVersion>/subscriptions

This resource shall support the resource URI variables defined in table 6.1.3.4.2-1.

Table 6.1.3.4.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
apiVersion	See clause 6.1.1.

6.1.3.4.3 Resource Standard Methods

6.1.3.4.3.1 POST

This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1.

Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3.

Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
CreateSubscription	M	1	The Subscription to be created by a NF Service consumer, e.g. an AMF.

Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
CreatedSubscription	M	1	201 Created	Represents successful creation of a Subscription in the UCMF
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 UCMF or UCMF (service) set.
RedirectResponse	O	0..1	308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
ProblemDetails	O	0..1	400 Bad Request	The response body contains the error reason of the request message.
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

6.1.3.4.4 Resource Custom Operations

None.

6.1.3.5 Resource: Individual subscription

6.1.3.5.1 Description

This resource represents an individual of subscription in the UCMF, created earlier by a NF Service Consumer of Nucmf_UECapabilityManagement service.

This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).

6.1.3.5.2 Resource Definition

Resource URI: {apiRoot}/nucmf-ucm/<apiVersion>/subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 6.1.3.5.2-1.

Table 6.1.3.5.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
apiVersion	See clause 6.1.1.
subscriptionId	String identifies an individual subscription in the UCMF.

6.1.3.5.3 Resource Standard Methods

6.1.3.5.3.2 DELETE

This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1.

Table 6.1.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3.

Table 6.1.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.1.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
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 UCMF or UCMF (service) set.
RedirectResponse	O	0..1	308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
ProblemDetails	O	0..1	404 Not Found	Indicates the modification of subscription has failed due to application error. The "cause" attribute may be used to indicate the following application error: – SUBSCRIPTION_NOT_FOUND.
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (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

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

6.1.3.5.4 Resource Custom Operations

None.

6.1.4 Custom Operations without associated resources

None.

6.1.5 Notifications

6.1.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].

6.1.5.2 UCMF Notification

6.1.5.2.1 Description

The UCMF Notification is used by the UCMF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual Notification Subscription Resource.

6.1.5.2.2 Target URI

The Callback URI "{ucmfNotificationUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1.

Table 6.1.5.2.2-1: Callback URI variables for this resource

Name	Definition
ucmfNotificationUri	String formatted as URI with the UCMF Callback Uri

6.1.5.2.3 Standard Methods

6.1.5.2.3.1 POST

This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1.

Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
UcmfNotification	M	1	Represents the notification to be delivered

Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content
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 the NF service consumer to which the notification should be sent, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP.
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 the NF service consumer to which the notification should be sent, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP.
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.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

Cardinality

Description

Location

string

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

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 Nucmf_UECapabilityManagement service based interface protocol.

Table 6.1.6.1-1: Nucmf_UECapabilityManagement specific Data Types

Data type	Clause defined	Description	Applicability
DicEntryData	6.1.6.2.2	A dictionary entry for a UE radio capability ID in the UCMF
DicEntryCreateData	6.1.6.2.3	Data for a creating a dictionary entry request
DicEntryCreatedData	6.1.6.2.4	Data for a creating a dictionary entry response
UeRadioCapaId	6.1.6.2.5	UE Radio Capability ID
CreateSubscription	6.1.6.2.6	Data for a creating a subscription request
CreatedSubscription	6.1.6.2.7	Data for a creating a subscription response
UcmfNotification	6.1.6.2.8	Data for a notification request from a UCMF
ManAssOpRequestlist	6.1.6.2.9	Manufacturer Assigned operation requested list
EventType	6.1.6.3.3
RacFormat	6.1.6.3.4	The encoding type of the UE’s Radio Access Capability Information

Table 6.1.6.1-2 specifies data types re-used by the Nucmf_UECapabilityManagement 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 N_<NF> service based interface.

Table 6.1.6.1-2: Nucmf_UECapabilityManagement re-used Data Types

Data type	Reference	Comments	Applicability
PlmnAssiUeRadioCapId	3GPP TS 29.571 [14]	PLMN Assigned UE Radio Capability ID
ManAssiUeRadioCapId	3GPP TS 29.571 [14]	Manufacturer Assigned UE Radio Capability ID
TypeAllocationCode	3GPP TS 29.571 [14]	Type Allocation Code
NfInstanceId	3GPP TS 29.571 [14]	NF Instance ID
DateTime	3GPP TS 29.571 [14]	A date-time format defined in OpenAPI Specification [6]
SupportedFeatures	3GPP TS 29.571 [14]	Supported Features
ProblemDetails	3GPP TS 29.571 [14]	Detailed problems in failure case
RedirectResponse	3GPP TS 29.571 [14]	Response body of the redirect response message.

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: DicEntryData

Table 6.1.6.2.2-1: Definition of type DicEntryData

Attribute name	Data type	P	Cardinality	Description
dicEntryId	DicEntryId	C	0..1	Identifier of the Dictionary Entry
plmnAssiUeRadioCapId	PlmnAssiUeRadioCapId	C	0..1	This IE shall include a PLMN Assigned UE Radio Capability ID if allocated in the dictionary entry.
manAssiUeRadioCapId	ManAssiUeRadioCapId	C	0..1	This IE shall include a Manufacturer Assigned UE Radio Capability ID if available in the dictionary entry.
typeAllocationCode	TypeAllocationCode	M	1	This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry.
ueRadioCapability5GS	RefToBinaryData	C	0..1	This IE shall be included to contain the UE Radio Access Capability Information encoded either as OCTET STRING of UE Radio Capability IE as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], when the message is sent to AMF, otherwise it may be included.
ueRadioCapabilityEPS	RefToBinaryData	C	0..1	This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE as specified in clause 9.2.1.27 of 3GPP TS 36.413 [x], when the message is sent to MME, otherwise it may be included.
ueRadioCap5GSForPaging	RefToBinaryData	O	0..1	May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15], when the message is sent to AMF
ueRadioCapEPSForPaging	RefToBinaryData	O	0..1	May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17], when the message is sent to MME, otherwise it may be included.
NOTE: The information in the dictionary entry which is included as the query parameter(s) or URI variable in the request message shall not be present.

6.1.6.2.3 Type: DicEntryCreateData

Table 6.1.6.2.3-1: Definition of type DicEntryCreateData

Attribute name	Data type	P	Cardinality	Description
typeAllocationCode	TypeAllocationCode	M	1	This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry.
ueRadioCapability5GS	RefToBinaryData	C	0..1	This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15].
ueRadioCapabilityEPS	RefToBinaryData	C	0..1	This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17]. (NOTE)
supportedFeatures	SupportedFeatures	C	0..1	This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.
ueRadioCap5GSForPaging	RefToBinaryData	O	0..1	May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15].
ueRadioCapEPSForPaging	RefToBinaryData	O	0..1	May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17].
NOTE: At least one of ueRadioCapability5GS or ueRadioCapabilityEPS shall be present.

6.1.6.2.4 Type: DicEntryCreatedData

Table 6.1.6.2.4-1: Definition of type DicEntryCreatedData

Attribute name	Data type	P	Cardinality	Description
plmnAssiUeRadioCapId	PlmnAssiUeRadioCapId	M	1	This IE shall include a PLMN Assigned UE Radio Capability ID if allocated.

6.1.6.2.5 Type: UeRadioCapaId

Table 6.1.6.2.5-1: Definition of type UeRadioCapaId

Attribute name	Data type	P	Cardinality	Description
plmnAssiUeRadioCapId	PlmnAssiUeRadioCapId	C	0..1	This IE shall include a PLMN Assigned UE Radio Capability ID. (NOTE)
manAssiUeRadioCapId	ManAssiUeRadioCapId	C	0..1	This IE shall include a Manufacturer Assigned UE Radio Capability ID. (NOTE)
NOTE: Only one of plmnAssiUeRadioCapId and manAssiUeRadioCapId shall be present during retrieving UE Radio Access Capability Information. (See clause 6.1.3.2.3.1)

6.1.6.2.6 Type: CreateSubscription

Table 6.1.6.2.6-1: Definition of type CreateSubscription

Attribute name	Data type	P	Cardinality	Description
nfId	NfInstanceId	C	0..1	This IE shall contain the NF Instance ID of the service consumer, e.g. an AMF, if it is available.
ucmfNotificationUri	Uri	M	1	This IE shall contain the callback URI on which the subscribed events shall be notified.
suggestedExpires	DateTime	O	0..1	If present, indicates the point in time at which the subscription expires, which is suggested by the service consumer.
supportedFeatures	SupportedFeatures	C	0..1	This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

6.1.6.2.7 Type: CreatedSubscription

Table 6.1.6.2.7-1: Definition of type CreatedSubscription

Attribute name	Data type	P	Cardinality	Description
dicEntryId	DicEntryId	M	1	This IE shall contain the highest DicEntryId has been allocated in the UCMF.
confirmedExpires	DateTime	O	0..1	If present, indicates the point in time at which the subscription expires, which is confirmed by the service producer.
supportedFeatures	SupportedFeatures	C	0..1	This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported.

6.2.6.2.8 Type: UcmfNotification

Table 6.2.6.2.8-1: Definition of type UcmfNotification

Attribute name	Data type	P	Cardinality	Description
dicEntryId	DicEntryId	M	1	This IE shall contain the highest DicEntryId has been allocated in the UCMF.
eventType	EventType	M	1	This IE shall contain the different events type included in the notification.
manAssOpRequestlist	ManAssOpRequestlist	C	0..1	This IE shall be present to contain the Manufacturer Assigned operation requested list which includes a list of PLMN Assigned UE Radio Capability IDs or a list of TACs if the event type indicates the deletion of one or more PLMN Assigned UE Radio Capability IDs as specified in 3GPP TS 23.501 [2].
versionId	Uinteger	O	0..1	Uinteger with the range between 0 and 255. This IE may be present if eventType indicates to notify a new version id of PLMN Assigned UE Radio Capability Id(s).

6.2.6.2.9 Type: ManAssOpRequestlist

Table 6.2.6.2.9-1: Definition of type DelPlmnAssiUeRadioCapIdData

Attribute name	Data type	P	Cardinality	Description
plmnAssiUeRadioCapId	array(PlmnAssiUeRadioCapId)	C	0..N	This IE shall contain one or more PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE) The UCMF shall always provide a complete list of PLMN Assigned UE Radio Capability IDs to enable the AMF to overwrite the existing list.
typeAllocationCode	array (TypeAllocationCode)	C	0..N	This IE shall contain one or more Type Allocation Code in corresponding to the PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE) The UCMF shall always provide a complete list of Type Allocation Codes to enable the AMF to overwrite the existing list.
NOTE: Either plmnAssiUeRadioCapId or typeAllocationCode shall be present, not for both.

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 simple data types defined in table 6.1.6.3.2-1 shall be supported.

Table 6.1.6.3.2-1: Simple data types

Type Name	Type Definition	Description	Applicability
DicEntryId	Integer	integer with range 1-4294967295.

6.1.6.3.3 Enumeration: EventType

The enumeration EventType represents different type of events included in a notification from the UCMF. It shall comply with the provisions defined in table 6.1.5.3.3-1.

Table 6.1.6.3.3-1: Enumeration EventType

Enumeration value	Description	Applicability
"CREATION_OF_DICTIONARY_ENTRY"	New dictionary entries are created in the UCMF.
"DELETION_OF_PLMN_ASSIGNED_IDS"	One or more PLMN-assigned UE Radio Capability IDs are deleted.
"NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDs"	Notify a new version id of PLMN Assigned UE Radio Capability Id(s).

6.1.6.3.4 Enumeration: RacFormat

The enumeration RacFormat represents the encoding type of the UE’s Radio Access Capability Information.

Table 6.1.6.3.4-1: Enumeration racFormat

Enumeration value	Description	Applicability
"5GS"	This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15].
"EPS"	This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17].

6.1.6.4 Data types describing alternative data types or combinations of data types

None.

6.1.6.5 Binary data

6.1.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.1.2.2.2 and 6.1.2.4).

6.1.6.5.2 UE Radio Capability Information

UeRadioCapability5GS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], using the vnd.3gpp.ngap content-type.

UeRadioCapabilityEPS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.2.1.27 of 3GPP TS 36.413 [17], using the vnd.3gpp.s1ap content-type.

ueRadioCap5GSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15].

ueRadioCapEPSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17].

6.1.7 Error Handling

6.1.7.1 General

For the Nucmf_UECapabilityManagement 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 Nucmf_UECapabilityManagement API.

6.1.7.2 Protocol Errors

No specific procedures for the Nucmf_UECapabilityManagement service are specified.

6.1.7.3 Application Errors

The application errors defined for the Nucmf_UECapabilityManagement service are listed in Table 6.1.7.3-1.

Table 6.1.7.3-1: Application errors

Application Error	HTTP status code	Description
NO_DICTIONARY_ENTRY_FOUND	404	There is no dictionary entry matching the UE Radio Capability ID in query.
OUT_DATED_VERSION_ID_IN_RAC_ID	404	The version id in the requested PLMN Assigned UE Radio Capability Id is out-dated.

6.1.8 Feature negotiation

The optional features in table 6.1.8-1 are defined for the Nucmf_UECapabilityManagement 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

M/O

Description

ES3XX

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the UECapabilityManagement service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

6.1.9 Security

As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nucmf_UECapabilityManagement 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 Nucmf_UECapabilityManagement 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 Nucmf_UECapabilityManagement service.

The Nucmf_UECapabilityManagement API defines a single scope "nucmf_uecapabilitymanagement" 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 UCMF service instance, within the same UCMF or a different UCMF of an UCMF set, e.g. when an UCMF service instance is part of an UCMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.8.

An SCP that reselects a different UCMF producer instance will return the NF Instance ID of the new UCMF 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 UCMF within an UCMF set redirects a service request to a different UCMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UCMF 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