5.2.14 Resource: ProvisionedParamenterData

29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data

5.2.14.1 Description

This resource represents the subscribed ProvisionedParameterData for a GPSI. It is triggered by the AF/NEF via the UDM to update 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.14.2 Resource Definition

Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/pp-data

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

Table 5.2.14.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 or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3]

5.2.14.3 Resource Standard Methods

5.2.14.3.1 GET

This method retrieves the provisioned data of a given UE.

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

Table 5.2.14.3.1-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.14.3.1-2 and the response data structures and response codes specified in table 5.2.14.3.1-3.

Table 5.2.14.3.1-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

n/a

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

Data type

P

Cardinality

Response

codes

Description

PpData

M

1

200 OK

Upon success, a response body is returned containing the provisioned data of the GPSI.

5.2.14.3.2 PATCH

This method is used to modify the provisioned parameter data in the UDR.

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

Table 5.2.14.3.2-1: URI query parameters supported by the PATCH 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.14.3.2-2 and the response data structures and response codes specified in table 5.2.14.3.2-3.

Table 5.2.14.3.2-2: Data structures supported by the PATCH Request Body on this resource

Data type

P

Cardinality

Description

array(PatchItem)

M

1..N

Contains the delta data to the provisioned parameter data

Table 5.2.14.3.2-3: Data structures supported by the PATCH Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

n/a

204 No Content

Upon successful modification there is no body in the response message. (NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1.

NOTE 1: In addition common data structures as listed in table 5.5-1 are supported.

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult.