5.2.10 Resource: OperatorSpecificData
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.10.1 Description
This resource represents the UE’s operator specific data.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).
5.2.10.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/operator-specific-data
This resource shall support the resource URI variables defined in table 5.2.10.2-1.
Table 5.2.10.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) |
|
NOTE: The content of ueId SUPI or GPSI depends on the service. |
|
5.2.10.3 Resource Standard Methods
5.2.10.3.1 GET
This method is used to retrieve operator specific data from the UDR.
This method shall support the URI query parameters specified in table 5.2.10.3.1-1.
Table 5.2.10.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
fields |
array(string) |
C |
1..N |
When the NF consumer only retrieves a subset of the resource, the " fields " query parameter shall be included. The " fields " query parameter contains the pointers of the attribute(s) to be retrieved. |
|
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.10.3.1-2 and the response data structures and response codes specified in table 5.2.10.3.1-3.
Table 5.2.10.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.10.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
map(OperatorSpecificDataContainer) |
M |
0..N |
200 OK |
Upon success, a response body containing a map shall be returned. The key of the map is an operator-specific data element name and the value is the operator-specific data of such data element, for the current UE (identified by the {ueId} variable in the resource path). If the resource does not contain any keys, the response consists of an empty JSON object (empty map). |
|
NOTE: In addition common data structures as listed in table 5.5-1 are supported. |
||||
5.2.10.3.2 PATCH
This method is used to modify operator specific data in the UDR.
This method shall support the URI query parameters specified in table 5.2.10.3.2-1.
Table 5.2.10.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.10.3.2-2 and the response data structures and response codes specified in table 5.2.10.3.2-3.
Table 5.2.10.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 operator specific data |
Table 5.2.10.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, thenthe 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. |
||||
5.2.10.3.3 PUT
This method shall support the URI query parameters specified in table 5.2.10.3.3-1.
Table 5.2.10.3.3-1: URI query parameters supported by the PUT 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.10.3.3-2 and the response data structure, and response codes specified in table 5.2.10.3.3-3.
Table 5.2.10.3.3-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
map(OperatorSpecificDataContainer) |
M |
1..N |
Table 5.2.10.3.3-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
map(OperatorSpecificDataContainer) |
O |
1..N |
201 Created |
Upon successful creation of this resource, a representation of the created resource containing a map of OperatorSpecificDataContainer shall be returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. |
|
n/a |
O |
204 No Content |
Upon successful update of this resource, an empty response body shall be returned. |
|
|
NOTE: In addition, common data structures as listed in table 5.5-1 are supported. |
||||
5.2.10.3.4 DELETE
This method shall support the URI query parameters specified in table 5.2.10.3.4-1.
Table 5.2.10.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.2.10.3.4-2 and the response data structure, and response codes specified in table 5.2.10.3.4-3.
Table 5.2.10.3.4-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.10.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 |
Upon success, an empty response body shall be returned. |
||
|
NOTE: In addition, common data structures as listed in table 5.5-1 are supported. |
||||