5.3 Notifications
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.3.1 General
This clause describes the resources to provide Notification to NF service consumers which have explicitly or implicitly subscribed to UDR to be notified when data is changed.
5.3.2 Data Change Notification
The POST method shall be used for Data Change Notifications.
– For explicit subscriptions (i.e., subscriptions created under the "subs-to-notif" collection resource, the URI shall be as provided during the subscription procedure;
– For implicit subscriptions, the UDR shall use either a locally configured callback URI of the UDM, or the UDR may retrieve from NRF a default notification URI stored by UDM in NRF during the NF registration procedure.
– If the UDM uses implicit subscriptions to receive notifications from UDR, the UDM shall register in NRF a default notification URI globally at NF Profile level (see 3GPP TS 29.510 [19], clause 6.1.6.2.2), rather than registering individual default notification URIs per NF Service.
The "callback" clause of the OpenAPI specification found in Annex A.2 associated to the POST method of the "subs-to-notif" resource shall be used as the notification request for both explicit and implicit subscriptions.
NOTE: For explicit subscriptions, a stateless UDM/NF provides a URI which identifies a set of UDMs/NFs; a stateful UDM/NF provides a specific URI identifying a node.
Resource URI: {callbackReference}
Support of URI query parameters is specified in table 5.3.2-1.
Table 5.3.2-1: URI query parameters supported by the POST method
Name |
Data type |
P |
Cardinality |
Description |
n/a |
Support of request data structures is specified in table 5.3.2-2 and of response data structures and response codes is specified in table 5.3.2-3.
Table 5.3.2-2: Data structures supported by the POST Request Body
Data type |
P |
Cardinality |
Description |
DataChangeNotify |
M |
1 |
Table5.3.2-3: Data structures supported by the POST Response Body
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Upon success, an empty response body shall be returned. |
The structure of the Notifications from changes on the explicitly subscribed resources (i.e. the resource indicated by the MonitoriedResourceUri) or implicitly subscribed resources of type Collection or Store, are described in Table 5.3.2-4.
NOTE: Table 5.3.2-4 follows the considerations for handling JSON arrays described in 3GPP TS 29.501 Annex E.
Table 5.3.2-4: The structure of the Notifications of type Collection or Store
Subscribed Resource name |
DataChangeNotify Content Type |
Description |
SmfRegistrations |
SmfRegList |
The complete replacement array representation of the SmfRegList shall be included in the DataChangeNotify. |
ProvisionedParameterDataEntries |
PpDataEntryList |
The complete replacement array representation of the PpDataEntryList shall be included in the DataChangeNotify. |
SubscriptionDataSubscriptions |
array(SubscriptionDataSubscriptions) |
The complete replacement array representation of the SubscriptionDataSubscriptions shall be included in the DataChangeNotify. |
5GVnGroups |
map(5GVnGroupConfiguration) |
The complete map respresenation shall be included in the DataChangeNotify. |
5.3.3 Data Removal Notification
The POST method shall be used for Data Removal Notifications.
Data Removal Notifications are used for subscription withdraw cases implicitly subscribed by the UDM.
– The UDR shall use either a locally configured callback URI of the UDM, or the UDR may retrieve from NRF a default notification URI stored by UDM in NRF during the NF registration procedure.
– The UDM should register in NRF a default notification URI globally at NF Profile level, rather than registering individual default notification URIs per NF Service.
The "callback" clause of the OpenAPI specification found in Annex A.2 associated to the POST method of the "subs-to-notif" resource shall be used as the notification request.
Resource URI: {callbackReference}
Support of URI query parameters is specified in table 5.3.3-1.
Table 5.3.3-1: URI query parameters supported by the POST method
Name |
Data type |
P |
Cardinality |
Description |
n/a |
Support of request data structures is specified in table 5.3.3-2 and of response data structures and response codes is specified in table 5.3.3-3.
Table 5.3.3-2: Data structures supported by the POST Request Body
Data type |
P |
Cardinality |
Description |
DataChangeNotify |
M |
1 |
notifyItems within the DataChangeNotify type shall indicate deletion of the resources Amf3GppAccessRegistration and/or AmfNon3GppAccessRegistration |
Table5.3.3-3: Data structures supported by the POST Response Body
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. |