Time Synchronization Exposure

/subscriptions

POST

Create a new subscription to notification of capability of time synchronization service.

Individual Time Synchronization Exposure Subscription

/subscriptions/{subscriptionId}

GET

Read a subscription to notification of capability of time synchronization service.

PUT

Modify a subscription to notification of capability of time synchronization service.

DELETE

Delete a subscription to notification of capability of time synchronization service.

Time Synchronization Exposure Configurations

/subscriptions/{subscriptionId}/configurations

POST

Create a new configuration to time synchronization exposure.

Individual Time Synchronization Exposure Configuration

/subscriptions/{subscriptionId}/configurations/{configurationId}

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.

apiRoot

string

See clause 6.1.1

n/a

TimeSyncExposureSubsc

M

"1

Parameters to request a subscription to notification of the capability for time synchronization service.

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 manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntsctsf-time-sync/{apiVersion}/
subscriptions/{subscriptionId}

apiRoot

string

See clause 6.1.1

subscriptionId

string

Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource.

n/a

n/a

TimeSyncExposureSubsc

M

1

200 OK

An Individual Time Synchronization Exposure Subscription resource is returned successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

The subscription was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Subscription resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Subscription resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

TimeSyncExposureSubsc

M

1

Modify an existing Time Synchronization Exposure Subscription.

TimeSyncExposureSubsc

M

1

200 OK

The subscription was updated successfully.

n/a

204 No Content

The subscription was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Subscription resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Subscription resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 6.1.1

subscriptionId

string

Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource.

n/a

TimeSyncExposureConfig

M

1

Parameters to create a configuration to activate time synchronization service.

TimeSyncExposureConfig

M

1

201 Created

The configuration was created successfully.

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

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Configuration resource creation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Configuration resource creation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntsctsf-time-sync/{apiVersion}/
subscriptions/{subscriptionId}/configuration/{configurationId}

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 6.1.1

subscriptionId

string

Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource.

configurationId

string

Represents a specific configuration. It is the identifier of the Individual Time Synchronization Exposure Configuration resource.

n/a

n/a

TimeSyncExposureConfig

M

1

200 OK

The configuration information in the request URI are returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Configuration resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Configuration resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

TimeSyncExposureConfig

M

1

Modify an existing Time Synchronization Exposure Configuration.

TimeSyncExposureConfig

M

1

200 OK

The subscription was updated successfully.

n/a

204 No Content

The subscription was updated successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Configuration resource update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Configuration resource update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

The configuration was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Time Synchronization Exposure Configuration resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Time Synchronization Exposure Configuration resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

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 Service configuration Notification.

subsNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the Time Synchronization Capability Notification and described within the TimeSyncExposureSubsc type (see table 6.1.6.2.2-1).

TimeSyncExposureSubsNotif

M

1

Provides the time synchronization capabilities of a list of UEs by the TSCTSF to the NF service consumer.

n/a

204 No Content

The event notification is received successfully.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

configNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the Time Synchronization Configuration Notification and described within the TimeSyncExposureConfig type (see table 6.1.6.2.9-1).

TimeSyncExposureConfigNotif

M

1

Provides the current state of time synchronization configuration by the TSCTSF to the NF service consumer.

n/a

204 No Content

The event notification is received successfully.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

ConfigForPort

6.1.6.2.11

Contains the configuration for a port.

PtpCapabilitiesPerUe

6.1.6.2.6

Contains the PTP capabilities supported by a UE.

PtpInstance

6.1.6.2.10

Contains the PTP Instance.

TimeSyncExposureSubsc

6.1.6.2.2

Contains the parameters for the subscription to notification of capability of time synchronization service

TimeSyncCapability

6.1.6.2.5

Contains the capability of time synchronization service

TimeSyncExposureConfig

6.1.6.2.9

Contains the configuration of time synchronization service

TimeSyncExposureConfigNotif

6.1.6.2.7

Contains the notification of configuration of time synchronization service.

TimeSyncExposureSubsNotif

6.1.6.2.3

Contains the notification of time synchronization service.

StateOfConfiguration

6.1.6.2.8

Indicates the PTP port states for a NW-TT and DS-TTs.

StateOfDstt

6.1.6.2.12

Contains the PTP port state of a DS-TT

SubsEventNotification

6.1.6.2.4

Contains the notification of capability of time synchronization for a list of UEs.

AsTimeResource

3GPP TS 29.522 [17]

Indicates the supported 5G clock quality.

DateTime

3GPP TS 29.571 [15]

String with format "date-time" as defined in OpenAPI Specification [6].

DistributionMethod

3GPP TS 29.522 [17]

Identifies the time synchronization distribution methods supported by 5GS.

Dnn

3GPP TS 29.571 [15]

The DNN the user is connected to.

DurationSec

3GPP TS 29.571 [15]

Identifies a period of time in units of seconds.

EventFilter

3GPP TS 29.522 [17]

Contains the conditions to match for notifying the event.

ExternalGroupId

3GPP TS 29.571 [15]

Identifies a External Group.

GmCapable

3GPP TS 29.522 [17]

Indicates separately whether 5GS supports acting as a gPTP or PTP grandmaster.

Gpsi

3GPP TS 29.571 [15]

The external identification of the user (i.e., an External Id or an MSISDN).

GroupId

3GPP TS 29.571 [15]

Identifies a group of internal globally unique ID.

Snssai

3GPP TS 29.571 [15]

Identifies the S-NSSAI.

SubscribedEvent

3GPP TS 29.522 [17]

Indicates the subscribed event.

Supi

3GPP TS 29.571 [15]

The identification of the user (i.e. IMSI, NAI).

SupportedFeatures

3GPP TS 29.571 [15]

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

TimeSyncExposureConfig

3GPP TS 29.522 [17]

Contains the parameters of time synchronization configuration.

Uinteger

3GPP TS 29.571 [15]

Unsigned integer.

Uint64

3GPP TS 29.571 [15]

Uri

3GPP TS 29.571 [15]

Identifies a referenced resource.

supis

array(Supi)

C

1..N

Subscription Permanent Identifier. (NOTE)

gpsis

array(Gpsi)

C

1..N

Public user identifier.

(NOTE)

interGrpId

GroupId

C

0..1

The internal Group Id(s).

(NOTE)

exterGrpId

ExternalGroupId

C

0..1

The external Group Id.

(NOTE)

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)

notifMethod

NotificationMethod

O

0..1

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

dnn

Dnn

M

1

Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

snssai

Snssai

M

1

Identifies an S-NSSAI.

subscribedEvents

array(SubscribedEvent)

M

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".

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: Only one of the properties "supis", "gpsis", "anyUeInd", "exterGrpId" or "interGrpId" shall be included.

subsNotifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(SubsEventNotification)

M

1..N

Notifications about Individual Events

event

SubscribedEvent

M

1

Subscribed events

timeSyncCapas

array(TimeSyncCapability)

C

1..N

Contains a list of time syncroniziation capabilities for the List of User-Plane Node IDs. It shall be provided if the reported event is "AVAILABILITY_FOR_TIME_SYNC_SERVICE".

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 Std 802.1Q-2018 [18] 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 SUPI.

Shall be present if the "gmCapables" attribute is included and the PTP Capabilities are reported per SUPI.

ptpCapForGpsis

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 and the PTP Capabilities are reported per GPSI.

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

supi

Supi

C

0..1

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

(NOTE)

gpsi

Gpsi

C

0..1

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

(NOTE)

ptpCaps

array(EventFilter)

M

1..N

Contains the reported PTP capabilities for the UE.

NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier.

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

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.

stateOfDstts

array(StateOfDstt)

O

1..N

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

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

O

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

O

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.

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

array(ConfigForPort)

O

1..N

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

supi

Supi

C

0..1

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

(NOTE)

gpsi

Gpsi

C

0..1

Identifies the UE/ DS-TT which the parameters below apply (NOTE)

n6Ind

boolean

C

0..1

Indicates the N6 termination which the parameters below apply.

(NOTE)

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-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] 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-2020 [26]. When set to TRUE, the value of "logSyncInter" attribute is used to set the mgtSettableLogSyncInterval as described in IEEE Std 802.1AS-2020 [26].

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

logAnnouInter

integer

O

0..1

Specifies the mean time interval between successive Announce messages. This is applicable for IEEE Std 1588-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] 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-2020 [26]. When set to TRUE, the value of "logAnnouInter" attribute is used to set the mgtSettableLogAnnounceInterval as described in IEEE Std 802.1AS-2020 [26].

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

NOTE: Only one of "supi", "gpsi" or "n6Ind" attribute shall be included.

supi

Supi

C

0..1

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

(NOTE)

gpsi

Gpsi

C

0..1

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

(NOTE)

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: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier

TSC Application Sessions

/tsc-app-sessions

POST

Ntsctsf_QoSandTSCAssistance_Create. Creates a new Individual TSC Application Session Context resource and may create the child Events Subscription sub-resource.

Individual TSC Application Session Context

/tsc-app-sessions/{appSessionId}

PATCH

Ntsctsf_QoSandTSCAssistance_Update. Updates an existing Individual TSC Application Session Context resource. It can also update an Events Subscription sub-resource.

GET

Reads an existing Individual TSC Application Session Context resource.

/tsc-app-sessions/{appSessionId}/delete

delete

(POST)

Ntsctsf_QoSandTSCAssistance_Delete. Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource.

Events Subscription

/tsc-app-sessions/{appSessionId}
/events-subscription

PUT

Ntsctsf_QoSandTSCAssistance_Subscribe. Creates a new Events Subscription sub-resource or modifies an existing Events Subscription sub-resource.

DELETE

Ntsctsf_QoSandTSCAssistance_Unsubscribe.

Deletes an Events Subscription sub-resource.

apiRoot

string

See clause 6.2.1

n/a

TscAppSessionContextData

M

1

Contains the information for the creation of a new Individual TSC Application Session Context resource.

TscAppSessionContextData

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 manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntsctsf-qos-tscai/<apiVersion>/tsc-app-sessions /{appSessionId}

apiRoot

string

See clause 6.2.1

appSessionId

string

Identifier of an Individual TSC Application Session Context resource

n/a

n/a

TscAppSessionContextData

M

1

200 OK

An Individual TSC Application Session Context resource is returned successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual TSC Application Session Context resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual TSC Application Session Context resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

TscAppSessionContextUpdateData

M

1

Contains the modification(s) to apply to the Individual TSC Application Session Context resource.

TscAppSessionContextData

M

1

200 OK

Successful case.

The Individual TSC Application Session Context resource was modified and a representation of that resource is returned.

n/a

204 No Content

Successful case.

The Individual TSC Application Session Context resource was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual TSC Application Session Context resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual TSC Application Session Context resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PATCH method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

delete

/tsc-app-sessions/{appSessionId}/delete

POST

Ntsctsf_QoSandTSCAssistance_Delete. Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource.

EventsSubscReqData

O

0..1

Events subscription information to be sent by the NF service consumer to request event notification when the Individual TSC Application Session Context resource is deleted.

n/a

204 No Content

Successful case.

The Individual TSC Application Session Context resource was deleted.

EventsNotification

M

1

200 OK

Successful case.

Describes information related to the notification of events.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual TSC Application Session Context resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual TSC Application Session Context resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 6.2.1

appSessionId

string

Identifier of an Individual TSC Application Session Context resource.

n/a

EventsSubscReqData

M

1

Contains information for the modification of the Events Subscription sub-resource.

EventsSubscReqData

M

1

201 Created

Successful case.

The Events Subscription sub-resource was created.

EventsSubscReqData

M

1

200 OK

Successful case.

The Events Subscription sub-resource was modified.

n/a

204 No Content

Successful case.

The Events Subscription sub-resource was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Events Subscription sub-resource creation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Events Subscription sub-resource creation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ntsctsf-qos-tscai/<apiVersion>/tsc-app-sessions/{appSessionId}/events-subscription

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case.

The Events Subscription sub-resource was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Events Subscription sub-resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Events Subscription sub-resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Event Notification

{notifUri}/notify

notify (POST)

TSCTSF event notification.

Termination Request

{notifUri}/terminate

terminate (POST)

Request for termination of an Individual TSC Application Session Context.

notifUri

The Notification Uri as assigned within the Events Subscription sub-resource and described within the EventsSubscReqData type (see table 6.2.6.2.3-1) or EventsSubscReqDataRm (see table 6.2.6.2.5-1).

EventsNotification

M

1

Provides Information about observed events.

n/a

204 No Content

The event notification is received successfully.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

notifUri

The Notification Uri as assigned within the Individual TSC Application Session Context resource and described within the TscAppSessionContextData Data type (see table 6.2.6.2.2-1) or TscAppSessionContextUpdateData (see table 6.2.6.2.4-1).

TerminationInfo

M

1

Provides information about the deletion of the resource.

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

EventsNotification

6.2.6.2.6

Describes the notification(s) about the event(s) occurred within an Individual TSC Application Session Context resource.

EventNotification

6.2.6.2.7

Describes the notification for an Event.

EventsSubscReqData

6.2.6.2.3

Identifies the events the application subscribes to within an Individual TSC Application Session Context resource

EventsSubscReqDataRm

6.2.6.2.5

This data type is defined in the same way as the "EventsSubscReqData" data type, but with the OpenAPI "nullable: true" property.

TscAppSessionContextData

6.2.6.2.2

Represents the Individual TSC Application Session Context resource data.

TscAppSessionContextUpdateData

6.2.6.2.4

Describes the modifications to an Individual TSC Application Session Context resource.

TscEvent

6.2.6.3.3

Indicates the subscribed event(s).

AccumulatedUsage

3GPP TS 29.122 [21]

Accumulated Usage.

AspId

3GPP TS 29.514 [20]

Contains an identity of an application service provider.

Dnn

3GPP TS 29.571 [15]

The DNN the user is connected to.

EthFlowDescription

3GPP TS 29.514 [20]

Defines a packet filter for an Ethernet flow.

EthFlowInfo

3GPP TS 29.122 [21]

Contains an UL and/or DL Flow information.

Ethernet_UL/DL_Flows

FlowInfo

3GPP TS 29.122 [21]

Contains the IP data flow information.

IpAddr

3GPP TS 29.571 [15]

Contains the IP address.

MacAddr48

3GPP TS 29.571 [15]

MAC Address.

QosMonitoringInformation

3GPP TS 29.122 [21]

Contains Qos Monitoring information.

QosMonitoringInformationRm

3GPP TS 29.122 [21]

This data type is defined in the same way as the "QosMonitoringInformation" data type, but with the OpenAPI "nullable: true" property.

QosMonitoringReport

3GPP TS 29.122 [21]

Contains Qos Monitoring Report information.

Snssai

3GPP TS 29.571 [15]

Identifies the S-NSSAI.

SponId

3GPP TS 29.514 [20]

Contains an Identity of a sponsor.

SponsoringStatus

3GPP TS 29.514 [20]

Represents whether sponsored data connectivity is enabled or disabled/not enabled.

SubscribedEvent

3GPP TS 29.522 [17]

Indicates the subscribed event.

SupportedFeatures

3GPP TS 29.571 [15]

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

TerminationInfo

3GPP TS 29.514 [20]

Includes information related to the termination of the Individual TSC Application Session Context resource.

TscQosRequirement

3GPP TS 29.122 [21]

Contains the QoS requirements for time sensitive communication.

TscQosRequirementRm

3GPP TS 29.122 [21]

This data type is defined in the same way as the "TscQosRequirement" data type, but with removable attributes.

UsageThreshold

3GPP TS 29.122 [21]

Time period and/or traffic volume in which the QoS is to be applied.

UsageThresholdRm

3GPP TS 29.122 [21]

This data type is defined in the same way as the "UsageThreshold" data type, but with the OpenAPI "nullable: true" property.

Uri

3GPP TS 29.571 [15]

Identifies a referenced resource.

ueIpAddr

IpAddr

C

0..1

The address of the UE.

(NOTE 1)

ipDomain

string

C

0..1

The IPv4 address domain identifier.

The attribute may only be provided if the ueIpAddr attribute is present and contains an IPv4 address.

ueMac

MacAddr48

C

0..1

Identifies the MAC address.

(NOTE 1)

dnn

Dnn

O

0..1

Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

snssai

Snssai

O

0..1

Identifies the S-NSSAI.

notifUri

Uri

M

1

Notification URI for Individual TSC Application Session Context termination requests.

appId

string

C

0..1

Identifies the Application Identifier. (NOTE 1)

flowInfo

array(FlowInfo)

C

1..N

Describe the IP data flow which requires QoS.

(NOTE 1) (NOTE 4)

enEthFlowInfo

array(EthFlowInfo)

C

1..N

Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.

(NOTE 1) (NOTE 4)

Ethernet_UL/DL_Flows

ethFlowInfo

array(EthFlowDescription)

C

1..N

Identifies Ethernet packet flows.

(NOTE 1)

afId

string

M

1

Identifies the AF identifier.

tscQosReq

TscQosRequirement

C

0..1

Contains the QoS requirements for time sensitive communication. (NOTE 2)

qosReference

string

C

0..1

Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3)

altQosReferences

array(string)

C

1..N

Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

altQosReqs

array(AlternativeServiceRequirementsData)

C

1..N

Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

sponId

SponId

O

0..1

Sponsor identity.

aspId

AspId

O

0..1

Application service provider identity. It shall be included if

sponStatus

SponsoringStatus

O

0..1

Indication of whether sponsored connectivity is enabled or disabled/not enabled.

The absence of the attribute indicates that the sponsored connectivity is enabled.

evSubsc

EventsSubscReqData

O

0..1

Identifies the events the application subscribes to at creation of an Individual TSC Application Session Context resource.

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 6.2.8.

It shall be supplied by the NF service consumer in the POST request and response of requests a creation of an Individual TSC Application Session Context resource.

NOTE 1: Eirther "ueIpAddr" attribute or "ueMac" attribute shall be included. If IP address is provided, IP flow information shall be provided. If ipv4, the domain identifier may be provided. If mac address is provided, Ethernet flow information shall be provided. One of IP flow information, Ethernet flow information or Application Identifier shall be provided.

NOTE 2: The attributes "reqGbrDl", "reqGbrUl", "reqMbrDl", "reqMbrUl", "maxTscBurstSize", "req5Gsdelay", and "priority" within the "tscQosReq" attribute may be provided only if the "qosReference" attribute is not provided. At least one of "tscQosReq" attribute or "qosReference" attribute shall be included.

NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive.

NOTE 4: When the Ethernet flow information is provided and the Ethernet_UL/DL_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultaneously.

events

array(TscEvent)

M

1..N

Subscribed Events.

notifUri

Uri

M

1

Notification URI for event notification.

qosMon

QosMonitoringInformation

C

0..1

Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed.

usgThres

UsageThreshold

C

0..1

Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the event "USAGE_REPORT" is subscribed.

notifCorreId

string

M

1

It is used to set the value of Notification Correlation ID in the corresponding notification.

notifUri

Uri

O

0..1

Notification URI for Individual TSC Application Session Context termination requests.

appId

string

O

0..1

Identifies the external Application Identifier. (NOTE 1)

flowInfo

array(FlowInfo)

O

1..N

Describe the IP data flow which requires QoS.

(NOTE 1)

ethFlowInfo

array(EthFlowDescription)

O

1..N

Identifies Ethernet packet flows.

(NOTE 1) (NOTE 4)

enEthFlowInfo

array(EthFlowInfo)

C

1..N

Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.

(NOTE 1) (NOTE 4)

Ethernet_UL/DL_Flows

tscQosReq

TscQosRequirementRm

C

0..1

Contains the QoS requirements for time sensitive communication. (NOTE 2)

qosReference

string

C

0..1

Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3)

altQosReferences

array(string)

C

1..N

Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

altQosReqs

array(AlternativeServiceRequirementsData)

C

1..N

Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

evSubsc

EventsSubscReqDataRm

O

0..1

Identifies the events the application subscribes to at modification of an Individual TSC Application Session Context resource.

sponId

SponId

O

0..1

Sponsor identity.

aspId

AspId

O

0..1

Application service provider identity. It shall be included if

sponStatus

SponsoringStatus

O

0..1

Indication of whether sponsored connectivity is enabled or disabled/not enabled.

The absence of the attribute indicates that the sponsored connectivity is enabled.

NOTE 1: One of IP flow information, Ethernet flow information or Application Identifier may be provided.

NOTE 2: Either "tscQosReq" attribute or "qosReference" attribute may be provided.

NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive.

NOTE 4: When the Ethernet flow information is provided and the Ethernet_UL/DL_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultaneously.

events

array(TscEvent)

M

1..N

Subscribed Events.

notifUri

Uri

O

0..1

Notification URI for event notification.

qosMon

QosMonitoringInformationRm

O

0..1

Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed.

usgThres

UsageThresholdRm

C

0..1

Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the notified event is "USAGE_REPORT".

notifCorreId

string

O

0..1

It is used to set the value of Notification Correlation ID in the corresponding notification.

notifCorreId

string

M

1

It is used to set the value of Notification Correlation ID in the corresponding notification.

events

array(EventNotification)

M

1..N

Contains the reported event(s).

event

TscEvent

M

1

Indicates the event reported by the TSCTSF.

flowIds

array(integer)

O

1..N

Identifies the flows that were sent during event subscription

qosMonReports

array(QosMonitoringReport)

C

1..N

QoS Monitoring reporting information. It shall be present when the notified event is "QOS_MONITORING".

appliedQosRef

string

C

0..1

The currently applied alternative QoS requirement referring to an alternative QoS reference or a requested alternative QoS parameter set. Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.

When it is omitted and the "event" attribute is QOS_NOT_GUARANTEED, the event report indicates that the lowest priority alternative QoS profile could not be fulfilled either.

usgRep

AccumulatedUsage

C

0..1

Indicates the measured volume and/or time for sponsored data connectivity. Applicable for event USAGE_REPORT.

<one simple data type, i.e. boolean, integer, number, or string>

FAILED_RESOURCES_ALLOCATION

Indicates that one or more of the SDFs of an Individual TSC Application Session Context are deactivated. It also indicates that the resources requested for a particular service information cannot be successfully allocated.

SUCCESSFUL_RESOURCES_ALLOCATION

Indicates that the resources requested for particular service information have been successfully allocated.

QOS_GUARANTEED

The QoS targets of one or more SDFs are guaranteed again.

QOS_NOT_GUARANTEED

The QoS targets of one or more SDFs are not being guaranteed.

QOS_MONITORING

Indicates a QoS monitoring event.

USAGE_REPORT

Volume and/or time usage for sponsored data connectivity.

1

Ethernet_UL/DL_Flows

Indicates the support of the description of the Ethernet flows as the combination of Flow Identifier, and UL and/or DL Ethernet flows.

ASTI Configurations

/configurations/

POST

Create a new configuration of the 5G access stratum time distribution.

configurations/retrieve

retrieve

(POST)

Request the status of the access stratum time distribution for a list of UEs.

Individual ASTI Configuration

/configurations/{configId}

PUT

Request to update the 5G access stratum time distribution configuration.

DELETE

Request to delete the 5G access stratum time distribution configuration.

apiRoot

string

See clause 6.3.1

n/a

AccessTimeDistributionData

M

1

Contains the information for the creation of a new Individual ASTI Configuration resource.

AccessTimeDistributionData

M

1

201 Created

The resource was created successfully and a representation of the created resource is returned.

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

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ntsctsf-asti/<apiVersion>/configurations/{configId}

retrieve

/configurations/retrieve

retrieve (POST)

Request the status of the 5G access stratum time distribution for a list of UEs.

StatusRequestData

M

1

Parameters to be sent by the NF service consumer when the status of the 5G access stratum time distribution for a list of UEs is requested.

StatusResponseData

M

1

200 OK

Status of the 5G access stratum time distribution for a list of UEs is returned.

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

apiRoot

string

See clause 6.3.1

configId

string

Identifier of an Individual ASTI Configuration resource.

n/a

AccessTimeDistributionData

M

1

Contains the modification(s) to apply to the Individual ASTI Configuration resource.

AccessTimeDistributionData

M

1

200 OK

Successful case. The Individual ASTI Configuration resource was modified and a representation of that resource is returned.

n/a

204 No Content

Successful case.

The Individual ASTI Configuration resource was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual ASTI Configuration resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual ASTI Configuration resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PATCH method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

The configuration was terminated successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual ASTI Configuration resource modification deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual ASTI Configuration resource modification e deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative TSCTSF (service) instance.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PATCH method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative TSCTSF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

AccessTimeDistributionData

6.3.6.2.2

Contains the parameters for the creation of 5G access stratum time distribution configuration.

AsTimeDistributionParam

6.3.6.2.3

Contains the 5G access stratum time distribution parameters.

ActiveUe

6.3.6.2.6

Contains the UE identifier whose status of the access stratum time distribution is active and the optional requested time synchronization error budget.

StatusRequestData

6.3.6.2.4

Contains the parameters for retrieval of the status of the access stratum time distribution for a list of UEs.

StatusResponseData

6.3.6.2.5

Contains the parameters for the status of the access stratum time distribution for a list of UEs.

ExternalGroupId

3GPP TS 29.571 [15]

Identifies an External Group.

Gpsi

3GPP TS 29.571 [15]

The external identification of the user (i.e., an External Id or an MSISDN).

GroupId

3GPP TS 29.571 [15]

Identifies a group of internal globally unique ID.

Supi

3GPP TS 29.571 [15]

The identification of the user (i.e. IMSI, NAI).

SupportedFeatures

3GPP TS 29.571 [15]

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

TemporalValidity

3GPP TS 29.514 [20]

TemporalValidity

Uinteger

3GPP TS 29.571 [15]

Unsigned integer.

supis

array(Supi)

C

1..N

Subscription Permanent Identifier(s). (NOTE)

gpsis

array(Gpsi)

C

1..N

Public user Identifier(s). (NOTE)

interGrpId

GroupId

C

0..1

The internal Group Id(s). (NOTE)

exterGrpId

ExternalGroupId

C

0..1

The external Group Id(s). (NOTE)

asTimeDisParam

AsTimeDistributionParam

M

1

5G access stratum time distribution parameters

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 ASTI Configuration resource.

NOTE: One of "supis", "gpsis", "exterGroupId" or "interGrpId" attributes shall be provided.

asTimeDisEnabled

boolean

O

0..1

When this attribute is included and set to true, it indicates that the access stratum time distribution via Uu reference point is activated.

When present it shall be set as follows:

– true: activated.

– false (default): deactivated.

timeSyncErrBdgt

Uinteger

O

0..1

Indicates the time synchronization error budget in terms of time units of nanoseconds.

tempValidity

TemporalValidity

O

0..1

Indicates the time interval during which the AF request is to be applied.

supis

array(Supi)

C

1..N

Subscription Permanent Identifier(s).

gpsis

array(Gpsi)

C

1..N

Public User Identifier(s).

(NOTE)

NOTE: Either the "supis" or the "gpsis" attribute is included, based on whether the request contained an internal or an external identifier.

inactiveUes

array(Supi)

O

1..N

Indicate the SUPI(s) whose status of the access stratum time distribution is inactive.

(NOTE)

inactiveGpsis

array(Gpsi)

O

1..N

Indicate the GPSI(s) whose status of the access stratum time distribution is inactive.

(NOTE)

activeUes

array(ActiveUe)

O

1..N

Contains the UE identifier(s) whose status of the access stratum time distribution is active and the optional requested time synchronization error budget.

NOTE: Either the "inactiveUes" or the "inactiveGpsis" attribute is included, based on whether the request contained an internal or an external identifier.

supi

Supi

C

0..1

Indicate the SUPI whose status of the access stratum time distribution is active.

(NOTE)

gpsi

Gpsi

C

0..1

Indicate the GPSI whose status of the access stratum time distribution is active.

(NOTE)

timeSyncErrBdgt

Uinteger

O

0..1

Indicates the time synchronization error budget in terms of time units of nanoseconds.

NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier.