A.4 Ntsctsf_ASTI API
29.5653GPP5G SystemRelease 18Stage 3Time Sensitive Communication and Time Synchronization Function ServicesTS
openapi: 3.0.0
info:
title: Ntsctsf_ASTI Service API
version: 1.1.0-alpha.1
description: |
TSCTSF Access Stratum time distribution configuration Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.565 V18.0.0; 5G System; Time Sensitive Communication and
Time Synchronization Function Services; Stage 3.
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/’
servers:
– url: ‘{apiRoot}/ntsctsf-asti/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– ntsctsf-asti
paths:
/configurations:
post:
summary: Creates a new Individual ASTI Configuration resource.
operationId: ASTIConfiguration
tags:
– ASTI Configurations (Collection)
requestBody:
description: Contains the information for the creation the resource.
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AccessTimeDistributionData’
responses:
‘201’:
description: Successful creation of the resource.
content:
application/json:
schema:
$ref: ‘#/components/schemas/AccessTimeDistributionData’
headers:
Location:
description: >
Contains the URI of the created individual ASTI Configuration resource,
according to the structure
{apiRoot}/ntsctsf-asti/{apiVersion}/configurations/{configId}
required: true
schema:
type: string
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/configurations/retrieve:
post:
summary: Request the status of the 5G access stratum time distribution for a list of UEs.
operationId: RequestStatusof5GAccessStratumTimeDistribution
tags:
– ASTI Configurations
requestBody:
description: >
Contains the information for the status of the 5G access stratum time distribution.
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/StatusRequestData’
responses:
‘200’:
description: >
Successful retrieval of the status of the 5G access stratum time distribution.
content:
application/json:
schema:
$ref: ‘#/components/schemas/StatusResponseData’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/configurations/{configId}:
put:
summary: Modifies an existing Individual ASTI Configuration resource.
operationId: ModifyIndividualASTIConfiguration
tags:
– Individual ASTI Configuration (Document)
parameters:
– name: configId
description: String identifying an Individual ASTI Configuration.
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AccessTimeDistributionData’
responses:
‘200’:
description: OK. Resource was succesfully modified and representation is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/AccessTimeDistributionData’
‘204’:
description: No Content. Resource was succesfully modified.
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
operationId: DeleteIndividualASTIConfiguration
summary: Delete an Individual ASTI Configuration
tags:
– Individual ASTI Configuration (Document)
parameters:
– name: configId
in: path
description: String identifying an Individual ASTI Configuration.
required: true
schema:
type: string
responses:
‘204’:
description: No Content. Resource was successfully deleted.
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
ntsctsf-asti: Access to the Ntsctsf_ASTI API
schemas:
AccessTimeDistributionData:
description: >
Contains the parameters for the creation of 5G access stratum time distribution
configuration.
type: object
properties:
supis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
gpsis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
interGrpId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
exterGrpId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ExternalGroupId’
asTimeDisParam:
$ref: ‘#/components/schemas/AsTimeDistributionParam’
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– asTimeDisParam
oneOf:
– required: [supis]
– required: [interGrpId]
– required: [gpsis]
– required: [exterGrpId]
AsTimeDistributionParam:
description: Contains the 5G access stratum time distribution parameters.
type: object
properties:
asTimeDisEnabled:
type: boolean
description: >
When this attribute is included and set to true, it indicates that the access stratum
time distribution via Uu reference point is activated.
timeSyncErrBdgt:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’
tempValidity:
$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity’
StatusRequestData:
description: >
Contains the parameters for retrieval of the status of the access stratum time distribution
for a list of UEs.
type: object
properties:
supis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
gpsis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
oneOf:
– required: [supis]
– required: [gpsis]
StatusResponseData:
description: >
Contains the parameters for the status of the access stratum time distribution for a list of
UEs.
type: object
properties:
inactiveUes:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
inactiveGpsis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
activeUes:
type: array
items:
$ref: ‘#/components/schemas/ActiveUe’
minItems: 1
ActiveUe:
description: >
Contains the UE identifier whose status of the access stratum time distribution is active
and the optional requested time synchronization error budget.
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
timeSyncErrBdgt:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’
oneOf:
– required: [supi]
– required: [gpsi]
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2021-08 |
TS skeleton |
0.0.0 |
|||||
|
2021-08 |
CT3#117e |
C3-214576 |
Inclusion of documents agreed in CT3#117e: C3-214145, C3-214149, C3-214154, C3-214466, C3-214467, C3-214468, C3-214469, C3-214505, C3-214506, C3-214507, C3-214508, C3-214509, C3-214510 |
0.1.0 |
|||
|
2021-10 |
CT3#118e |
C3-215473 |
Inclusion of documents agreed in CT3#118e: C3-215347, C3-215348, C3-215349, C3-215350, C3-215351, C3-215352, C3-215353, C3-215354, C3-215356, C3-215357, C3-215358, C3-215470 |
0.2.0 |
|||
|
2021-11 |
CT3#119e |
C3-216517 |
Inclusion of documents agreed in CT3#119e: C3-216114, C3-216115, C3-216116, C3-216121, C3-216397, C3-216398, C3-216399, C3-216400, C3-216401, C3-216402, C3-216426, C3-216594, C3-215357, C3-216595 |
0.3.0 |
|||
|
2021-12 |
CT#94-e |
CP-213208 |
Presentation for information |
1.0.0 |
|||
|
2022-01 |
CT3#119bis-e |
C3-220449 |
Inclusion of documents agreed in CT3#119bis-e: C3-220424, C3-220165, C3-220166, C3-220167, C3-220425, C3-220423, C3-220415, C3-220359, C3-220172 |
1.1.0 |
|||
|
2022-02 |
CT3#120e |
C3-221512 |
Inclusion of documents agreed in CT3#120e: C3-221181, C3-221184, C3-221185, C3-221186, C3-221187, C3-221189, C3-221190, C3-221191, C3-221192, C3-221237, C3-221445, C3-221446, C3-221469, C3-221552, C3-221606, C3-221650 |
1.2.0 |
|||
|
2022-04 |
CT3#121e |
C3-222482 |
Inclusion of documents agreed in CT3#121e: C3-222176, C3-222177, C3-222178, C3-222179, C3-222181, C3-222182, C3-222183, C3-222295, C3-222420, C3-222424, C3-222435, C3-222489, C3-222503, C3-222507, C3-222555, C3-222556, C3-222564, |
1.3.0 |
|||
|
2022-05 |
CT3#122e |
C3-223505 |
Inclusion of documents agreed in CT3#122e: C3-223121, C3-223122, C3-223124, C3-223126, C3-223229, C3-223230, C3-223131, C3-223132, C3-223283, C3-223286, C3-223469, C3-223471, C3-223472, C3-223490, C3-223494, C3-223495, C3-223660, C3-223661, C3-223693, C3-223739, C3-223744, C3-223749, |
1.4.0 |
|||
|
2022-06 |
CT#96 |
CP-221099 |
Presentation to TSG CT for approval |
2.0.0 |
|||
|
2022-06 |
CT#96 |
CP-221099 |
Approved by TSG CT |
17.0.0 |
|||
|
2022-09 |
CT#97e |
CP-222113 |
0001 |
– |
F |
Add PUT method in table 6.1.3.1-1 |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0002 |
1 |
F |
Correction to 5G access time distribution |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0003 |
1 |
F |
Correction to initial provisioning of TSC related service information |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0004 |
– |
F |
Correction to notification about TSC application session context event |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0005 |
– |
F |
Correction to notification about TSC application session context termination |
17.1.0 |
|
2020-09 |
CT#97e |
CP-222113 |
0006 |
1 |
F |
Correction to subscription to events for the existing TSC application session context |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0007 |
1 |
F |
Correction to the procedure of creating a new subscription |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0009 |
1 |
F |
Corrections to the methods of Ntsctsf_ASTI Service API |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0010 |
1 |
F |
Corrections to the methods of Ntsctsf_QoSandTSCAssistance API |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0011 |
– |
F |
Corrections to the methods of Ntsctsf_TimeSynchronization API |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0013 |
1 |
F |
Handling of temporal validity condition |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0018 |
– |
F |
Support of sponsored connectivity |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0019 |
1 |
F |
Correction to the references |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0020 |
1 |
F |
Correction to time synchronization capabilities subscription |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0021 |
1 |
F |
Data Model corrections |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0022 |
1 |
F |
Correction of the association of Time Sync Exposure subscriptions to AF sessions |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0023 |
1 |
F |
Correction of the handling of AM policies upon Time Sync configuration |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222114 |
0024 |
1 |
F |
TSCTSF API corrections |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222183 |
0025 |
1 |
F |
Mapping of GPSIs and Group Identifiers to a SUPI list |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0026 |
– |
F |
Definitions of HTTP "403 Forbidden" response |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222113 |
0027 |
– |
F |
Initial provisioning of TSC related service information |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222121 |
0028 |
– |
F |
Update of info and externalDocs fields |
17.1.0 |
|
2022-12 |
CT#98 |
CP-223181 |
0029 |
1 |
F |
Corrections in the error budget calculation |
17.2.0 |
|
2022-12 |
CT#98 |
CP-223181 |
0030 |
– |
F |
Miscellaneous corrections in the Time Synchronization API |
17.2.0 |
|
2022-12 |
CT#98 |
CP-223181 |
0033 |
– |
F |
Correction to Ethernet flows |
17.2.0 |
|
2022-12 |
CT#98 |
CP-223188 |
0034 |
– |
F |
Update of info and externalDocs fields |
17.2.0 |
|
2022-12 |
CT#98 |
CP-223191 |
0031 |
– |
F |
Adding the mandatory error code 502 Bad Gateway |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223192 |
0032 |
1 |
F |
TscEvent enumeration definition in the OpenAPI file |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223190 |
0035 |
– |
F |
Update of info and externalDocs fields |
18.0.0 |