5.2.47 Resource: UeSubscriptionData
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.47.1 Description
This resource represents the subscription data for a UE ID.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).
5.2.47.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}
This resource shall support the resource URI variables defined in table 5.2.47.2-1.
Table 5.2.47.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) |
5.2.47.3 Resource Standard Methods
5.2.47.3.1 GET
When the NF service consumer (e.g. UDM) and the UDR both support the UESubDataSetRetrieve feature (see clause 6.1.8 of 3GPP TS 29.504 [2]), then NF service consumer may send a GET method towards the UE subscription data resource URI (…/subscription-data/{ueId}) to retrieve the UE subscription data sets.
This method shall support the URI query parameters specified in table 5.2.47.3.1-1.
Table 5.2.47.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
dataset-names |
array(DataSetName) |
M |
1..N |
This IE shall contain the names of data sets to the retrieved. |
serving-plmn |
PlmnId |
C |
0..1 |
This IE shall be present when at least one of the following serving PLMN specific data sets are indicated in the dataset-names IE: – AM – SMF_SEL – SMS_SUB – SM – TRACE – SMS_MNG – LCS_BCA |
This method shall support the request data structures specified in table 5.2.47.3.1-2 and the response data structures and response codes specified in table 5.2.47.3.1-3.
Table 5.2.47.3.1-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.2.47.3.1-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
UeSubscribedDataSets |
M |
1 |
200 OK |
Upon success, a response body containing the requested data sets shall be returned. |
NOTE: In addition common data structures as listed in table 5.5-1 are supported. |