5.2.14B Resource: ProvisionedParameterDataEntry
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.14B.1 Description
This resource represents an Entry under the Provisioned Parameter Data store for a UE. It is triggered by the AF/NEF via the UDM to update or retrieve the provisioned data stored for the subscriber.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).
5.2.14B.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/pp-data-store/{afInstanceId}
This resource shall support the resource URI variables defined in table 5.2.14B.2-1.
Table 5.2.14B.2-1: Resource URI variables for this resource
|
Name |
Definition |
|
apiRoot |
See 3GPP TS 29.504 [2] clause 6.1.1 |
|
ueId |
Represents the Subscription Identifier SUPI, GPSI or Group Id or anyUE (see 3GPP TS 23.501 [4] clause 5.9.2) – If representing a single UE, this parameter shall contain the GPSI or SUPI. – If representing a group of UEs, this parameter shall contain the External GroupId. pattern: "^extgroupid-[^@]+@[^@]+$" – If representing any UE, this parameter shall contain "anyUE". pattern: "^anyUE$" |
|
afInstanceId |
The string identifying the originating AF |
5.2.14B.3 Resource Standard Methods
5.2.14B.3.1 PUT
This method shall support the URI query parameters specified in table 5.2.14B.3.1-1.
Table 5.2.14B.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 5.2.14B.3.1-2 and the response data structures and response codes specified in table 5.2.14B.3.1-3.
Table 5.2.14B.3.1-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
PpDataEntry |
M |
1 |
Contains a Parameter Provisioning Data entry |
Table 5.2.14B.3.1-4: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PpDataEntry |
M |
1 |
201 Created |
Indicates a successful creation of the resource. |
|
n/a |
204 No Content |
Indicates a successful update of the resource. An empty response shall be returned. |
||
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
The "cause" attribute may be used to indicate one of the following application errors: – CREATION_NOT_ALLOWED |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND |
|
NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. |
||||
5.2.14B.3.2 DELETE
This method shall support the URI query parameters specified in table 5.2.14B.3.2-1.
Table 5.2.14B.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 5.2.14B.3.2-2 and the response data structures and response codes specified in table 5.2.14B.3.2-3.
Table 5.2.14B.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.14B.3.2-2: 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 |
||
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND |
|
NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. |
||||
5.2.14B.3.3 GET
This method retrieves the provisioned data of a given UE.
This method shall support the URI query parameters specified in table 5.2.14B.3.3-1.
Table 5.2.14B.3.3-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
supported-features |
SupportedFeatures |
O |
0..1 |
see 3GPP TS 29.500 [8] clause 6.6 |
This method shall support the request data structures specified in table 5.2.14B.4.1-2 and the response data structures and response codes specified in table 5.2.14B.4.1-3.
Table 5.2.14B.3.3-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
N/A |
Table 5.2.14B.3.3-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PpDataEntry |
M |
1 |
200 OK |
Upon success, a response body is returned containing the provisioned data entry of the UE. |