6.2 Resources
29.5193GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure
6.2.1 Overview
This clause specifies the resources for the usage of the Unified Data Repository service for Application Data.
6.2.2 Resource Structure
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.2.2-1 depicts the resource URIs structure for the Nudr_DataRepository API for application data
Figure 6.2.2-1: Resource URI structure of the Nudr_DataRepository API for application data
Table 6.2.2-1 provides an overview of the resources and applicable HTTP methods.
Table 6.2.2-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
PFD Data |
/application-data/pfds |
GET |
Retrieve PFDs for application identifier(s) identified by query parameter(s). Retrieve PFDs for all application identifier(s) if no query parameter is included in the Request URI. |
|
Individual PFD Data |
/application-data/pfds/{appId} |
GET |
Retrieve the corresponding PFDs of the specified application identifier. |
|
DELETE |
Delete the corresponding PFDs of the specified application identifier. |
||
|
PUT |
Create or update the corresponding PFDs for the specified application identifier. |
||
|
Influence Data |
/application-data/influenceData (NOTE) |
GET |
Retrieve the Session Influence Data of given services, S-NSSAIs and DNNs or Internal Group Identifiers or SUPIs. |
|
Individual Influence Data |
/application-data/influenceData/ (NOTE) |
PUT |
Create an individual Influence Data resource identified by {influenceId}, or modify all of the properties of an individual Influence Data resource identified by {influenceId}. |
|
PATCH |
Modify part of the properties of an individual Influence Data resource identified by {influenceId}. |
||
|
DELETE |
Delete an individual Influence Data resource identified by {influenceId}. |
||
|
Influence Data Subscription |
/application-data/influenceData/ (NOTE) |
POST |
Create a new Individual Influence Data Subscription resource. |
|
GET |
Read subscriptions for a given S-NSSAI and DNN or Internal Group Identifier or SUPI. |
||
|
Individual Influence Data Subscription |
/application-data/influenceData/ (NOTE) |
GET |
Get an existing individual Influence Data Subscription resource identified by {subscriptionId}. |
|
PUT |
Modify an existing individual Influence Data Subscription resource identified by {subscriptionId}. |
||
|
DELETE |
Delete an individual Influence Data Subscription resource identified by {subscriptionId}. |
||
|
Applied BDT Policy Data |
/application-data/bdtPolicyData (NOTE) |
GET |
Retrieve the applied BDT policy data. |
|
Individual Applied BDT Policy Data |
/application-data/bdtPolicyData/{bdtPolicyId} (NOTE) |
PUT |
Create an individual applied BDT Policy Data resource identified by {bdtPolicyId}. |
|
PATCH |
Modify BDT Reference Id of an individual applied BDT Policy Data resource identified by {bdtPolicyId}. |
||
|
DELETE |
Delete an individual applied BDT Policy Data resource identified by {bdtPolicyId}. |
||
|
IPTV Configurations |
/application-data/iptvConfigData (NOTE) |
GET |
Retrieve IPTV configurations for configuration identifier(s), given S-NSSAI(s) and DNN(s), or SUPIs or Internal Group Identifiers |
|
Individual IPTV Configuation |
/application-data/iptvConfigData/ (NOTE) |
PUT |
Create an Individual IPTV Configuration resource identified by {configurationId}, or modify all the properties of an Individual IPTV Configuration resource identified by {configurationId}. |
|
PATCH |
Modify some properties of an Individual IPTV Configuration resource identified by {configurationId}. |
||
|
DELETE |
Delete an Individual IPTV Configuration resource identified by {configurationId} |
||
|
Service Parameter Data |
/application-data/serviceParamData (NOTE) |
GET |
Retrieve the Service Parameter Data of given services, S-NSSAIs and DNNs or Internal Group Identifiers or SUPIs. |
|
Individual Service Parameter Data |
/application-data/serviceParamData/ (NOTE) |
PUT |
Create an individual Service Parameter Data resource identified by {serviceParamId}, or modify all of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. |
|
PATCH |
Modify part of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. |
||
|
DELETE |
Delete an individual Service Parameter Data resource identified by {serviceParamId}. |
||
|
AM Influence Data |
/application-data/am-influence-data |
GET |
Retrieve the AM Influence Data of given S-NSSAIs and DNNs and/or Internal Group Identifiers or SUPIs. |
|
Individual AM Influence Data |
/application-data/am-influence-data/{amInfluenceId} |
PUT |
Create an individual AM Influence Data resource identified by {amInfluenceId}, or modify all of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. |
|
PATCH |
Modify part of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. |
||
|
DELETE |
Delete an individual AM Influence Data resource identified by {amInfluenceId}. |
||
|
ApplicationDataSubscriptions |
/application-data/subs-to-notify |
POST |
Create a subscription to receive notification of application data changes. |
|
GET |
Read all the subscriptions, or subscriptions for given S-NSSAI and DNN or Internal Group Identifier or SUPI. |
||
|
IndividualApplicationDataSubscription |
/application-data/subs-to-notify/ |
PUT |
Modify a subscription to receive notification of application data changes identified by {subsId}. |
|
DELETE |
Delete a subscription identified by {subsId}. |
||
|
GET |
Read an existing individual Subscription resource identified by {subsId}. |
||
|
EAS Deployment Information Data |
/application-data/eas-deploy-data |
GET |
Retrieve the EAS Deployment Information Data, given DNN(s), S-NSSAI(s), Application ID or Internal Group Identifiers. |
|
Individual EAS Deployment Information Data |
/application-data/eas-deploy-data/{easDeployInfoId} |
GET |
Read an existing individual EAS Deployment Data identified by {easDeployInfoId}. |
|
PUT |
Create an individual EAS deployment information Data resource identified by {easDeployInfold} or Update an individual EAS Deployment Data resource identified by {easDeployInfoId}. |
||
|
DELETE |
Delete an individual EAS Deployment Data resource identified by {easDeployInfoId}. |
||
|
NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [5]. The path segment is kept though as defined in the current specification for backward compatibility considerations. |
|||
6.2.3 Resource: PFD Data
6.2.3.1 Description
The PFD Data resource represents all the PFD Datas to the Nudr_DataRepository Service at a given UDR.
6.2.3.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/pfds
Table 6.2.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.3.3 Resource Standard Methods
6.2.3.3.1 GET
This method shall support the URI query parameters specified in table 6.2.3.3.1-1.
Table 6.2.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
appId |
array(ApplicationId) |
O |
1..N |
Contains the information of the application identifier(s) for the querying PFD Data resource. If the appId query paremeter is not included in the URI, the query applies to all application identifier(s) for the querying PFD Data resource. If the appId array contains one or more ApplicationId entries, the UDR returns an Individual PFD Data resource representation for each matched ApplicationId. |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
The features supported by the NF service consumer. |
This method shall support the request data structures specified in table 6.2.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.1-3.
Table 6.2.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(PfdDataForAppExt) |
M |
0..N |
200 OK |
A representation of PFDs for request applications is returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.4 Resource: Individual PFD Data
6.2.4.1 Description
The Individual PFD Data resource represents Individual PFD Datas to the Nudr_DataRepository Service at a given UDR.
6.2.4.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/pfds/{appId}
This resource shall support the resource URI variables defined in table 6.2.4.2-1.
Table 6.2.4.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
appId |
ApplicationId |
Indicates the application identifier for the request pfd(s). Data type ApplicationId is defined in 3GPP TS 29.571 [7]. |
6.2.4.3 Resource Standard Methods
6.2.4.3.1 GET
This method shall support the URI query parameters specified in table 6.2.4.3.1-1.
Table 6.2.4.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
The features supported by the NF service consumer. |
This method shall support the request data structures specified in table 6.2.4.3.1-2 and the response data structures and response codes specified in table 6.2.4.3.1-3.
Table 6.2.4.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.4.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PfdDataForAppExt |
M |
1 |
200 OK |
A representation of PFDs for the request application identified by the application identifier is returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.4.3.2 DELETE
This method shall support the URI query parameters specified in table 6.2.4.3.2-1.
Table 6.2.4.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.2.4.3.2-2 and the response data structures and response codes specified in table 6.2.4.3.2-3.
Table 6.2.4.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.4.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 case. The Individual PFD Data resource related to the application identifier was deleted. |
||
|
NOTE: 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. |
||||
6.2.4.3.3 PUT
This method shall support the URI query parameters specified in table 6.2.4.3.3-1.
Table 6.2.4.3.3-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.2.4.3.3-2 and the response data structures and response codes specified in table 6.2.4.3.3-3.
Table 6.2.4.3.3-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
PfdDataForAppExt |
M |
1 |
Contains the information for the creation or modification of an individual PFD Data resource. |
Table 6.2.4.3.3-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PfdDataForAppExt |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
PfdDataForAppExt |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.4.3.3-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/pfds/{appId} |
6.2.5 Resource: Influence Data
6.2.5.1 Description
The Influence Data resource represents a Traffic Influence Data to the Nudr_DataRepository Service at a given UDR.
6.2.5.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData
This resource shall support the resource URI variables defined in table 6.2.5.2-1.
Table 6.2.5.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.5.3 Resource Standard Methods
6.2.5.3.1 GET
This method shall support the URI query parameters specified in table 6.2.5.3.1-1.
Table 6.2.5.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
influence-Ids |
array(string) |
O |
1..N |
Each element identifies a influenceId, i.e. an Individual Influence Data resource. |
|
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. The UDR shall return only Individual Influence Data resource(s) that match one of the provided DNNs. |
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. The UDR shall return only Individual Influence Data resource(s) that match one of the provided S-NSSAIs. |
|
internal-Group-Ids |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. The UDR shall return only Individual Influence Data resource(s) that match one of the provided internal group IDs. |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Influence Data resource(s) that match one of the provided SUPIs. |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
Identifies the features supported by the NF service consumer. |
|
NOTE: At least one of the "influence-Ids", "dnns", "snssais", "internal-Groups-Ids" or "supis" attributes shall be provided. |
||||
NOTE: The "internal-Goup-Ids" and the "supis" query parameter represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource.
When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters.
EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI_1 and S-NSSAI_2) and "dnns" is included with two DNN entries (e.g. DNN_A and DNN_B), and the other optional query parameters are not included, the UDR shall return the Individual Influence Data resources for each matching S-NSSAI and DNN combination (for all the possible values for supi and groupId), i.e., the resource(s) matching SNSSAI_1 and DNN_A, the resource(s) matching SNSSAI_1 and DNN_B, the resource(s) matching SNSSAI_2 and DNN_A, and the resource(s) matching SNSSAI_2 and DNN_B.
To query for the Individual Influence Data resource(s) that apply to any UE, an entry of the "internal-Group-Ids" shall be set to "AnyUE".
This method shall support the request data structures specified in table 6.2.5.3.1-2 and the response data structures and response codes specified in table 6.2.5.3.1-3.
Table 6.2.5.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.5.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(TrafficInfluData) |
M |
0..N |
200 OK |
The Traffic Influence Data stored in the UDR are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.6 Resource: Individual Influence Data
6.2.6.1 Description
The Individual Influence Data resource represents an Individual Traffic Influence Data to the Nudr_DataRepository Service at a given UDR.
6.2.6.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData/{influenceId}
This resource shall support the resource URI variables defined in table 6.2.6.2-1.
Table 6.2.6.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
influenceId |
string |
The Identifier of an Individual Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.6.3 Resource Standard Methods
6.2.6.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.6.3.1-1.
Table 6.2.6.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.6.3.1-2 and the response data structures and response codes specified in table 6.2.6.3.1-3.
Table 6.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TrafficInfluData |
M |
1 |
The Traffic Influence Data to be stored in the UDR. |
Table 6.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
TrafficInfluData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
TrafficInfluData |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.6.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData/{influenceId} |
6.2.6.3.2 PATCH
This method shall support the URI query parameters specified in table 6.2.6.3.2-1.
Table 6.2.6.3.2-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3.
Table 6.2.6.3.2-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TrafficInfluDataPatch |
M |
1 |
The Traffic Influence Data to be updated in the UDR. |
Table 6.2.6.3.2-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
TrafficInfluData |
M |
1 |
200 OK |
The update of an Individual Traffic Influence Data resource is confirmed and a response body containing Traffic Influence Data shall be returned. |
|
n/a |
204 No Content |
The Individual Traffic Influence Data resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.6.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.6.3.3-1.
Table 6.2.6.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.6.3.3-2 and the response data structures and response codes specified in table 6.2.6.3.3-3.
Table 6.2.6.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.6.3.3-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 Individual Influence Data was deleted successfully. |
||
|
NOTE: 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. |
||||
6.2.7 Resource: Influence Data Subscription
6.2.7.1 Description
The Influence Data Subscription resource represents all Influence Data subscriptions to the Nudr_DataRepository Service at a given UDR.
6.2.7.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData/subs-to-notify
This resource shall support the resource URI variables defined in table 6.2.7.2-1.
Table 6.2.7.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.7.3 Resource Standard Methods
6.2.7.3.1 POST
This method shall support the URI query parameters specified in table 6.2.7.3.1-1.
Table 6.2.7.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.2.7.3.1-2 and the response data structures and response codes specified in table 6.2.7.3.1-3.
Table 6.2.7.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TrafficInfluSub |
M |
1 |
Parameters to register a subscription to Traffic Influence Data. |
Table 6.2.7.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
TrafficInfluSub |
M |
1 |
201 Created |
The subscription was created successfully. |
|
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.7.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData/subs-to-notify/{subscriptionId} |
6.2.7.3.2 GET
This method shall support the URI query parameters specified in table 6.2.7.3.2-1.
Table 6.2.7.3.2-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN. |
|
snssai |
Snssai |
O |
0..1 |
Identifies a slice. |
|
internal-Group-Id |
GroupId |
O |
0..1 |
Identifies a group of users.(NOTE 2) |
|
supi |
Supi |
O |
0..1 |
Identifies a user. |
|
NOTE 1: At least one of the above attribute shall be provided. NOTE 2: For the Traffic Influence Data applies to any UE, the "internal-Group-Id" sets to "AnyUE". |
||||
This method shall support the request data structures specified in table 6.2.7.3.2-2 and the response data structures and response codes specified in table 6.2.7.3.2-3.
Table 6.2.7.3.2-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.7.3.2-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(TrafficInfluSub) |
M |
0..N |
200 OK |
The subscription information as request in the request URI query parameter(s) are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.8 Resource: Individual Influence Data Subscription
6.2.8.1 Description
The Individual Influence Data Subscription resource represents a single Influence Data subscription to the Nudr_DataRepository Service at a given UDR.
6.2.8.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/influenceData/subs-to-notify/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.2.8.2-1.
Table 6.2.8.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
subscriptionId |
string |
Identifies an Individual Influence Data Subscription resource. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.8.3 Resource Standard Methods
6.2.8.3.1 GET
This method shall support the URI query parameters specified in table 6.2.8.3.1-1.
Table 6.2.8.3.1-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 6.2.8.3.1-2 and the response data structures and response codes specified in table 6.2.8.3.1-3.
Table 6.2.8.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.8.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
TrafficInfluSub |
M |
1 |
200 OK |
The subscription information is returned. |
6.2.8.3.2 PUT
This method shall support the URI query parameters specified in table 6.2.8.3.2-1.
Table 6.2.8.3.2-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.2.8.3.2-2 and the response data structures and response codes specified in table 6.2.8.3.2-3.
Table 6.2.8.3.2-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TrafficInfluSub |
M |
1 |
Modify an existing subscription to Traffic Influence Data. |
Table 6.2.8.3.2-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
TrafficInfluSub |
M |
1 |
200 OK |
The subscription was updated successfully. |
|
n/a |
204 No Content |
The subscription has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.8.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.8.3.3-1.
Table 6.2.8.3.3-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.2.8.3.3-2 and the response data structures and response codes specified in table 6.2.8.3.3-3.
Table 6.2.8.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.8.3.3-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 was terminated successfully. |
||
|
NOTE: 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. |
||||
6.2.9 Resource: Applied BDT Policy Data
6.2.9.1 Description
The Applied BDT Policy Data resource represents an applied BDT Policy Data to the Nudr_DataRepository Service at a given UDR.
6.2.9.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/bdtPolicyData
This resource shall support the resource URI variables defined in table 6.2.9.2-1.
Table 6.2.9.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.9.3 Resource Standard Methods
6.2.9.3.1 GET
This method shall support the URI query parameters specified in table 6.2.9.3.1-1.
Table 6.2.9.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
bdt-policy-ids |
array(string) |
O |
1..N |
Each element identifies a bdtPolicyId, i.e., an identifier of an Individual BDT Policy Data resource. The UDR shall return an Individual Applied BDT Policy Data resource for each matched bdtPolicyId. |
|
internal-group-ids |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided internal group ID(s). |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided SUPI(s). |
NOTE: The "internal-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource.
When the request contains the "bdt-policy-ids" and the "internal-group-ids" or "supis" query parameters, the UDR shall return the resource(s) that match any combination of the values of the "bdt-policy-ids" and the "internal-group-ids" or "supis" arrays.
EXAMPLE: If "bdt-policy-ids" query parameter is included with two bdtPolicyId entries (bdtPolicyId_1 and bdtPolicyId_2) and "supis" is included with two SUPI entries (e.g. SUPI_A and SUPI_B), the UDR shall return the Individual BDT Policy Data resource(s) for each matching bdtPolicyId and SUPI combination i.e., the resource(s) matching bdtPolicyId_1 and SUPI_A or SUPI_B, and the resource(s) matching bdtPolicyId_2 and SUPI A or SUPI_B (note that other combinations are not possible).
This method shall support the request data structures specified in table 6.2.9.3.1-2 and the response data structures and response codes specified in table 6.2.9.3.1-3.
Table 6.2.9.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.9.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(BdtPolicyData) |
M |
0..N |
200 OK |
The applied BDT Policy Data stored in the UDR are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.10 Resource: Individual Applied BDT Policy Data
6.2.10.1 Description
The Individual Applied BDT Policy Data resource represents an Individual Applied BDT Policy Data to the Nudr_DataRepository Service at a given UDR.
6.2.10.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/bdtPolicyData/{bdtPolicyId}
This resource shall support the resource URI variables defined in table 6.2.10.2-1.
Table 6.2.10.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
bdtPolicyId |
string |
The Identifier of an Individual BDT Policy Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.10.3 Resource Standard Methods
6.2.10.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.10.3.1-1.
Table 6.2.10.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.10.3.1-2 and the response data structures and response codes specified in table 6.2.10.3.1-3.
Table 6.2.10.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
BdtPolicyData |
M |
1 |
The applied BDT Policy Data to be stored in the UDR. |
Table 6.2.10.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
BdtPolicyData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.10.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/bdtPolicyData/{bdtPolicyId} |
6.2.10.3.2 PATCH
This method shall support the URI query parameters specified in table 6.2.10.3.2-1.
Table 6.2.10.3.2-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.10.3.2-2 and the response data structures and response codes specified in table 6.2.10.3.2-3.
Table 6.2.10.3.2-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
BdtPolicyDataPatch |
M |
1 |
The applied BDT Policy Data to be updated in the UDR. |
Table 6.2.10.3.2-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
BdtPolicyData |
M |
1 |
200 OK |
The update of an applied BDT Policy Data resource is confirmed and a response body containing applied BDT Policy Data shall be returned. |
|
n/a |
204 No Content |
The update of an applied BDT Policy Data resource is confirmed. |
||
|
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.10.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.10.3.3-1.
Table 6.2.10.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.10.3.3-2 and the response data structures and response codes specified in table 6.2.10.3.3-3.
Table 6.2.10.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.10.3.3-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 Individual Applied BDT Policy Data was deleted successfully. |
||
|
NOTE: 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. |
||||
6.2.11 Resource: IPTV Configurations
6.2.11.1 Description
This resource allows the NF service consumer to read all active IPTV Configurations applicable for given configuration identifier(s), DNN(s) and/or S-NSSAI(s), SUPI(s) or Internal Group Identifier(s) stored at the UDR.
6.2.11.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/iptvConfigData
This resource shall support the resource URI variables defined in table 6.2.11.2-1.
Table 6.2.11.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.11.3 Resource Standard Methods
6.2.11.3.1 GET
This method shall support the URI query parameters specified in table 6.2.11.3.1-1.
Table 6.2.11.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
config-ids |
array(string) |
O |
1..N |
Each element identifies a configurationId, i.e. an Individual IPTV Configuration resource. The UDR shall return an Individual IPTV Configuration resource for each matched configurationId. |
|
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided DNN(s). |
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided S-NSSAI(s). |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a SUPI. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided SUPI(s). |
|
inter-group-ids |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided internal group ID(s). |
|
NOTE: At least one of the above attributes shall be provided. |
||||
NOTE: The "inter-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource.
When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual IPTV Configuration resources for each matching combination of the values of the provided query parameters.
EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI_1 and S-NSSAI_2) and "dnns" is included with two DNN entries (e.g. DNN_A and DNN_B), and the other optional query parameters are not included, the UDR shall return IPTV Configuration resources for each matching (for all the possible values for supi, and groupId), i.e. the resource(s) matching SNSSAI_1 and DNN_A, the resource(s) matching SNSSAI_1 and DNN_B, the resource(s) matching SNSSAI_2 and DNN_A, and the resources matching SNSSAI_2 and DNN_B.
This method shall support the request data structures specified in table 6.2.11.3.1-2 and the response data structures and response codes specified in table 6.2.11.3.1-3.
Table 6.2.11.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.11.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(IptvConfigData) |
M |
0..N |
200 OK |
The IPTV configuration data stored in the UDR are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.12 Resource: Individual IPTV Configuration
6.2.12.1 Description
The resource allows the NF sevice consumer to create an Individual IPTV configuration Data, modify or delete an existing Individual IPTV configuration Data.
6.2.12.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/iptvConfigData/{configurationId}
This resource shall support the resource URI variables defined in table 6.2.12.2-1.
Table 6.2.12.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
configurationId |
string |
The Identifier of an Individual IPTV Configuration to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.12.3 Resource Standard Methods
6.2.12.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.12.3.1-1.
Table 6.2.12.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.12.3.1-2 and the response data structures and response codes specified in table 6.2.12.3.1-3.
Table 6.2.12.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
IptvConfigData |
M |
1 |
The IPTV configuration data to be stored in the UDR. |
Table 6.2.12.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
IptvConfigData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
IptvConfigData |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.12.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/iptvConfigData/{configurationId} |
6.2.12.3.2 DELETE
This method shall support the URI query parameters specified in table 6.2.12.3.2-1.
Table 6.2.12.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.12.3.2-2 and the response data structures and response codes specified in table 6.2.12.3.2-3.
Table 6.2.12.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.12.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 |
The resource was deleted successfully. |
||
|
NOTE: 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. |
||||
6.2.12.3.3 PATCH
This method shall support the URI query parameters specified in table 6.2.12.3.3-1.
Table 6.2.12.3.3-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.12.3.3-2 and the response data structures and response codes specified in table 6.2.12.3.3-3.
Table 6.2.12.3.3-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
IptvConfigDataPatch |
M |
1 |
The IPTV configuration related data to be updated in the UDR. |
Table 6.2.12.3.3-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
IptvConfigData |
M |
1 |
200 OK |
The resource has been successfully updated. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.13 Resource: ApplicationDataSubscriptions
6.2.13.1 Description
This resource is used to represent subscriptions to notification of application data modification, e.g. PFD data change, IPTV configuration data change, BDT policy data change, but not for Traffic Influence Data.
6.2.13.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/subs-to-notify
This resource shall support the resource URI variables defined in table 6.2.13.2-1.
Table 6.2.13.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.13.3 Resource Standard Methods
6.2.13.3.1 POST
This method shall support the URI query parameters specified in table 6.2.13.3.1-1.
Table 6.2.13.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.2.13.3.1-2 and the response data structures and response codes specified in table 6.2.13.3.1-3.
Table 6.2.13.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ApplicationDataSubs |
M |
1 |
Identifies the subscription to notification of application data modification. |
Table 6.2.13.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ApplicationDataSubs |
M |
1 |
201 Created |
Upon success, a response body containing a representation of each Individual subscription resource shall be returned. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. |
|
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.13.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/subs-to-notify/{subsId} |
6.2.13.3.2 GET
This method shall support the URI query parameters specified in table 6.2.13.3.2-1.
Table 6.2.13.3.2-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
data-filter |
DataFilter |
O |
0..1 |
Indicate the data filter (e.g. dnn) for the query. When present, the UDR shall return the IndividualApplicationDataSubscription resource(s) for which the indicated information in the "data-filter" query parameter matches an entry of the "dataFilters" property of the resource (i.e. within the resource representation in the ApplicationDataSubs data structure). If the values of the "dataFilters" entry match the values provided in the "data-filter" query parameter, then the entry is considered to be a match even if it contains further attributes, for which no value was provided in the "data-filter" query parameter. |
This method shall support the request data structures specified in table 6.2.13.3.2-2 and the response data structures and response codes specified in table 6.2.13.3.2-3.
Table 6.2.13.3.2-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.13.3.2-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(ApplicationDataSubs) |
M |
0..N |
200 OK |
The subscription information as request in the request URI query parameter(s) are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.14 Resource: IndividualApplicationDataSubscription
6.2.14.1 Description
This resource is used to represent an individual subscription to notification of application data modification.
6.2.14.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/subs-to-notify/{subsId}
This resource shall support the resource URI variables defined in table 6.2.14.2-1.
Table 6.2.14.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
subsId |
string |
The subsId identifies an individual application data subscription to notifications. The value is allocated by the UDR during creation of the ApplicationDataSubscriptions resource. |
6.2.14.3 Resource Standard Methods
6.2.14.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.14.3.1-1.
Table 6.2.14.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.2.14.3.1-2 and the response data structures and response codes specified in table 6.2.14.3.1-3.
Table 6.2.14.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ApplicationDataSubs |
M |
1 |
Updates the subscription to notification of application data modification. |
Table 6.2.14.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ApplicationDataSubs |
M |
1 |
200 OK |
The individual subscription resource was updated successfully. |
|
n/a |
204 No Content |
The individual subscription resource was updated successfully and no additional content is to be sent in the response message. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.14.3.2 DELETE
This method shall support the URI query parameters specified in table 6.2.14.3.2-1.
Table 6.2.14.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.2.14.3.2-2 and the response data structures and response codes specified in table 6.2.14.3.2-3.
Table 6.2.14.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
The request body shall be empty. |
Table 6.2.14.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 |
Upon success, an empty response body shall be returned. |
||
|
NOTE: 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. |
||||
6.2.14.3.3 GET
This method shall support the URI query parameters specified in table 6.2.14.3.3-1.
Table 6.2.14.3.3-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 6.2.14.3.3-2 and the response data structures and response codes specified in table 6.2.14.3.3-3.
Table 6.2.14.3.3-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.14.3.3-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ApplicationDataSubs |
M |
1 |
200 OK |
The subscription information is returned. |
6.2.15 Resource: Service Parameter Data
6.2.15.1 Description
The Service Parameter Data resource represents a Service Parameter Data to the Nudr_DataRepository Service at a given UDR.
6.2.15.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/serviceParamData
This resource shall support the resource URI variables defined in table 6.2.15.2-1.
Table 6.2.15.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.15.3 Resource Standard Methods
6.2.15.3.1 GET
This method shall support the URI query parameters specified in table 6.2.15.3.1-1.
Table 6.2.15.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
service-param-ids |
array(string) |
O |
1..N |
Each element identifies a serviceParamId, i.e., an Individual Service Parameter Data. The UDR shall return an Individual Service Parameter Data resource for each matched serviceParamId. |
|
|
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided DNNs. |
|
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided S-NSSAIs. |
|
|
internal-group-ids |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided internal group IDs. |
|
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided SUPIs. |
|
|
ue-ipv4s |
array(Ipv4Addr) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv4 addresses. |
|
|
ue-ipv6s |
array(Ipv6Addr) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv6 addresses. |
|
|
ue-macs |
array(MacAddr48) |
O |
1..N |
Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided UE MAC addresses. |
|
|
any-ue |
boolean |
O |
0..1 |
Indicates whether the request is for any UE. The UDR shall return only Individual Service Parameter Data resource(s) that match the any UE indication. |
FilterAnyUE |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
Identifies the features supported by the NF service consumer. |
|
|
NOTE 1: At least one of the "service-param-ids", "dnns", "snssais", "internal-groups-ids", "supis", "any_ue", "ue-ipv4s", "ue-ipv6s" or "ue-macs", and if the feature FilterAnyUE is supported, or "any-ue" attributes shall be provided. |
|||||
NOTE: The "any-ue" query parameter is commonly related to the search of the service parameter data resource(s) that relate to any UE using the service identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnns" and "snssais" query parameters. Note that, if the "any-ue" query parameter is present together with the "internal-groups-ids", "supis", "ue-ipv4s", "ue-ipv6s" and/or "ue-macs" query parameters the search will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "ueIpv4", "ueIpv6" or "ueMac" properties are simultaneously present in the resource.
When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Service Parameter Data resources for each matching combination of the values of the elements of the array of the provided query parameters.
EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI_1 and S-NSSAI_2) and "dnns" is included with two DNN entries (e.g. DNN_A and DNN_B), and the other optional query parameters are not included, the UDR shall return the Individual Service Parameter Data resources for each matching S-NSSAI and DNN, i.e., the resource(s) matching SNSSAI_1 and DNN_A, the resource(s) matching SNSSAI_1 and DNN_B, the resource(s) matching SNSSAI_2 and DNN_A, and the resources matching SNSSAI_2 and DNN_B.
This method shall support the request data structures specified in table 6.2.15.3.1-2 and the response data structures and response codes specified in table 6.2.15.3.1-3.
Table 6.2.15.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.15.3.1-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 |
The Service Parameter Data stored in the UDR are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.16 Resource: Individual Service Parameter Data
6.2.16.1 Description
The Individual Service Parameter Data resource represents an Individual Service Parameter Data to the Nudr_DataRepository Service at a given UDR.
6.2.16.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/serviceParamData/{serviceParamId}
This resource shall support the resource URI variables defined in table 6.2.16.2-1.
Table 6.2.16.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
serviceParamId |
string |
The Identifier of an Individual Service Parameter Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.16.3 Resource Standard Methods
6.2.16.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.16.3.1-1.
Table 6.2.16.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.16.3.1-2 and the response data structures and response codes specified in table 6.2.16.3.1-3.
Table 6.2.16.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ServiceParameterData |
M |
1 |
The Service Parameter Data to be stored in the UDR. |
Table 6.2.16.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ServiceParameterData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
ServiceParameterData |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.16.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/serviceParamData/{serviceParamId} |
6.2.16.3.2 PATCH
This method shall support the URI query parameters specified in table 6.2.16.3.2-1.
Table 6.2.16.3.2-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3.
Table 6.2.16.3.2-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ServiceParameterDataPatch |
M |
1 |
The Service Parameter Data to be updated in the UDR. |
Table 6.2.16.3.2-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ServiceParameterData |
M |
1 |
200 OK |
The update of an Individual Service Parameter Data resource is confirmed and a response body containing Service Parameter Data shall be returned. |
|
n/a |
204 No Content |
The Individual Service Parameter Data resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.16.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.16.3.3-1.
Table 6.2.16.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.16.3.3-2 and the response data structures and response codes specified in table 6.2.16.3.3-3.
Table 6.2.16.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.16.3.3-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 Individual Service Parameter Data was deleted successfully. |
||
|
NOTE: 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. |
||||
6.2.17 Resource: AM Influence Data
6.2.17.1 Description
The AM Influence Data resource represents an AM Influence Data to the Nudr_DataRepository Service at a given UDR.
6.2.17.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/am-influence-data
This resource shall support the resource URI variables defined in table 6.2.17.2-1.
Table 6.2.17.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.17.3 Resource Standard Methods
6.2.17.3.1 GET
This method shall support the URI query parameters specified in table 6.2.17.3.1-1.
Table 6.2.17.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
am-influence-ids |
array(string) |
O |
1..N |
Each element identifies a amInfluenceId, i.e., an identifier of an Individual AM Influence Data resource. The UDR shall return an Individual AM Influence Data resource that matches one of provided amInfluenceId(s). |
|
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. The UDR shall return only AM Influence Data resource(s) that match at least one of the DNN(s) of the array. (NOTE 2) |
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. The UDR shall return only AM Influence Data resource(s) that match at least one of the S-NSSAI(s) of the array. (NOTE 2) |
|
dnn-snssai-infos |
array(DnnSnssaiInformation) |
O |
1..N |
Each element identifies a combination of (DNN, S-NSSAI). The UDR shall return only AM Influence Data resource(s) that match at least one of the SNSSAI and DNN combination(s) of the array. (NOTE 2) |
|
internal-group-ids |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. The UDR shall return only AM Influence Data resource(s) that match one of the provided GroupId(s). |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a user. The UDR shall return only AM Influence Data resource(s) that match one of the provided SUPI(s). |
|
any-ue |
boolean |
O |
0..1 |
Indicates whether the request is for any UE. The UDR shall return only AM Influence Data resource(s) that contain the Any UE indication. |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
Identifies the features supported by the NF service consumer. |
|
NOTE 1: At least one of the query parameters other than the "supp-feat" query parameter shall be provided. NOTE 2: Only one of the "dnns", "snssais" or "dnn-snssai-infos" attributes may be simultaneously provided. |
||||
NOTE: The "any-ue" query parameter is commonly related to the search of the AM influence data resource(s) that relate to any UE using the service(s) identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnn-snssai-infos" query parameters. Note also that, if the "any-ue" query parameter is present together with the "internal-groups-ids", and/or "supis" query parameters the search will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd" and "interGroupId" properties are simultaneously present in the resource.
When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual AM Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters.
EXAMPLE 1: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combinations (comb_1 and comb_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI_A and SUPI_B), and all of them are matching entries, the UDR shall return the Individual AM Influence Data resources for each matching S-NSSAI and DNN and SUPI combination, i.e. the resource(s) matching comb_1 and SUPI_A, comb_2 and SUPI_A, comb_1 and SUPI_B, and comb2 and SUPI_B.
EXAMPLE 2: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combination (comb_1 and comb_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI_A and SUPI_B), and there are no matching entries for comb_1, the UDR shall return the Individual AM Influence Data resources for the matching S-NSSAI and DNN and SUPI combination, i.e., the resource(s) matching comb_2 and SUPI_A, and comb2 and SUPI_B.
This method shall support the request data structures specified in table 6.2.17.3.1-2 and the response data structures and response codes specified in table 6.2.17.3.1-3.
Table 6.2.17.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.17.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(AmInfluData) |
M |
0..N |
200 OK |
The AM Influence Data stored in the UDR are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.18 Resource: Individual AM Influence Data
6.2.18.1 Description
The Individual AM Influence Data resource represents an Individual AM Influence Data to the Nudr_DataRepository Service at a given UDR.
6.2.18.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/am-influence-data/{amInfluenceId}
This resource shall support the resource URI variables defined in table 6.2.18.2-1.
Table 6.2.18.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
amInfluenceId |
string |
The identifier of an Individual AM Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. |
6.2.18.3 Resource Standard Methods
6.2.18.3.1 PUT
This method shall support the URI query parameters specified in table 6.2.18.3.1-1.
Table 6.2.18.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.18.3.1-2 and the response data structures and response codes specified in table 6.2.18.3.1-3.
Table 6.2.18.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
AmInfluData |
M |
1 |
The AM Influence Data to be stored in the UDR. |
Table 6.2.18.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
AmInfluData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
AmInfluData |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.18.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/am-influence-data/{amInfluenceId} |
6.2.18.3.2 PATCH
This method shall support the URI query parameters specified in table 6.2.18.3.2-1.
Table 6.2.18.3.2-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.18.3.2-2 and the response data structures and response codes specified in table 6.2.18.3.2-3.
Table 6.2.18.3.2-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
AmInfluDataPatch |
M |
1 |
The AM Influence Data to be updated in the UDR. |
Table 6.2.18.3.2-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
AmInfluData |
M |
1 |
200 OK |
The update of an Individual AM Influence Data resource is confirmed and a response body containing the AM Influence Data shall be returned. |
|
n/a |
204 No Content |
The Individual AM Influence Data resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.18.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.18.3.3-1.
Table 6.2.18.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.18.3.3-2 and the response data structures and response codes specified in table 6.2.18.3.3-3.
Table 6.2.18.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.18.3.3-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 Individual AM Influence Data was deleted successfully. |
||
|
NOTE: 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. |
||||
6.2.19 Resource: EAS Deployment Information Data
6.2.19.1 Description
The EAS Deployment Information Data resource represents all EAS Deployment Information Data subscriptions to the Nudr_DataRepository Service at a given UDR.
6.2.19.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/eas-deploy-data
This resource shall support the resource URI variables defined in table 6.2.19.2-1.
Table 6.2.19.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
6.2.19.3 Resource Standard Methods
6.2.19.3.1 GET
This method shall support the URI query parameters specified in table 6.2.19.3.1-1.
Table 6.2.19.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN. |
|
snssai |
Snssai |
O |
0..1 |
Identifies a slice. |
|
internal-group-id |
GroupId |
O |
0..1 |
Identifies a group of users. |
|
appId |
string |
O |
0..1 |
Identifies an application. |
|
NOTE: At least one of the above attributes shall be provided. |
||||
This method shall support the request data structures specified in table 6.2.19.3.1-2 and the response data structures and response codes specified in table 6.2.19.3.1-3.
Table 6.2.19.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.19.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(EasDeployInfoData) |
M |
1..N |
200 OK |
The subscribed EAS Deployment information as request in the request URI query parameter(s) are returned. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
6.2.20 Resource: Individual EAS Deployment Information Data
6.2.20.1 Description
The Individual EAS Deployment Information Data resource represents a single EAS Deployment Information data subscription to the Nudr_DataRepository Service at a given UDR.
6.2.20.2 Resource definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/application-data/eas-deploy-data/{easDeployInfoId}
This resource shall support the resource URI variables defined in table 6.2.20.2-1.
Table 6.2.20.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See 3GPP TS 29.504 [6] clause 6.1.1. |
|
easDeployInfoId |
string |
Identifies an Individual EAS Deployment Information Data resource. |
6.2.20.3 Resource Standard Methods
6.2.20.3.1 GET
This method shall support the URI query parameters specified in table 6.2.20.3.1-1.
Table 6.2.20.3.1-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 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3.
Table 6.2.20.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.20.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EasDeployInfoData |
M |
1 |
200 OK |
The subscription information is returned. |
6.2.20.3.2 PUT
This method shall support the URI query parameters specified in table 6.2.20.3.1-1.
Table 6.2.20.3.1-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
n/a |
This method shall support the request data structures specified in table 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3.
Table 6.2.20.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EasDeployInfoData |
M |
1 |
The EAS Deployment Information Data to be stored in the UDR. |
Table 6.2.20.3.1-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EasDeployInfoData |
M |
1 |
201 Created |
The resource has been successfully created and a response body is returned containing a representation of the resource. |
|
EasDeployInfoData |
M |
1 |
200 OK |
The resource has been successfully updated and a response body is returned containing a representation of the resource. |
|
n/a |
204 No Content |
The resource has been successfully updated. |
||
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 6.2.20.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/application-data/eas-deploy-data/{easDeployInfoId} |
6.2.20.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.20.3.3-1.
Table 6.2.20.3.3-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.2.20.3.3-2 and the response data structures and response codes specified in table 6.2.20.3.3-3.
Table 6.2.20.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.20.3.3-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 was terminated successfully. |
||
|
NOTE: 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. |
||||