5.2.21 Resource: IndividualSubscriptionDataSubscription
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.21.1 Description
This resource is used to represent an individual subscriber data subscriptions to notifications.
5.2.21.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/subs-to-notify/{subsId}
This resource shall support the resource URI variables defined in table 5.2.21.2-1.
Table 5.2.21.2-1: Resource URI variables for this resource
|
Name |
Definition |
|
apiRoot |
See 3GPP TS 29.504 [2] clause 6.1.1 |
|
subsId |
The subsId identifies an individual SubscriptionDataSubscriptions to notifications. The value is allocated by the UDR during creation of the SubscriptionDataSubscriptions resource. |
5.2.21.3 Resource Standard Methods
5.2.21.3.1 DELETE
This method shall support the URI query parameters specified in table 5.2.21.3.1-1.
Table 5.2.21.3.1-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.21.3.1-2 and the response data structures and response codes specified in table 5.2.21.3.1-3.
Table 5.2.21.3.1-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 5.2.21.3.1-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. |
||||
5.2.21.3.2 PATCH
This method shall support the URI query parameters specified in table 5.2.21.3.2-1.
Table 5.2.21.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.21.3.2-2 and the response data structures and response codes specified in table 5.2.21.3.2-3.
Table 5.2.21.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 Individual Subscription Data Subscription. |
Table 5.2.21.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, when all the modification instructions in the PATCH request have been implemented, there is no body in the response message. |
||
|
SubscriptionDataSubscriptions |
C |
0..1 |
200 OK |
Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource, the modified individual SubscriptionDataSubscriptions is returned with the accepted/confirmed values, e.g. the confirmed expiry time. Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDR shall return a SubscriptionDataSubscriptions object in the response. (NOTE 2) |
|
PatchResult |
C |
0..1 |
200 OK |
Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number and if some of the modification instructions in the PATCH request have been discarded while the rest are accepted, 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. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The "cause" attribute may be used to indicate one of the following application errors: – SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. |
|
NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. NOTE 2: One of SubscriptionDataSubscriptions or PatchResult shall be returned. |
||||
5.2.21.3.3 GET
This method shall support the URI query parameters specified in table 5.2.21.3.3-1.
Table 5.2.21.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 5.2.21.3.3-2 and the response data structures and response codes specified in table 5.2.21.3.3-3.
Table 5.2.21.3.3-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
The request body shall be empty. |
Table 5.2.21.3.3-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
SubscriptionDataSubscriptions |
M |
1 |
200 OK |
Upon success, a response body containing the individual subscriptions shall be returned. |
|
NOTE: In addition common data structures as listed in table 5.5-1 are supported. |
||||