5.15 TimeSyncExposure API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

5.15.1 Resources

5.15.1.1 Overview

All resource URIs of this API should have the following root:

{apiRoot}/3gpp-time-sync/v1

"apiRoot" is set as described in clause 5.2.4 in 3GPP TS 29.122 [4]. "apiName" shall be set to "3gpp-time-sync" and "apiVersion" shall be set to "v1" for the current version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.

This clause describes the structure for the Resource URIs as shown in figure 5.15.1.1-1 and the resources and HTTP methods used for the TimeSyncExposure API.

Figure 5.15.1.1-1: Resource URI structure of the TimeSyncExposure API

Table 5.15.1.1-1 provides an overview of the resources and HTTP methods applicable for the TimeSyncExposure API.

Table 5.15.1.1-1: Resources and methods overview

Resource name

Resource URI

HTTP method

Description

Time Synchronization Exposure Subscriptions

/{afId}/subscriptions

GET

Read all subscriptions for a given AF

POST

Create a new subscription to time synchronization exposure

Individual Time Synchronization Exposure Subscription

/{afId}/subscriptions/{subscriptionId}

GET

Read a subscription to time synchronization exposure

PUT

Modify all of the properties of an existing subscription to time synchronization exposure

DELETE

Delete a subscription to time synchronization exposure

Time Synchronization Exposure Configurations

/{afId}/subscriptions/{subscriptionId}/configurations

GET

Read all configurations for a given AF and subscription

POST

Create a new configuration to time synchronization exposure

Individual Time Synchronization Exposure Configuration

/{afId}/subscriptions/{subscriptionId}/configurations/{instanceReference}

GET

Read a configuration to time synchronization exposure

PUT

Modify all of the properties of an existing configuration to time synchronization exposure

DELETE

Delete a configuration to time synchronization exposure

DELETE

DELETE a new configuration of 5G access stratum time distribution.

5.15.1.2 Resource: Time Synchronization Exposure Subscriptions

5.15.1.2.1 Introduction

This resource allows an AF to read all active time synchronization exposure subscribtions for the given AF, or allows an AF to create a new Individual Time Synchronization Exposure Subscription in the NEF.

5.15.1.2.2 Resource Definition

Resource URI: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions

This resource shall support the resource URI variables defined in table 5.15.1.2.2-1.

Table 5.15.1.2.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

5.15.1.2.3 Resource Methods
5.15.1.2.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.15.1.2.2.

5.15.1.2.3.2 GET

The GET method allows to read all active subscriptions for a given AF. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.2.3.2-1.

Table 5.15.1.2.3.2-1: URI query parameters supported by the GET method on this resource

Name

Data type

P

Cardinality

Description

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

This method shall support the request data structures specified in table 5.15.1.2.3.2-2 and the response data structures and response codes specified in table 5.15.1.2.3.2-3.

Table 5.15.1.2.3.2-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.2.3.2-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response codes

Description

array(TimeSyncExposureSubsc)

M

0..N

200 OK

The subscription information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.2.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.2.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.2.3.3 POST

The POST method creates a new subscription resource to time synchronization exposure subscription for a given AF. The AF shall initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI of the created resource.

This method shall support the request data structures specified in table 5.15.1.2.3.3-1 and the response data structures and response codes specified in table 5.15.1.2.3.3-2.

Table 5.15.1.2.3.3-1: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureSubsc

M

1

Contains the information for the creation of a new Individual Time Synchronization Exposure Subscription resource.

Table 5.15.1.2.3.3-2: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureSubsc

M

1

201 Created

The subscription was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.2.3.3-3: Headers supported by the 201 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions/{subscriptionId}

5.15.1.3 Resource: Individual Time Synchronization Exposure Subscription

5.15.1.3.1 Introduction

This resource allows an AF to read, update or delete an existing Individual Time Synchronization Exposure Subscription.

5.15.1.3.2 Resource Definition

Resource URI: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 5.15.1.3.2-1.

Table 5.15.1.3.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

subscriptionId

string

Identifier of the subscription resource.

5.15.1.3.3 Resource Methods
5.15.1.3.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.15.1.3.2.

5.15.1.3.3.2 GET

The GET method allows to read the active subscription for a given AF and subscription Id. The AF shall initiate the HTTP GET request message and theNEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.3.3.2-1.

Table 5.15.1.3.3.2-1: URI query parameters supported by the GET method on this resource

Name

Data type

P

Cardinality

Description

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

This method shall support the request data structures specified in table 5.15.1.3.3.2-2 and the response data structures and response codes specified in table 5.15.1.3.3.2-3.

Table 5.15.1.3.3.2-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.3.3.2-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureSubsc

M

1

200 OK

The subscription information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.3.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.3.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.3.3.3 PUT

The PUT method modifies an existing subscription resource to update a subscription. The AF shall initiate the HTTP PUT request message and the NEF shall respond to the message.

This method shall support the request data structures specified in table 5.15.1.3.3.3-1 and the response data structures and response codes specified in table 5.15.1.3.3.3-2.

Table 5.15.1.3.3.3-1: Data structures supported by the PUT Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureSubsc

M

1

Modify an existing Time Synchronization Exposure Subscription.

Table 5.15.1.3.3.3-2: Data structures supported by the PUT Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureSubsc

M

1

200 OK

The subscription was updated successfully.

N/A

204 No Content

The subscription was updated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.3.3.3-3: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.3.3.3-4: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.3.3.4 DELETE

The DELETE method deletes the time synchronization exposure subscription for a given AF. The AF shall initiate the HTTP DELETE request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.3.3.4-1.

Table 5.15.1.3.3.4-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.15.1.3.3.4-2 and the response data structures and response codes specified in table 5.15.1.3.3.4-3.

Table 5.15.1.3.3.4-2: Data structures supported by the DELETE Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.3.3.4-3: Data structures supported by the DELETE Response Body on this resource

Data type

P

Cardinality

Response codes

Description

N/A

204 No Content

The subscription was terminated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.3.3.4-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.3.3.4-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.4 Resource: Time Synchronization Exposure Configurations

5.15.1.4.1 Introduction

This resource allows an AF to read all active time synchronization exposure configuration for the given AF and subscription, or allows an AF to create a new time synchronization configuration and activate the time synchronization service with the configuration.

5.15.1.4.2 Resource Definition

Resource URI: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions/{subscriptionId}/configurations

This resource shall support the resource URI variables defined in table 5.15.1.4.2-1.

Table 5.15.1.4.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

subscriptionId

string

Identifier of the subscription resource.

5.15.1.4.3 Resource Methods
5.15.1.4.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.15.1.4.3.

5.15.1.4.3.2 GET

The GET method allows to read all active configurations for a given AF and subscription. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.4.3.2-1.

Table 5.15.1.4.3.2-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.15.1.4.3.2-2 and the response data structures and response codes specified in table 5.15.1.4.3.2-3.

Table 5.15.1.4.3.2-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.4.3.2-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response codes

Description

array(TimeSyncExposureConfig)

M

0..N

200 OK

The configuration information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.4.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.4.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.4.3.3 POST

The POST method creates a new configuration resource to activate time synchronization service for a given AF. The AF shall initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI of the created resource.

This method shall support the request data structures specified in table 5.15.1.4.3.3-1 and the response data structures and response codes specified in table 5.15.1.4.3.3-2.

Table 5.15.1.4.3.3-1: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureConfig

M

1

Parameters to create a configuration and to activate time synchronization service.

Table 5.15.1.2.4.3-2: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureConfig

M

1

201 Created

The subscription was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.4.3.3-3: Headers supported by the 201 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions/{subscriptionId}/configurations/{instanceReference}

5.15.1.5 Resource: Individual Time Synchronization Exposure Configuration

5.15.1.5.1 Introduction

This resource allows an AF to read/modify/cancel a configuration to active/modify/deactivate Time Synchronization service with the NEF.

5.15.1.5.2 Resource Definition

Resource URI: {apiRoot}/3gpp-time-sync/v1/{afId}/subscriptions/{subscriptionId}/configuration/{instanceReference}

This resource shall support the resource URI variables defined in table 5.15.1.5.2-1.

Table 5.15.1.5.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

subscriptionId

string

Identifier of the subscription resource.

instanceReference

string

Identifier of the PTP instance resource

5.15.1.5.3 Resource Methods
5.15.1.5.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.15.1.5.2.

5.15.1.5.3.2 GET

The GET method allows to read the active configuration for a given AF, subscription Id and configuration Id. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.5.3.2-1.

Table 5.15.1.5.3.2-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.15.1.5.3.2-2 and the response data structures and response codes specified in table 5.15.1.5.3.2-3.

Table 5.15.1.5.3.2-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.5.3.2-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureConfig

M

1

200 OK

The configuration information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.5.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.5.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.5.3.3 PUT

The PUT method modifies an existing configuration resource to update a configuration. The AF shall initiate the HTTP PUT request message and the NEF shall respond to the message.

This method shall support the request data structures specified in table 5.15.1.5.3.3-1 and the response data structures and response codes specified in table 5.15.1.5.3.3-2.

Table 5.15.1.5.3.3-1: Data structures supported by the PUT Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureConfig

M

1

Modify an existing Time Synchronization Exposure Configuration.

Table 5.15.1.5.3.3-2: Data structures supported by the PUT Response Body on this resource

Data type

P

Cardinality

Response codes

Description

TimeSyncExposureConfig

M

1

200 OK

The subscription was updated successfully.

N/A

204 No Content

The subscription was updated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.5.3.3-3: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.5.3.3-4: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.1.5.3.4 DELETE

The DELETE method deletes the time synchronization exposure subscription for a given AF. The AF shall initiate the HTTP DELETE request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.15.1.5.3.4-1.

Table 5.15.1.5.3.4-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.15.1.5.3.4-2 and the response data structures and response codes specified in table 5.15.1.5.3.4-3.

Table 5.15.1.5.3.4-2: Data structures supported by the DELETE Request Body on this resource

Data type

P

Cardinality

Description

N/A

Table 5.15.1.5.3.4-3: Data structures supported by the DELETE Response Body on this resource

Data type

P

Cardinality

Response codes

Description

N/A

204 No Content

The configuration was terminated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.15.1.5.3.4-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Table 5.15.1.5.3.4-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

5.15.2 Custom Operations without associated resources

None.

5.15.3 Notifications

5.15.3.1 Introduction

.

Table 5.15.3.1-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description

(service operation)

Time Synchronization Capability Notification

{subsNotifUri}

POST

Time Synchronization Capability Notification for a list of UEs.

Time Synchronization Configuration Notification

{configNotifUri}

POST

Current State of Time Synchronization configuration Notification.

5.15.3.2 Time Synchronization Capability Notification

5.15.3.2.1 Description

The Notification is used by the NEF to report the Time Synchronization Capability to the AF.

5.15.3.2.2 Callback URI

The Callback URI "{subsNotifUri}" shall be used with the callback URI variables defined in table 5.15.3.2.2-1.

Table 5.15.3.2.2-1: Callback URI variables

Name

Definition

subsNotifUri

Callback reference provided by the AF during creation/modification of the subscription as defined in Table 5.15.4.3.2-1.

5.15.3.2.3 Operation Definition
5.15.3.2.3.1 Notification via HTTP POST

This method shall support the request data structures specified in table 5.15.3.2.3.1-1 and the response data structures and response codes specified in table 5.15.3.2.3.1-2 and the Location Headers specified in table 5.15.3.2.3.1-3 and table 5.15.3.2.3.1-4.

Table 5.15.3.2.3.1-1: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureSubsNotif

M

1

Provides the time synchroniziation capabilities of a list of UEs by the NEF to the AF.

Table 5.15.3.2.3.1-2: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

N/A

204 No Content

The event notification is received successfully.

N/A

307 Temporary Redirect

Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Editor’s note: Error responses are FFS.

Table 5.15.3.2.3.1-3: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Table 5.15.3.2.3.1-4: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

5.15.3.2.3.2 Notification via Websocket

If supported by both AF and NEF and successfully negotiated, the Time Synchroniaition Capability Notification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4].

5.15.3.3 Time Synchronization Configuration Notification

5.15.3.3.1 Description

The Notification is used by the NEF to report the state of Time Synchronization service configuration to the AF.

5.15.3.3.2 Callback URI

The Callback URI "{configNotifUri}" shall be used with the callback URI variables defined in table 5.15.3.3.2-1.

Table 5.15.3.3.2-1: Callback URI variables

Name

Definition

configNotifUri

Callback reference provided by the AF during creation/modification of the configuration as defined in Table 5.15.4.3.6-1.

5.15.3.3.3 Operation Definition
5.15.3.3.3.1 Notification via HTTP POST

This method shall support the request data structures specified in table 5.15.3.3.3.1-1 and the response data structures and response codes specified in table 5.15.3.3.3.1-2 and the Location Headers specified in table 5.15.3.3.3.1-3 and table 5.15.3.3.3.1-4.

Table 5.15.3.3.3.1-1: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

TimeSyncExposureConfigNotif

M

1

Provides the current state of time synchroniziation service configuration by the NEF to the AF.

Table 5.15.5.3.3.1-2: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

N/A

204 No Content

The notification is received successfully.

N/A

307 Temporary Redirect

Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Editor’s note: Error responses are FFS.

Table 5.15.3.3.3.1-3: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Table 5.15.2.2.3.1-4: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

5.15.3.3.3.2 Notification via Websocket

If supported by both AF and NEF and successfully negotiated, the state of Time Synchroniaition Service Configuration Notification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4].

5.15.4 Data Model

5.15.4.1 General

This clause specifies the application data model supported by the TimeSyncExposure API.

Table 5.15.4.1-1 specifies the data types defined for the TimeSyncExposure API.

Table 5.15.4.1-1: TimeSyncExposure API specific Data Types

Data type

Clause defined

Description

Applicability

AsTimeResource

5.15.4.4.8

Identifies the supported 5G clock quality.

ConfigForPort

5.15.4.3.18

Contains configuration information for each port.

EventFilter

5.15.4.3.10

Contains the filter conditions to match for notifying the event(s) of time synchronization capabilities.

GmCapable

5.15.4.4.5

Identifies the supported grandmaster.

InstanceType

5.15.4.4.7

Identifies supported PTP instance type.

Protocol

5.15.4.4.4

Identifies the supported protocol.

PtpCapabilitiesPerUe

5.15.4.3.11

Contains the supported PTP capabilities per UE.

PtpInstance

5.15.4.3.12

Contains PTP instance configuration and activation information requested by the AF.

StageOfConfiguration

5.15.4.3.17

Contains the PTP port state of the time synchronization configuration.

StateOfDstt

5.15.4.3.19

Contains the PTP port state of a DS-TT

SubscribedEvent

5.15.4.4.6

Identifies the supported event.

SubsEventNotification

5.15.4.3.8

Represents the notification about a subscribed Individual Event.

TimeSyncCapability

5.15.4.3.3

Contains the time synchronization capability.

TimeSyncExposureConfig

5.15.4.3.6

Contains the Time Synchronization Configuration parameters.

TimeSyncExposureConfigNotif

5.15.4.3.9

Contains the notification of time synchronization service state.

TimeSyncExposureSubsc

5.15.4.3.2

Contains the requested parameters for the subscription to time synchronization capability notifications.

TimeSyncExposureSubsNotif

5.15.4.3.7

Contains the notification of time synchronization capability.

5.15.4.2 Reused data types

The data types reused by the TimeSyncExposure API from other specifications are listed in table 5.15.4.2-1.

Table 5.15.4.2-1: Re-used Data Types

Data type

Reference

Comments

DateTime

3GPP TS 29.571 [8]

Dnn

3GPP TS 29.571 [8]

Identifies a DNN.

ExternalGroupId

3GPP TS 29.122 [4]

External Group Identifier for a user group.

NotificationMethod

3GPP TS 29.508 [26]

Gpsi

3GPP TS 29.571 [8]

Identifies a GPSI.

Snssai

3GPP TS 29.571 [8]

Identifies the S-NSSAI.

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.15.5-1.

Uinteger

3GPP TS 29.571 [8]

Unsigned integer.

Uri

3GPP TS 29.571 [8]

Identifies a referenced resource.

5.15.4.3 Structured data types

5.15.4.3.1 Introduction

This clause defines the structured data types to be used in resource representations.

5.15.4.3.2 Type: TimeSyncExposureSubsc

Table 5.15.4.3.2-1: Definition of type TimeSyncExposureSubsc

Attribute name

Data type

P

Cardinality

Description

Applicability

exterGroupId

ExternalGroupId

C

0..1

Identifies a group of UE(s) for which the time synchronization capabilities is requested. (NOTE 1)

gpsis

array(Gpsi)

C

1..N

Contains a list of UE for which the time synchronization capabilities is requested. (NOTE 1)

anyUeInd

boolean

C

0..1

Identifies whether the AF request applies to any UE (i.e. all UEs). This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE 1) (NOTE 2)

notifMethod

NotificationMethod

O

0..1

If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies.

dnn

Dnn

C

0..1

Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 2)

snssai

Snssai

C

0..1

Identifies an S-NSSAI. (NOTE 2)

afServiceId

string

O

0..1

Identifies a service on behalf of which the AF is issuing the request.

subscribedEvents

array(SubscribedEvent)

O

1..N

Identifies the requirement to be notified of the event(s).

eventFilters

array(EventFilter)

O

1..N

Contains the filter conditions to match for notifying the event(s) of time synchronization capabilities for a list of UE(s).

subsNotifUri

Uri

M

1

Notification URI for time sensitive capability reporting.

subsNotifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

maxReportNbr

Uinteger

O

0..1

If omitted, there is no limit.

expiry

DateTime

C

0..1

This attribute indicates the expiry time of the subscription, after which the NEF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription.

repPeriod

DurationSec

C

0..1

Is supplied for notification Method "periodic".

requestTestNotification

boolean

O

0..1

Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4]. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol.

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

Represents the features supported by the NF service consumer. This parameter shall be supplied by the NF service consumer in the POST request and the response that requested the creation of an Individual Time Synchronization Subscription resource.

NOTE 1: Only one of the properties "gpsis", "anyUeInd" or "externalGroupId" shall be included.

NOTE 2 The properties of "anyUeInd" may be included only when the properties of "dnn" and "snssai" are included.

5.15.4.3.3 Type: TimeSyncCapability

Table 5.15.4.3.3-1: Definition of type TimeSyncCapability

Attribute name

Data type

P

Cardinality

Description

Applicability

upNodeId

Uint64

M

1

Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE 802.1Q [51] clause 14.2.5.

gmCapables

array(GmCapable)

C

1..N

Indicates whether user plane node supports acting as a gPTP and/or PTP grandmaster.

(NOTE)

asTimeRes

AsTimeResource

C

0..1

Indicates the supported 5G clock quality (i.e. the source of time used by the 5GS). (NOTE)

ptpCapForUes

map(PtpCapabilitiesPerUe)

C

1..N

Contains the PTP capabilities supported by the list of UE(s). The key of the map is the gpsi.

Shall be present if the "gmCapables" attribute is included.

NOTE: At least one of the "gmCapables" attribute and "asTimeRes" attribute shall be included.

5.15.4.3.4 Void
5.15.4.3.5 Void
5.15.4.3.6 Type: TimeSyncExposureConfig

Table 5.15.4.3.6-1: Definition of type TimeSyncExposureConfig

Attribute name

Data type

P

Cardinality

Description

Applicability

upNodeId

Uint64

M

1

Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE 802.1Q [41] clause 14.2.5.

reqPtpIns

PtpInstance

M

1

Identifies the PtP instance configuration and activation requested by the AF.

gmEnable

boolean

C

0..1

Indicates that the AF requests 5GS to act as a grandmaster for PTP or gPTP if it is included and set to true. The default value "false" shall apply, if the attribute is not present.

gmPrio

Uinteger

C

0..1

Indicates a priority used as defaultDS.priority1 when generating Announce message when 5GS acts as (g)PTP GM. It may be present if the "gmEnable" is set to true.

timeDom

Uinteger

M

1

Indicate the (g)PTP domain that the (TSN)AF is located in.

timeSyncErrBdgt

Uinteger

O

0..1

Indicates the time synchronization budget for the time synchronization service in units of nanoseconds.

Minimum = 1.

tempValidity

TemporalValidity

O

0..1

Indicates the time period when the time synchronization service for a PTP instance is active.

configNotifUri

Uri

M

1

Notification URI for configuration state reporting.

configNotifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

5.15.4.3.7 Type: TimeSyncExposureSubsNotif

Table 5.15.4.3.7-1: Definition of type TimeSyncExposureSubsNotif

Attribute name

Data type

P

Cardinality

Description

Applicability

subsNotifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(SubsEventNotification)

M

1..N

Notifications about subscribed Individual Events

5.15.4.3.8 Type SubsEventNotification

Table 5.15.4.3.8-1: Definition of type SubsEventNotification

Attribute name

Data type

P

Cardinality

Description

Applicability

event

SubscribedEvent

M

1

Subscribed events.

timeSyncCapas

array(TimeSyncCapability)

O

1..N

Contains a list of time synchronization capabilities for the UE(s).

5.15.4.3.9 Type: TimeSyncExposureConfigNotif

Table 5.15.4.3.9-1: Definition of type TimeSyncExposureConfigNotif

Attribute name

Data type

P

Cardinality

Description

Applicability

configNotifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

stateOfConfig

StateOfConfiguration

M

1

Indicates the current state of time synchroniztion service configuration

5.15.4.3.10 Type: EventFilter

Table 5.15.4.3.10-1: Definition of type EventFilter

Attribute name

Data type

P

Cardinality

Description

Applicability

instanceTypes

array(InstanceType)

O

1..N

Indicates the PTP instance type(s).

transProtocols

array(Protocol)

O

1..N

Indicates the transport protocol type(s).

ptpProfiles

array(string)

O

1..N

Identifies the supported PTP profiles.

5.15.4.3.11 Type: PtpCapabilitiesPerUe

Table 5.15.4.3.11-1: Definition of type PtpCapabilitiesPerUe

Attribute name

Data type

P

Cardinality

Description

Applicability

gpsi

Gpsi

M

1

Identifies the UE to which the reported PTP instance below apply.

ptpCaps

array(EventFilter)

M

1..N

Contains the reported PTP capabilities for the UE.

5.15.4.3.12 Type: PtpInstance

Table 5.15.4.3.12-1: Definition of type PtpInstance

Attribute name

Data type

P

Cardinality

Description

Applicability

instanceType

InstanceType

M

1

Indicates the PTP instance type.

protocol

Protocol

M

1

Indicates the protocol type.

ptpProfile

string

M

1

Identifies the PTP profile.

portConfigs

arrary(ConfigForPort)

O

1..N

Contains the configurations for the PTP port(s) in the PTP instance.

5.15.4.3.13 Void
5.15.4.3.14 Void
5.15.4.3.15 Void
5.15.4.3.16 Void
5.15.4.3.17 Type: StateOfConfiguration

Table 5.15.4.3.17-1: Definition of type StateOfConfiguration

Attribute name

Data type

P

Cardinality

Description

Applicability

stateOfNwtt

boolean

O

0..1

When the PTP port state is Leader, Follower or Passive, it is included and set to true to indicate the state of configuration for NW-TT port is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for NW-TT port is inactive. Default value is false. (NOTE)

stateOfDstts

array(StateOfDstt)

O

1..N

Contains the PTP port states of the DS-TT(s).

NOTE: Leader and Follower terms in this specification are aligned with NOTE 2 in clause 5.27.1.2.2.1 of 3GPP TS 23.501 [3].

5.15.4.3.18 Type: ConfigForPort

Table 5.15.4.3.18-1: Definition of type ConfigForPort

Attribute name

Data type

P

Cardinality

Description

Applicability

gpsi

Gpsi

C

0..1

Identifies the UE/DS-TT which the parameters below apply.

n6Ind

boolean

C

0..1

Indicates the N6 termination which the parameters below apply.

ptpEnable

boolean

O

0..1

This is used to set the portDS.portEnable. If omitted, the default value as described in the PTP Profile is used

logSyncInter

integer

O

0..1

Specifies the mean time interval between successive Sync messages. This is applicable for IEEE Std 1588 [45] Boundary Clock or IEEE Std 802.1AS [46] operation. If omitted, the default value as described in the PTP Profile is used.

logSyncInterInd

boolean

O

0..1

When set to FALSE, the value of "logSyncInter" attribute is used to set the initialLogSyncInterval as described in IEEE Std 802.1AS [46]. When set to TRUE, the value of "logSyncInter" attribute is used to set the mgtSettableLogSyncInterval as described in IEEE Std 802.1AS [46].

If omitted, the default value as described in the IEEE Std 802.1AS [46] is used.

logAnnouInter

integer

O

0..1

Specifies the mean time interval between successive Announce messages. This is applicable for IEEE Std 1588 [45] Boundary Clock or IEEE Std 802.1AS [46] operation. If omitted, the default value as described in the PTP Profile is used.

logAnnouInterInd

boolean

O

0..1

When set to FALSE, the value of "logAnnouInter" attribute is used to set the initialLogAnnounceInterval as described in IEEE 802.1AS [46]. When set to TRUE, the value of "logAnnouInter" attribute is used to set the mgtSettableLogAnnounceInterval as described in IEEE Std 802.1AS [46].

If omitted, the default value as described in the IEEE Std 802.1AS [46 is used.

NOTE: Either "gpsi" or "n6Ind" attribute shall be included.

5.15.4.3.19 Type: StateOfDstt

Table 5.15.4.3.19-1: Definition of type StateOfDstt

Attribute name

Data type

P

Cardinality

Description

Applicability

gpsi

Gpsi

M

1

Identifies the UE/DS-TT which the parameters below apply.

state

boolean

M

1

When the PTP port state is Leader, Follower or Passive, it is included and set to true to indicate the state of configuration for DS-TT port is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for DS-TT port is inactive. Default value is false.

NOTE: Leader and Follower terms in this specification are aligned with NOTE 2 in clause 5.27.1.2.2.1 of TS 23.501 [3].

5.15.4.4 Simple data types and enumerations

5.15.4.4.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

5.15.4.4.2 Simple data types

The simple data types defined in table 5.15.4.4.2-1 shall be supported.

Table 5.15.4.4.2-1: Simple data types

Type Name

Type Definition

Description

Applicability

5.15.4.4.3 Void
5.15.4.4.4 Enumeration: Protocol

Table 5.15.4.4.4-1: Enumeration Protocol

Enumeration value

Description

Applicability

ETH

Indicates Ethernet as defined in IEEE Std 1588 [45] Annex E is supported.

IPV4

Indicates IPv4 as defined in IEEE Std 1588 [45] Annex C is supported.

IPV6

Indicates IPv6 as defined in IEEE Std 1588 [45] Annex D is supported

5.15.4.4.5 Enumeration: GmCapable

Table 5.15.4.4.5-1: Enumeration GmCapable

Enumeration value

Description

Applicability

GPTP

gPTP grandmaster is supported.

PTP

PTP grandmaste is supported.

5.15.4.4.6 Enumeration: SubscribedEvent

Table 5.15.4.4.6-1: Enumeration SubscribedEvent

Enumeration value

Description

AVAILABILITY_FOR_TIME_SYNC_SERVICE

The AF requests to be notified when the UE is availablility for time synchronization service.

5.15.4.4.7 Enumeration: InstanceType

Table 5.15.4.4.7-1: Enumeration InstanceType

Enumeration value

Description

Applicability

BOUNDARY_CLOCK

Indicates Boundary Clock as defined in IEEE Std 1588 [45].

E2E_TRANS_CLOCK

Indicates End-to-End Transparent Clock as defined in IEEE Std 1588 [45].

P2P_TRANS_CLOCK

Indicates Peer-to-Peer Transparent Clock as defined in IEEE Std 1588 [45].

PTP_RELAY_INSTANCE

Indicates PTP Relay instance as defined in IEEE Std 802.1AS [46]

5.15.4.4.8 Enumeration: AsTimeResource

The enumeration AsTimeResource represents the supported 5G clock quality (i.e. the source of time used by the 5GS). It shall comply with the provisions defined in table 5.15.4.4.8-1.

Table 5.15.4.4.8-1: Enumeration AsTimeResource

Enumeration value

Description

Applicability

ATOMIC_CLOCK

Indicates atomic clock is supported.

GNSS

Indicates Global Navigation Satellite System is supported.

TERRESTRIAL_RADIO

Indicates terrestrial radio is supported.

SERIAL_TIME_CODE

Indicates serial time code is supported.

PTP

Indicates PTP is supported.

NTP

Indicates NTP is supported.

HAND_SET

Indicates hand set is supported.

INTERNAL_OSCILLATOR

Indicates internal oscillator is supported.

OTHER

Indicates other source of time is supported.

5.15.5 Used Features

The table below defines the features applicable to the TimeSyncExposure API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].

Table 5.15.5-1: Features used by TimeSyncExposure API

Feature number

Feature Name

Description

1

Notification_websocket

The delivery of notifications over Websocket is supported as defined in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported.

2

Notification_test_event

The testing of notification connection is supported as defined in 3GPP TS 29.122 [4].

5.15.6 Error handling

5.15.6.1 General

HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].

In addition, the requirements in the following clauses shall apply.

5.15.6.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the TimeSyncExposure API.

5.15.6.3 Application Errors

The application errors defined for the TimeSyncExposure API are listed in table 5.15.6.3-1.

Table 5.15.6.3-1: Application errors

Application Error

HTTP status code

Description