5.11 ServiceParameter API
29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS
5.11.1 Resources
5.11.1.1 Overview
All resource URIs of this API should have the following root:
{apiRoot}/3gpp-service-parameter/v1
"apiRoot" is set as described in clause 5.2.4 in 3GPP TS 29.122 [4]. "apiName" shall be set to "3gpp-service-parameter" and "apiVersion" shall be set to "v1" for the current version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.
This clause describes the structure for the Resource URIs as shown in figure 5.11.1.1-1 and the resources and HTTP methods used for the ServiceParameter API.
Figure 5.11.1.1-1: Resource URI structure of the ServiceParameter API
Table 5.11.1.1-1 provides an overview of the resources and HTTP methods applicable for the ServiceParameter API.
Table 5.11.1.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method |
Description |
Service Parameter Subscripions |
/{afId}/subscriptions |
GET |
Read all subscriptions for a given AF. |
POST |
Create a new service parameter subscription. |
||
Individual Service Parameter Subscripion |
/{afId}/subscriptions/{subscriptionId} |
GET |
Read an existing subscription identified by {subscriptionId} |
PUT |
Modify all of the properties of an existing subscription. identified by {subscriptionId} |
||
PATCH |
Modify some of the properties of an existing subscription identified by {subscriptionId} |
||
DELETE |
Delete a subscription identified by {subscriptionId} |
5.11.1.2 Resource: Service Parameter Subscriptions
5.11.1.2.1 Introduction
This resource allows a AF to read all active Service Parameter Subscriptions for the given AF, or create an new individual service parameter subscription in the NEF.
5.11.1.2.2 Resource Definition
Resource URI: {apiRoot}/3gpp-service-parameter/v1/{afId}/subscriptions
This resource shall support the resource URI variables defined in table 5.11.1.2.2-1.
Table 5.11.1.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
Clause 5.2.4 of 3GPP TS 29.122 [4]. |
afId |
string |
Identifier of the AF. |
5.11.1.2.3 Resource Methods
5.11.1.2.3.1 General
The following clauses specify the resource methods supported by the resource as described in clause 5.11.1.2.3.
5.11.1.2.3.2 GET
The GET method allows to read all active subscriptions for a given AF. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.11.1.2.3.2-1.
Table 5.11.1.2.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
gpsis |
array(Gpsi) |
O |
1..N |
The GPSI of the requested UE(s). |
EnNB |
ip-addrs |
array(IpAddr) |
O |
1..N |
The IP address(es) of the requested UE(s). |
EnNB |
ip-domain |
string |
O |
1 |
The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. |
EnNB |
mac-addrs |
array(MacAddr48) |
O |
1..N |
The MAC address(es) of the requested UE(s). |
EnNB |
NOTE: One of the "gpsis" parameter, the "ip-addrs" parameter or the "mac-addrs" parameter may be provided in the same request. If multiple elements are provided in the array data structure, then each element shall be treated as a separate query parameter. |
This method shall support the request data structures specified in table 5.11.1.2.3.2-2 and the response data structures and response codes specified in table 5.11.1.2.3.2-3.
Table 5.11.1.2.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.11.1.2.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
array(ServiceParameterData) |
M |
0..N |
200 OK |
All the subscription information for the AF in the request URI are returned. |
N/A |
307 Temporary Redirect |
Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.2.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 in an alternative NEF. |
Table 5.11.1.2.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 in an alternative NEF. |
5.11.1.2.3.3 POST
The POST method creates a new resource to individual service parameter subscription for a given AF. The AF shall initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI of the created resource.
This method shall support the request data structures specified in table 5.11.1.2.3.3-1 and the response data structures and response codes specified in table 5.11.1.2.3.3-2.
Table 5.11.1.2.3.3-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
ServiceParameterData |
M |
1 |
Parameters to create a service parameter subscription resource. |
Table 5.11.1.2.3.3-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
ServiceParameterData |
M |
1 |
201 Created |
The subscription resource was created successfully. The URI of the created resource shall be returned in the "Location" HTTP header. |
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.2.3.3-3: 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}/3gpp-service-parameter/v1/{afId}/subscriptions/{subscriptionId} |
5.11.1.3 Resource: Individual Service Parameter Subscription
5.11.1.3.1 Introduction
This resource allows a AF to read, update or delete an existing service parameter subscription.
5.11.1.3.2 Resource Definition
Resource URI: {apiRoot}/3gpp-service-parameter/v1/{afId}/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.9.1.3.2-1.
Table 5.11.1.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
Clause 5.2.4 of 3GPP TS 29.122 [4]. |
afId |
string |
Identifier of the AF. |
subscriptionId |
string |
Identifier of the subscription resource. |
5.11.1.3.3 Resource Methods
5.11.1.3.3.1 General
The following clauses specify the resource methods supported by the resource as described in clause 5.11.1.3.3.
5.11.1.3.3.2 GET
The GET method allows to read the active subscription for a given AF and subscription Id. The AF shall initiate the HTTP GET request message and theNEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.11.1.3.3.2-1.
Table 5.11.1.3.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
N/A |
This method shall support the request data structures specified in table 5.11.1.3.3.2-2 and the response data structures and response codes specified in table 5.11.1.3.3.2-3.
Table 5.11.1.3.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.11.1.3.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
ServiceParameterData |
M |
1 |
200 OK |
The information for the subscription in the request URI are returned. |
N/A |
307 Temporary Redirect |
Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.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 in an alternative NEF. |
Table 5.11.1.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 in an alternative NEF. |
5.11.1.3.3.3 PUT
The PUT method modifies an existing resource to update a configuration. The AF shall initiate the HTTP PUT request message and the NEF shall respond to the message.
This method shall support the request data structures specified in table 5.9.1.3.3.3-1 and the response data structures and response codes specified in table 5.9.1.3.3.3-2.
Table 5.11.1.3.3.3-1: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
ServiceParameterData |
M |
1 |
Modify an existing subscription. |
Table 5.11.1.3.3.3-2: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
ServiceParameterData |
M |
1 |
200 OK |
The subscription resource was updated successfully. |
n/a |
204 No Content |
The subscription resource was updated successfully. |
||
N/A |
307 Temporary Redirect |
Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.3.3.3-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 in an alternative NEF. |
Table 5.11.1.3.3.3-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 in an alternative NEF. |
5.11.1.3.3.4 DELETE
The DELETE method deletes an existing individual subscription for a given AF. The AF shall initiate the HTTP DELETE request message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.11.1.3.3.4-1.
Table 5.11.1.3.3.4-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 5.11.1.3.3.4-2 and the response data structures and response codes specified in table 5.11.1.3.3.4-3.
Table 5.11.1.3.3.4-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
N/A |
Table 5.11.1.3.3.4-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
N/A |
204 No Content |
The subscription resource was terminated successfully. |
||
N/A |
307 Temporary Redirect |
Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.3.3.4-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 in an alternative NEF. |
Table 5.11.1.3.3.4-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 in an alternative NEF. |
5.11.1.3.3.5 PATCH
The PATCH method allows to change some properties of an existing resource to update a subscription. The AF shall initiate the HTTP PATCH request message and the NEF shall respond to the message.
This method shall support the request data structures specified in table 5.11.1.3.3.5-1 and the response data structures and response codes specified in table 5.11.1.3.3.5-2.
Table 5.11.1.3.3.5-1: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
ServiceParameterDataPatch |
M |
1 |
Partial update an existing subscription. |
Table 5.11.1.3.3.5-2: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
ServiceParameterData |
M |
1 |
200 OK |
The subscription resource was updated successfully. |
N/A |
204 No Content |
The subscription resource was updated successfully. |
||
N/A |
307 Temporary Redirect |
Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1.3.3.5-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 in an alternative NEF. |
Table 5.11.1.3.3.5-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 in an alternative NEF. |
5.11.1A Notifications
5.11.1A.1 Introduction
Upon NEF notify a Service Parameter Authorization Update (e.g. to revoke an authorization) to AF, or forward a notification event related to invocation of service parameter provisioning, e.g. the notification of outcome of UE Policies Delivery to AF, the NEF shall send an HTTP POST message including the notified event to the AF. The NEF and the AF shall support the notification mechanism as described in clause 5.2.5 of 3GPP TS 29.122 [4].
Table 5.11.1A.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
AF Notifications |
{notificationDestination} |
POST |
The notification of service parameter authorization updates and/or notification event related to the result of invocation of service parameter provisioning. |
5.11.1A.2 AF Notifications
5.11.1A.2.1 Description
The AF Notifications are used by the NEF to send the Service Parameter Authorization Update (e.g. to revoke an authorization) to the AF, and/or to send AF subscribed event notification of the outcome related to the invocation of service parameter provisioning to the AF.
5.11.1A.2.2 Target URI
The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.11.1A.2.2-1.
Table 5.11.1A.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notificationDestination |
Link |
Callback reference provided by the AF during creation/modification of the subscription within the ServiceParameterData data type as defined in Table 5.11.2.3.2-1 or the ServiceParameterDataPatch data type as defined in Table 5.11.2.3.3-1. |
5.11.1A.3 Operation Definition
5.11.1A.3.1 Notification via HTTP POST
This method shall support the request data structures specified in table 5.11.1A.3.1-1 and the response data structure with response codes specified in table 5.11.1A.3.1-2.
Table 5.11.1A.3.1-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
array(AfNotification) |
M |
1..N |
Notifications upon AF Service Parameter Authorization Update, and/or AF subscribed event notification of the outcome related to the invocation of service parameter provisioning. |
Table 5.11.1A.3.1-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
N/A |
204 No Content |
The event notification is received successfully. |
||
N/A |
307 Temporary Redirect |
Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
N/A |
308 Permanent Redirect |
Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. |
||
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. |
Table 5.11.1A.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. |
Table 5.11.1A.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. |
5.11.1A.3.2 Notification via Websocket
If supported by both AF and NEF and successfully negotiated, the AF subscribed outcome event notification related to the invocation of service parameter provisioning may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4].
5.11.2 Data Model
5.11.2.1 General
This clause specifies the application data model supported by the ServiceParameter API.
Table 5.11.2.1-1 specifies the data types defined for the ServiceParameter API.
Table 5.11.2.1-1: ServiceParameter API specific Data Types
Data type |
Clause defined |
Description |
Applicability |
ConnectionCapabilities |
5.11.2.4.6 |
UE application requests a network connection with certain capabilities. |
AfGuideURSP |
GeographicalArea |
5.17.3.3.4 |
Identifies the geographical area information. |
AfGuideURSP |
ParameterOverPc5 |
5.11.2.4.2 |
Represents configuration parameters for V2X communications over PC5 reference point. |
|
ParameterOverPc5Rm |
5.11.2.4.2 |
Represents the same as the ParameterOverPc5 data type but with the "nullable: true" property. |
|
ParameterOverUu |
5.11.2.4.2 |
Represents configuration parameters for V2X communications over Uu reference point. |
|
ParameterOverUuRm |
5.11.2.4.2 |
Represents the same as the ParameterOverUu data type but with the "nullable: true" property. |
|
ParamForProSeDc |
5.11.2.4.2 |
Represents the service parameters for 5G ProSe direct communications. |
ProSe |
ParamForProSeDcRm |
5.11.2.4.2 |
This data type is defined in the same way as the ParamForProSeDc data type, but with the OpenAPI nullable property set to true. |
ProSe |
ParamForProSeDd |
5.11.2.4.2 |
Represents the service parameters for 5G ProSe direct discovery. |
ProSe |
ParamForProSeDdRm |
5.11.2.4.2 |
This data type is defined in the same way as the ParamForProSeDd data type, but with the OpenAPI nullable property set to true. |
ProSe |
ParamForProSeRemUe |
5.11.2.4.2 |
Represents the service parameters for 5G ProSe remote UE. |
ProSe |
ParamForProSeRemUeRm |
5.11.2.4.2 |
This data type is defined in the same way as the ParamForProSeRemUe data type, but with the OpenAPI nullable property set to true. |
ProSe |
ParamForProSeU2NRelUe |
5.11.2.4.2 |
Represents the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
ParamForProSeU2NRelUeRm |
5.11.2.4.2 |
This data type is defined in the same way as the ParamForProSeU2NRelUe data type, but with the OpenAPI nullable property set to true. |
ProSe |
RouteSelectionParameterSet |
5.11.2.3.5 |
Contains parameters that can be used to guide the Route Selection Descriptors of the URSP. |
AfGuideURSP |
ServiceParameterData |
5.11.2.3.2 |
Represents an individual Service Parameter subscription resource. |
|
ServiceParameterDataPatch |
5.11.2.3.3 |
Represents the parameters to request the modification of a service parameter subscription resource. |
|
TrafficDescriptorComponents |
5.11.2.3.8 |
Traffic descriptor components for the requested URSP. |
AfGuideURSP |
UrspRuleRequest |
5.11.2.3.4 |
Contains parameters that can be used to guide the URSP. |
AfGuideURSP |
5.11.2.2 Reused data types
The data types reused by the ServiceParameter API from other specifications are listed in table 5.9.2.2-1.
Table 5.11.2.2-1: Re-used Data Types
Data type |
Reference |
Comments |
AppDescriptor |
Clause 5.7.2.3.4 |
Application descriptor describes the operation systems and the corresponding applications for each operation systems. |
Dnn |
3GPP TS 29.571 [8] |
Identifies a DNN. |
EthFlowDescription |
3GPP TS 29.514 [7] |
Defines a packet filter for an Ethernet flow. |
ExternalGroupId |
3GPP TS 29.122 [4] |
External Group Identifier for a user group. |
Gpsi |
3GPP TS 29.571 [8] |
Identifies a GPSI. |
IpAddr |
3GPP TS 29.571 [8] |
UE IP Address. |
IPv4Addr |
3GPP TS 29.571 [8] |
Identifies an IPv4 address. |
IPv6Addr |
3GPP TS 29.571 [8] |
Identifies an IPv6 address. |
Link |
3GPP TS 29.122 [4] |
|
MacAddr48 |
3GPP TS 29.571 [8] |
Identifies an MAC address. |
MtcProviderInformation |
3GPP TS 29.571 [8] |
Indicates MTC provider information. |
Snssai |
3GPP TS 29.571 [8] |
Identifies the S-NSSAI. |
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of the optional features defined in table 5.11.3-1. |
Tai |
3GPP TS 29.571 [8] |
Tracking Area Identity information. |
Uinteger |
3GPP TS 29.571 [8] |
Unsigned integer. |
5.11.2.3 Structured data types
5.11.2.3.1 Introduction
This clause defines the structured data types to be used in resource representations.
5.11.2.3.2 Type: ServiceParameterData
Table 5.11.2.3.2-1: Definition of type ServiceParameterData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
self |
Link |
C |
0..1 |
Identifies the individual service parameter subscription resource URI. Shall be present by the NEF in HTTP responses that include an object of ServiceParameterData type. |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN. (NOTE 2) (NOTE 3) |
|
snssai |
Snssai |
O |
0..1 |
Identifies an S-NSSAI. (NOTE 2) (NOTE 3) |
|
afServiceId |
string |
O |
0..1 |
Identifies a service on behalf of which the AF is issuing the request. (NOTE 2) (NOTE 3) |
|
appId |
string |
O |
0..1 |
Identifies an application identifier. (NOTE 2) |
|
gpsi |
Gpsi |
O |
0..1 |
Identifies GPSI. (NOTE 1) |
|
ueIpv4 |
Ipv4Addr |
O |
0..1 |
The IPv4 address of the served UE. (NOTE 1) |
|
ueIpv6 |
Ipv6Addr |
O |
0..1 |
The IPv6 address of the served UE. (NOTE 1) |
|
ueMac |
MacAddr48 |
O |
0..1 |
The MAC address of the served UE. (NOTE 1) |
|
exterGroupId |
ExternalGroupId |
O |
0..1 |
Represents a group of users. (NOTE 1) |
|
anyUeInd |
boolean |
O |
0..1 |
Identifies whether the service parameters apply to any UE. This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE 1) (NOTE 3) |
|
subNotifEvents |
array(Event) |
C |
1..N |
Identifies the AF subscribed event(s) notifications related to AF provisioned service parameters. (NOTE 4) |
AfNotifications |
notificationDestination |
Uri |
C |
0..1 |
Contains the callback URI to receive the notifications from the NEF. Shall be present If "subNotifEvents" attribute is included. |
AfNotifications |
requestTestNotification |
boolean |
O |
0..1 |
Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4]. Set to false or omitted otherwise. |
Notification_test_event |
websockNotifConfig |
WebsockNotifConfig |
O |
0..1 |
Configuration parameters to set up notification delivery over Websocket protocol. |
Notification_websocket |
paramOverPc5 |
ParameterOverPc5 |
O |
0..1 |
Contains the V2X service parameters used over PC5 |
|
paramOverUu |
ParameterOverUu |
O |
0..1 |
Contains the V2X service parameters used over Uu |
|
paramForProSeDd |
ParamForProSeDd |
O |
0..1 |
Contains the service parameters for 5G ProSe direct discovery. |
ProSe |
paramForProSeDc |
ParamForProSeDc |
O |
0..1 |
Contains the service parameters for 5G ProSe direct communications. |
ProSe |
paramForProSeU2NRelUe |
ParamForProSeU2NRelUe |
O |
0..1 |
Contains the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
paramForProSeRemUe |
ParamForProSeRemUe |
O |
0..1 |
Contains the service parameters for 5G ProSe remote UE. |
ProSe |
urspGuidance |
array(UrspRuleRequest) |
O |
1..N |
Contains the service parameter used to guide the URSP. |
AfGuideURSP |
mtcProviderId |
MtcProviderInformation |
O |
0..1 |
Indicates MTC provider information. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the list of Supported features used as described in clause 5.11.3. This attribute shall be provided in the POST request and in the response of successful resource creation. |
|
NOTE 1: One of individual UE identifier (i.e. "gpsi", "ueIpv4", "ueIpv6" or "ueMac" attribute), External Group Identifier (i.e. "exterGroupId" attribute) or any UE indication (i.e. "anyUeInd" attribute) shall be included. For V2X and URSP service parameter provisioning (see clause 4.4.20), only "anyUeInd", "gpsi" and "exterGroupId" attributes are applicable. NOTE 2: Either the "afServiceId" attribute, "appId" attribute or the combination of "snssai" and "dnn" attributes shall be provided. When the feature "AfGuideURSP" is supported, only the "afServiceId" attribute shall be provided for providing guidance for URSP determination. NOTE 3: When "anyUeInd" attribute is present, "appId" attribute, "afServiceId" attribute or the combination of "snssai" attribute and "dnn" attribute shall be provided. When the feature "AfGuideURSP" is supported, only the "afServiceId" attribute shall be provided for providing guidance for URSP determination. NOTE 4: The attribute may be present when the individual UE identifier (i.e. "gpsi", "ueIpv4", "ueIpv6" or "ueMac" attribute) is present. |
5.11.2.3.3 Type: ServiceParameterDataPatch
Table 5.11.2.3.3-1: Definition of type ServiceParameterDataPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
paramOverPc5 |
ParameterOverPc5Rm |
O |
0..1 |
Contains the V2X service parameters used over PC5 |
|
paramOverUu |
ParameterOverUuRm |
O |
0..1 |
Contains the V2X service parameters used over Uu |
|
paramForProSeDd |
ParamForProSeDdRm |
O |
0..1 |
Contains the service parameters for 5G ProSe direct discovery. |
ProSe |
paramForProSeDc |
ParamForProSeDcRm |
O |
0..1 |
Contains the service parameters for 5G ProSe direct communications. |
ProSe |
paramForProSeU2NRelUE |
ParamForProSeU2NRelUeRm |
O |
0..1 |
Contains the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
paramForProSeRemUe |
ParamForProSeRemUeRm |
O |
0..1 |
Contains the service parameters for 5G ProSe remote UE. |
ProSe |
urspGuidance |
array(UrspRuleRequest) |
O |
1..N |
Contains the service parameter used to guide the URSP. |
AfGuideURSP |
subNotifEvents |
array(Event) |
O |
1..N |
Identifies the AF subscribed event(s) notifications related to AF provisioned service parameters. |
AfNotifications |
notificationDestination |
Uri |
O |
0..1 |
Contains the callback URI to receive the notifications from the NEF. May be present If "subNotifEvents" attribute is included. |
AfNotifications |
5.11.2.3.4 Type: UrspRuleRequest
Table 5.11.2.3.4-1: Definition of type UrspRuleRequest
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
trafficDesc |
TrafficDescriptorComponents |
O |
0..1 |
Traffic descriptor components for the requested URSP. (NOTE 1) |
|
relatPrecedence |
Uinteger |
O |
0..1 |
Represents the relative precedence of the URSP rule within the same AF request, Lower values take precedence over higher values. Its absence means that the AF has no relative precedence requirement for the provided URSP rules. |
|
routeSelParamSets |
array(RouteSelectionParameterSet) |
O |
1..N |
Route Selection Parameter Sets, i.e. sets of parameters that may be used to guide the Route Selection Descriptors of the URSP. (NOTE 2) |
|
NOTE 1: if the "trafficDesc" attribute is not present, the NEF may derive the traffic descriptor components from the AF Service Identifier. NOTE 2: if the "routeSelParamSets" attribute is not present, the NEF may derive S-NSSAI/DNN and/or other related parameters from the AF Service Identifer according to SLA. |
5.11.2.3.5 Type: RouteSelectionParameterSet
Table 5.11.2.3.5-1: Definition of type RouteSelectionParameterSet
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dnn |
Dnn |
O |
0..1 |
DNN to be matched with the DNN of the PDU Session. |
|
snssai |
Snssai |
O |
0..1 |
S-NSSAI to be matched with the S-NSSAI of the PDU Session. |
|
precedence |
Uinteger |
O |
0..1 |
Determines the order in which the Route Selection Descriptors are to be applied. |
|
spatialValidityAreas |
array(GeographicalArea) |
O |
1..N |
Indicates where the route selection parameters apply. It may correspond to a geographical area (e.g. a geographic shape that is known to the AF and is configured by the operator to correspond to a list of TAIs). |
|
spatialValidityTais |
array(Tai) |
O |
1..N |
Indicates the TAIs in which the route selection parameters apply. This attribute is applicable only within the 5GC and it shall not be included in the request messages of untrusted AFs for URSP guidance. |
5.11.2.3.6 Type: AfNotification
Table 5.11.2.3.6-1: Definition of type AfNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
subscription |
Link |
M |
1 |
Link to the subscription resource to which this notification is related. |
|
reportEvent |
Event |
C |
0..1 |
Identifies the reported event notification. May be present if the subNotifEvent attribute is included in the AF subscription transaction. (NOTE) |
|
authResult |
AuthorizationResult |
C |
0..1 |
Indicates the service parameters authorization update result. (e.g. to revoke an authorization). (NOTE) |
|
gpsis |
array(Gpsi) |
C |
1..N |
Identifies the list of GPSI(s) of the reported UE(s). May be present if the "exterGroupId" attribute or "anyUeInd" attribute is included in the AF subscription transaction and only if the "authResult" attribute is provided. |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN. |
|
snssai |
Snssai |
O |
0..1 |
Identifies an S-NSSAI. |
|
eventInfo |
EventInfo |
O |
0..1 |
Indicates the event information. |
|
NOTE: At least one of "reportEvent" attribute and "authResult" attribute shall be included. |
5.11.2.3.7 Type: EventInfo
Table 5.11.2.3.7-1: Definition of type AfEventInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
failureCause |
Failure |
O |
0..1 |
Identify the failure reason for an unsuccessful result. May present if the reportEvent attribute value is "UNSUCCESS_UE_POL_DEL_SP". |
5.11.2.3.8 Type: TrafficDescriptorComponents
Table 5.11.2.3.8-1: Definition of type TrafficDescriptorComponents
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
appDescs |
map(AppDescriptor) |
C |
1..N |
Describes the operation systems and the corresponding applications for each operation systems. The key of map is osId. (NOTE 2) |
|
flowDescs |
array(string) |
C |
1..N |
Destination IP 3 tuple(s) (IP address or IPv6 network prefix, port number, protocol ID of the protocol above IP). The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [54], applicable only to the destination IP 3 tuple(s). (NOTE 3) |
|
domainDescs |
array(string) |
C |
1..N |
FQDN(s) or a regular expression which are used as a domain name matching criteria. (NOTE 4) |
|
ethFlowDescs |
array(EthFlowDescription) |
C |
1..N |
Descriptor(s) for destination information of non-IP traffic in which only ethernet flow description is defined. (NOTE 3) |
|
dnns |
array(Dnn) |
C |
1..N |
This is matched against the DNN information provided by the application. |
|
connCaps |
array(ConnectionCapabilities) |
C |
1..N |
This is matched against the information provided by a UE application when it requests a network connection with certain capabilities. |
|
NOTE 1: At least one attribute of the above Traffic descriptor components shall be present. NOTE 2: The information is used to identify the Application(s) that is(are) running on the UE’s OS. The OSId does not include an OS version number. The OSAppId does not include a version number for the application. NOTE 3: "flowDescs" attribute and "ethFlowDescs" attribute are mutually exclusive. NOTE 4: The match of this traffic descriptor component does not require successful DNS resolution of the FQDN provided by the UE Application. |
5.11.2.4 Simple data types and enumerations
5.11.2.4.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
5.11.2.4.2 Simple data types
The simple data types defined in table 5.11.2.4.2-1 shall be supported.
Table 5.11.2.4.2-1: Simple data types
Type Name |
Type Definition |
Description |
Applicability |
ParameterOverPc5 |
string |
Configuration parameters for V2X communication over PC5. Its encoding shall comply with the UE policies for V2X communication over PC5 as defined in clause 5.3 of 3GPP TS 24.588 [33]. |
|
ParameterOverPc5Rm |
string |
This data type is defined in the same way as the "ParameterOverPc5" data type, but with the OpenAPI "nullable: true" property. |
|
ParameterOverUu |
string |
Configuration parameters for V2X communication over Uu. Its encoding shall comply with the UE policies for V2X communication over Uu as defined in clause 5.4 of 3GPP TS 24.588 [33]. |
|
ParameterOverUuRm |
string |
This data type is defined in the same way as the "ParameterOverUu" data type, but with the OpenAPI "nullable: true" property. |
|
ParamForProSeDd |
string |
Configuration parameters for 5G ProSe direct discovery. Its encoding shall comply with the UE policies for 5G ProSe direct discovery defined in clause 5.3 of 3GPP TS 24.555 [49]. |
ProSe |
ParamForProSeDdRm |
string |
This data type is defined in the same way as the "ParamForProSeDd" data type, but with the OpenAPI "nullable: true" property. |
ProSe |
ParamForProSeDc |
string |
Configuration parameters for 5G ProSe direct communications. Its encoding shall comply with the UE policies for 5G ProSe direct communications defined in clause 5.4 of 3GPP TS 24.555 [49]. |
ProSe |
ParamForProSeDcRm |
string |
This data type is defined in the same way as the "ParamForProSeDc" data type, but with the OpenAPI "nullable: true" property. |
ProSe |
ParamForProSeU2NRelUe |
string |
Configuration parameters for 5G ProSe UE-to-network relay UE. Its encoding shall comply with the UE policies for 5G ProSe UE-to-network relay UE defined in clause 5.5 of 3GPP TS 24.555 [49]. |
ProSe |
ParamForProSeU2NRelUeRm |
string |
This data type is defined in the same way as the "ParamForProSeU2NRelUe" data type, but with the OpenAPI "nullable: true" property. |
ProSe |
ParamForProSeRemUe |
string |
Configuration parameters for 5G ProSe remote UE. Its encoding shall comply with the UE policies for 5G ProSe remote UE defined in clause 5.6 of 3GPP TS 24.555 [49]. |
ProSe |
ParamForProSeRemUeRm |
string |
This data type is defined in the same way as the "ParamForProSeRemUe" data type, but with the OpenAPI "nullable: true" property. |
ProSe |
5.11.2.4.3 Enumeration: Event
Table 5.11.2.4.3-1: Enumeration Event
The enumeration Event represents the AF subscribe to event notification of the outcome related to the invocation of AF provisioned service parameters.
Enumeration value |
Description |
SUCCESS_UE_POL_DEL_SP |
Successful UE Policy Delivery related to the invocation of AF provisioned Service Parameters. |
UNSUCCESS_UE_POL_DEL_SP |
Unsuccessful UE Policy Delivery related to the invocation of AF provisioned Service Parameters. |
5.11.2.4.4 Enumeration: AuthorizationResult
The enumeration AuthorizationResult represents the NEF notify the AF about the service parameters authorization updates result, e.g. to revoke an authorization.
Table 5.11.2.4.4-1: Enumeration AuthorizationResult
Enumeration value |
Description |
AUTH_REVOKED |
Indicated the service parameters authorization is revoked. |
5.11.2.4.5 Enumeration: Failure
The enumeration FailureCause represents the failure reason for the unsuccessful result.
Table 5.11.2.4.5-1: Enumeration Failure
Enumeration value |
Description |
UNSPECIFIED |
Indicates the PCF received the UE sent UE policy delivery service cause #111 (Protocol error, unspecified). |
UE_NOT_REACHABLE |
Indicates the PCF received the notification from the AMF that the UE is not reachable. |
UNKNOWN |
Indicates unknown reasons upon no response from the UE, e.g. UPDS message type is not defined or not implemented by the UE, or not compatible with the UPDS state, in which the UE shall ignore the UPDS message. |
UE_TEMP_UNREACHABLE |
Indicates the PCF received the notification from the AMF that the UE is not reachable but the PCF will retry again. |
5.11.2.4.6 Enumeration: ConnectionCapabilities
The enumeration ConnectionCapabilities represents the information provided by a UE application when it requests a network connection with certain capabilities.
Table 5.11.2.4.6-1: Enumeration ConnectionCapabilities
Enumeration value |
Description |
IMS |
Indicates the connection capability to support IMS service. |
MMS |
Indicates the connection capability to support MMS service. |
SUPL |
Indicates the connection capability to support SUPL service. |
INTERNET |
Indicates the connection capability to support Internet service. |
5.11.3 Used Features
The table below defines the features applicable to the ServiceParameter API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].
Table 5.11.3-1: Features used by ServiceParameter API
Feature number |
Feature Name |
Description |
1 |
ProSe |
This feature indicates the support of UE policy and N2 information provisioning for 5G ProSe. |
2 |
enNB |
Indicates the support of enhancements to the northbound interfaces. |
3 |
AfNotifications |
This feature indicates the support of AF subscribed event(s) notifications. |
4 |
Notification_websocket |
The delivery of notifications over Websocket is supported as described in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported. |
5 |
Notification_test_event |
The testing of notification connection is supported as described in 3GPP TS 29.122 [4]. |
6 |
AfGuideURSP |
This feature indicates the support of AF guidance for URSP determination. |
5.11.4 Error handling
5.11.4.1 General
HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].
In addition, the requirements in the following clauses shall apply.
5.11.4.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the ServiceParameter API.
5.11.4.3 Application Errors
The application errors defined for ServiceParameter API are listed in table 5.11.4.3-1.
Table 5.11.4.3-1: Application errors
Application Error |
HTTP status code |
Description |
Applicability |