A.12 Eecs_TargetEESDiscovery API
29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS
openapi: 3.0.0
info:
title: ECS Target EES Discovery API
description: |
API for Target EES Discovery.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: 1.1.0-alpha.1
externalDocs:
description: >
3GPP TS 29.558 V18.0.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
security:
– {}
– oAuth2ClientCredentials: []
servers:
– url: ‘{apiRoot}/eecs-targeteesdiscovery/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558.
paths:
/ees-profiles:
get:
summary: Read all EES Profiles
operationId: GetEESProfiles
tags:
– EES Profiles (Collection)
description: Retrieve the T-EES information.
parameters:
– name: ees-id
in: query
description: Unique identifier of the S-EES.
required: true
schema:
type: string
– name: eas-id
in: query
description: Unique identifier of the S-EAS.
required: true
schema:
type: string
– name: target-dnai
in: query
description: The DNAI information associated with the potential T-EES(s) and/or T-EAS(s).
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’
– name: ue-id
in: query
description: Identifier of the UE.
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
– name: ue-location
in: query
description: The location information of the UE.
required: false
schema:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/LocationArea5G’
responses:
‘200’:
description: The EDN configuration and the T-EES information determined by ECS.
content:
application/json:
schema:
$ref: ‘TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/ECSServProvResp’
‘400’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/404’
‘406’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/406’
‘429’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{tokenUrl}’
scopes: {}
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2021-01 |
CT3#113e |
C3-210300 |
TS skeleton for Enabling Edge Applications, Application Programming Interface (API) specification; Stage 3. |
0.0.0 |
|||
|
2021-01 |
CT3#113e |
C3-210322 |
Inclusion of documents agreed in CT3#113e: C3-210182, C3-210301, C3-210321 |
0.1.0 |
|||
|
2021-03 |
CT3#114e |
C3-211508 |
Inclusion of documents agreed in CT3#114e: C3-211365, C3-211503, C3-211504, C3-211505, C3-211506, |
0.2.0 |
|||
|
2021-04 |
CT3#115e |
C3-212520 |
Inclusion of documents agreed in CT3#115e: C3-212367, C3-212368, C3-212369, C3-212370 |
0.3.0 |
|||
|
2021-05 |
CT3#116e |
C3-213328 |
Inclusion of documents agreed in CT3#116e: C3-213324, C3-213325, C3-213326, C3-213327, C3-213547 |
0.4.0 |
|||
|
2021-08 |
CT3#117e |
C3-214571 |
Inclusion of documents agreed in CT3#117e: C3-214387, C3-214513, C3-214389, C3-214570, C3-214388, |
0.5.0 |
|||
|
2021-09 |
CT#93e |
CP-212164 |
Version 1.0.0 created for presentation for information. |
1.0.0 |
|||
|
2021-10 |
CT3#118e |
C3-215471 |
Inclusion of documents agreed in CT3#118e: C3-215236, C3-215338, C3-215339, C3-215340, C3-215341, |
1.1.0 |
|||
|
2021-11 |
CT3#119e |
C3-216515 |
Inclusion of documents agreed in CT3#119e: C3-216182, C3-216347, C3-216348, C3-216385, C3-216386, |
1.2.0 |
|||
|
2022-01 |
CT3#119-Bis-e |
C3-220447 |
Inclusion of documents agreed in CT3#119-Bis-e: C3-220133, C3-220419, C3-220420, C3-220421, C3-220459, |
1.3.0 |
|||
|
2022-02 |
CT3#120e |
C3-221510 |
Inclusion of documents agreed in CT3#120e: C3-221401, C3-221635, C3-221408, C3-221636, C3-221407, |
1.4.0 |
|||
|
2022-04 |
CT3#121e |
C3-222481 |
Inclusion of documents agreed in CT3#121e: C3-222136, C3-222137, C3-222139, C3-222141, C3-222143, |
1.5.0 |
|||
|
2022-05 |
CT3#122e |
C3-223504 |
Inclusion of documents agreed in CT3#122e: C3-223195, C3-223321, C3-223323, C3-223325, C3-223326, C3-223327, C3-223331, C3-223334, C3-223336, C3-223337, C3-223575, C3-223606, C3-223607, C3-223608, C3-223646, C3-223647, C3-223648, C3-223649, C3-223650, C3-223675, C3-223676, C3-223677, C3-223691, C3-223756, C3-223781, C3-223792, C3-223793, C3-223794 |
1.6.0 |
|||
|
2022-06 |
CT#96 |
CP-221100 |
Presentation to TSG CT for approval |
2.0.0 |
|||
|
2022-06 |
CT#96 |
CP-221100 |
Approved by TSG CT |
17.0.0 |
|||
|
2022-09 |
CT#97e |
CP-222097 |
0001 |
1 |
F |
Corrections to Eees_EASDiscovery_TeasDiscRequest operation |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0002 |
1 |
F |
Add failure handling descriptions for EES services |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0003 |
1 |
F |
Add failure handling descriptions for ECS services |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0004 |
1 |
F |
Add redirect descriptions for EES services |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0005 |
1 |
F |
Add redirect descriptions for ECS services |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0006 |
1 |
F |
Corrections on ACRDataStatus and ACTResultInfo |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0007 |
F |
Corrections on HTTP methods in EES services |
17.1.0 |
|
|
2022-09 |
CT#97e |
CP-222097 |
0008 |
F |
Correction on OpenenAPI Eees_ EECContextRelocation |
17.1.0 |
|
|
2022-09 |
CT#97e |
CP-222097 |
0009 |
F |
Corrections on OpenAPI Eees_EELManagedACR |
17.1.0 |
|
|
2022-09 |
CT#97e |
CP-222098 |
0010 |
1 |
F |
Corrections to EES APIs definition |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222098 |
0011 |
1 |
F |
Corrections to Eees_EELManagedACR API definition |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222097 |
0012 |
F |
Remove unused reference to OMA |
17.1.0 |
|
|
2022-09 |
CT#97e |
CP-222205 |
0014 |
1 |
F |
Correcting the name of the data type related to availability status information |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222206 |
0015 |
2 |
F |
Clarifications to the "easId" |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222098 |
0017 |
1 |
F |
Corrections to user consent revocation management for the Eees_UELocation API |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222121 |
0018 |
F |
Update of info and externalDocs fields |
17.1.0 |
|
|
2022-12 |
CT#98e |
CP-223170 |
0020 |
1 |
F |
Miscellaneous corrections in EES, ECS services |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0021 |
1 |
F |
Correction in Eees_EECContextRelocation , Eees_EELManagedACR API |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0022 |
1 |
F |
Correction in Eees_UEIdentifier, Eees_ACRManagementEvent API |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0023 |
1 |
F |
Corrections on easId verification in update procedures in EES services |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0027 |
1 |
F |
Correction on user consent procedure description |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0033 |
1 |
F |
Editor’s note resolution for Eees_UEIdentifier |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0034 |
F |
Essential correction to Application Client Information |
17.2.0 |
|
|
2022-12 |
CT#98e |
CP-223170 |
0035 |
F |
Correction on attribute name within EndPoint |
17.2.0 |
|
|
2022-12 |
CT#98e |
CP-223170 |
0036 |
F |
Correction on request URI for Eees_EECContextRelocation_Push |
17.2.0 |
|
|
2022-12 |
CT#98e |
CP-223170 |
0037 |
1 |
F |
Corrections on Location information report |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0039 |
1 |
F |
Corrections on the Notification Destination URI |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0040 |
1 |
F |
Corrections on the Revocation Notification URI |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0041 |
1 |
F |
Missing supported features for Eees_UEIdentifier API |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0042 |
1 |
F |
Corrections for data types of Eees_ACRManagementEvent service |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223170 |
0043 |
F |
Corrections for data types of Eees_SessionWithQoS service |
17.2.0 |
|
|
2022-12 |
CT#98e |
CP-223170 |
0044 |
1 |
F |
Corrections on presence of the attribute in UserInformation data type |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223188 |
0050 |
F |
Update of info and externalDocs fields |
17.2.0 |
|
|
2022-12 |
CT#98e |
CP-223200 |
0024 |
1 |
F |
Correction on eesId verification in update procedure in ECS service |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223200 |
0025 |
1 |
F |
Correction on ACRManagementEvent_Subscribe service operation |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223200 |
0026 |
1 |
F |
Corrections on EES UE location information description |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223198 |
0028 |
F |
Remove duplicated description for EELManagedACR |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223185 |
0029 |
1 |
F |
Adding operationId and tags fields |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223185 |
0030 |
1 |
F |
Eees_ACRManagementEvent and Eees_ACRStatusUpdate APIs: enumeration definitions |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223185 |
0031 |
1 |
F |
Corrections on the description of PUT and PATCH |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223199 |
0038 |
1 |
F |
Corrections on the apiNames |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223185 |
0045 |
1 |
F |
Add the missing description fields of some attributes in the OpenAPI file |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223190 |
0051 |
F |
Update of info and externalDocs fields |
18.0.0 |
|