5.3 Nudsf_Timer Service

29.5983GPPRelease 18TSUnstructured data storage services

5.3.1 Service Description

The UDSF is acting as an NF Service Producer. It provides UDSF timer service to the NF service consumer. Any NF may use the UDSF to run timers, search for timers, and get notifications on expiry.

5.3.2 Service Operations

5.3.2.1 Introduction

For the Nudsf_Timer service, the following service operations are defined:

– Start

– Update

– Stop

– Search

– Notify

5.3.2.2 Start

5.3.2.2.1 General

The following procedures using the Start service operation are supported:

– Timer Start

5.3.2.2.2 Timer Start

Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to start a (new or existing) timer identified by the provided timerId.

Figure 5.3.2.2.2-1: Starting a Timer

1. The NF service consumer (any NF) sends a PUT request to the resource indicated by timerId.

2. On success, the UDSF responds with "204 No Content" or "201 Created".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body.

5.3.2.3 Update

5.3.2.3.1 General

The following procedures using the Update service operation are supported:

– Timer Update

5.3.2.3.2 Timer Update

Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to update an existing timer identified by the provided timerId.

Figure 5.3.2.3.2-1: Modifying a Timer

1. The NF service consumer (any NF) sends a PATCH request to the resource indicated by timerId.

2a. On success, if all the modification instructions in the PATCH request have been implemented, the UDSF shall respond with "204 No Content".

2b. On partial success, i.e. if one or more modification instructions have been discarded, "200 OK" with the execution report, shall be returned.

2c. On failure, the UDSF shall respond with "404 Not Found" if the timer indicated by the timerId does not exist and may include the ProblemDetails.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

5.3.2.4 Stop

5.3.2.4.1 General

The following procedures using the Stop service operation are supported:

– Single Timer Stop

– Multiple Timer Stop

5.3.2.4.2 Single Timer Stop

Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to stop an existing timer identified by the provided timerId.

Figure 5.3.2.4.2-1: Stopping a single Timer

1. The NF service consumer (any NF) sends a DELETE request to the resource indicated by timerId.

2a. On success, the UDSF shall respond with "204 No Content".

2b. On failure, the UDSF shall respond with "404 Not Found" if the timer does not exist and may include the ProblemDetails.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

5.3.2.4.3 Multiple Timer Stop

Figure 5.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to stop all timers matching a provided filter.

Figure 5.3.2.4.3-1: Stopping multiple Timers

1. The NF service consumer (any NF) sends a DELETE request to the timers resource containing a filter Query Parameter.

2a. On success, the UDSF shall respond with "200 OK" with a message body containing the list of stopped timers.

2b. The UDSF shall respond with "204 No Content" if no timers matching the filter could be found.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

5.3.2.5 Search

5.3.2.5.1 General

The following procedures using the Search service operation are supported:

– Expired Timer Search

– Tagged Timer Search

5.3.2.5.2 Expired Timer Search

Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to search for expired timers matching a provided expired-filter.

Figure 5.3.2.5.2-1: Searching for expired Timers

1. The NF service consumer (any NF) sends a GET request to the timers resource containing an expired-filter Query Parameter.

2a. On success, the UDSF shall respond with "200 OK" with a message body containing the list of expired timers matching the expired-filter.

2b. The UDSF shall respond with "204 No Content" if no timers matching the filter could be found.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.3.2.5.3 Tagged Timer Search

Figure 5.3.2.5.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to search for tagged timers matching a provided filter.

Figure 5.3.2.5.3-1: Searching for tagged Timers

1. The NF service consumer (any NF) sends a GET request to the timers resource containing a filter Query Parameter.

2a. On success, the UDSF shall respond with "200 OK" with a message body containing the list of tagged timers matching the filter.

2b. The UDSF shall respond with "204 No Content" if no timers matching the filter could be found.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.3.2.6 Notify

5.3.2.6.1 General

The following procedures using the Notify service operation are supported:

– Timer Expiry Notify

5.3.2.6.2 Timer Expiry Notify

Figure5.3.2.6.2-1 shows a scenario where the UDSF notifies the NF service consumer of the expired timer.

The Notify is sent by the UDSF to the NF Service Consumer when the timer expires as indicated by the expires attribute of the Timer.

Figure 5.3.2.6.2-1: Timer Expiry Notify

1. The UDSF shall send a POST request to the callback URI. The request shall contain the timer that has expired.

2. On success, "204 No content" shall be returned by the NF Service Consumer to UDSF.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.