5.2.14 UDSF Services
23.5023GPPProcedures for the 5G System (5GS)Release 18TS
5.2.14.1 General
The following table illustrates the UDSF Services.
Table 5.2.14-1: NF Services provided by UDSF
NF service |
Service Operations |
Operation Semantics |
Example Consumer(s) |
UnstructuredData |
Query |
Request/Response |
Any NF |
Management |
Create |
Request/Response |
Any NF |
Delete |
Request/Response |
Any NF |
|
Update |
Request/Response |
Any NF |
|
Subscribe |
Subscribe/Notify |
Any NF |
|
Unsubscribe |
Subscribe/Notify |
Any NF |
|
Notify |
Subscribe/Notify |
Any NF |
|
Nudsf_Timer |
Start |
Request/Response |
Any NF |
Stop |
Request/Response |
Any NF |
|
Update |
Request/Response |
Any NF |
|
Search |
Request/Response |
Any NF |
|
Notify |
Subscribe/Notify |
Any NF |
NOTE: Nudsf is different compared to other service-based interfaces due to dynamic data access performance requirements.
5.2.14.2 Nudsf_UnstructuredDataManagement service
5.2.14.2.1 General
5.2.14.2.2 Nudsf_UnstructuredDataManagement_Query service operation
Service operation name: Nudsf_UnstructuredDataManagement_Query.
Description: NF service consumer intends to query data from UDSF.
Inputs, Required: Data Identifier.
Data Identifier uniquely identifies the data to be retrieved from the UDSF
Inputs, Optional: None.
Outputs, Required: Requested data.
Outputs, Optional: None.
5.2.14.2.3 Nudsf_UnstructuredDataManagement_Create service operation
Service operation name: Nudsf_UnstructuredDataManagement_Create.
Description: NF service consumer intends to insert a new user data record into the UDSF, e.g. AMF stores the context for registered UE(s) in the UDSF.
Inputs, Required: Data Identifier, Data.
Data Identifier uniquely identifies the data, which is created in the UDSF.
Inputs, Optional: Validity time, Notification Endpoint.
Validity time tells for how long the created data is valid. When validity time has expired, NF service consumer is notified and data is removed.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.2.4 Nudsf_UnstructuredDataManagement_Delete service operation
Service operation name: Nudsf_UnstructuredDataManagement_Delete.
Description: NF service consumer intends to delete user data stored in the UDSF, e.g. when AMF deletes the context for unregistered UE(s) in the UDSF.
Inputs, Required: Data Identifier.
Inputs, Optional: None.
Data Identifier uniquely identifies the data to be deleted within the UDSF.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.2.5 Nudsf_UnstructuredDataManagement_Update service operation
Service operation name: Nudsf_UnstructuredDataManagement_Update.
Description: NF service consumer intends to update stored data in the UDSF.
Inputs, Required: Data Identifier, Data.
Data Identifier uniquely identifies the data, which is updated in the UDSF.
Inputs, Optional: Validity time.
Validity time tells for how long the created data is valid. When validity time has expired, NF service consumer is notified and data is removed.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.2.6 Nudsf_UnstructuredDataManagement_Subscribe
Service operation name: Nudsf_UnstructuredDataManagement_Subscribe
Description: NF service consumer subscribes to notifications of data change in the UDSF.
Inputs, Required: Identity of data to be monitored, Notification endpoint.
Inputs, Optional: None.
Outputs, Required: Subscription ID.
Outputs, Optional: None.
5.2.14.2.7 Nudsf_UnstructuredDataManagement_Unsubscribe
Service operation name: Nudsf_UnstructuredDataManagement_Unsubscribe
Description: NF service consumer un-subscribes to notifications of data change in the UDSF.
Inputs, Required: Subscription ID.
Inputs, Optional: None.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.2.8 Nudsf_UnstructuredDataManagement_Notify
Service operation name: Nudsf_UnstructuredDataManagement_Notify
Description: NF is notifications of data change or if validity time for created data has expired in the UDSF.
Inputs, Required: Data Identifier, Data.
Inputs, Optional: None.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.3 Nudsf_Timer service
5.2.14.3.1 General
Any NF may use the UDSF to run timer(s), search for timer(s), and get notifications on expiry.
5.2.14.3.2 Nudsf_Timer_Start service operation
Service operation name: Nudsf_Timer_Start
Description: NF service consumer starts a timer in the UDSF.
Inputs, Required: Timer ID, Time of expiry.
Inputs, Optional: Notification Endpoint, Associated data.
Associated data is data that can be used by the consumer to identify for what purpose the timer is for, e.g. a subscription that has timed out.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.3.3 Nudsf_Timer_Update service operation
Service operation name: Nudsf_Timer_Update
Description: NF service consumer updates a timer in the UDSF.
Inputs, Required: Timer Identity.
Inputs, Optional: Notification Endpoint, Associated data, Time of expiry.
Associated data is data that can be used by the consumer to identify for what purpose the timer is for, e.g. a subscription that has timed out.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.3.4 Nudsf_Timer_Notify service operation
Service operation name: Nudsf_Timer_Notify
Description: The UDSF notifies the NF service consumer about a timer expiry.
Inputs, Required: Timer Identity.
Inputs, Optional: None.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.3.5 Nudsf_Timer_Stop service operation
Service operation name: Nudsf_Timer_Stop
Description: NF service consumer intends to stop timer(s) in the UDSF.
Inputs, Required: Timer Identity/Identities.
Inputs, Optional: None.
Outputs, Required: Result.
Outputs, Optional: None.
5.2.14.3.6 Nudsf_Timer_Search service operation
Service operation name: Nudsf_Timer_Search
Description: NF service consumer intends to search and retrieve timers matching a filter in the UDSF.
Inputs, Required: Search filter (see TS 29.598 [85]).
Inputs, Optional: Filter.
Outputs, Required: Result.
Outputs, Optional: Timer Identity/Identities.