9 Edge Configuration Server API Definitions
29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS
9.1 Eecs_EESRegistration API
9.1.1 Introduction
The Eecs_EESRegistration service shall use the Eecs_EESRegistration API.
The API URI of the Eecs_EESRegistration API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in clause 7.5.
– The <apiName> shall be "eecs-eesregistration".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 9.1.2.
9.1.2 Resources
9.1.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 9.1.2.1-1 depicts the resource URIs structure for the Eecs_EESRegistration API.
Figure 9.1.2.1-1: Resource URI structure of the Eecs_EESRegistration API
Table 9.1.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 9.1.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
EES Registrations |
/registrations |
POST |
Registers a new EES at the Edge Configuration Server. |
|
Individual EES Registration |
/registrations/{registrationId} |
GET |
Fetch an individual EES registration resource. |
|
PUT |
Fully replace an individual EES registration resource. |
||
|
DELETE |
Remove an individual EES registration resource. |
||
|
PATCH |
Partially update an individual EES registration resource. |
9.1.2.2 Resource: EES Registrations
9.1.2.2.1 Description
This resource represents all the Edge Enabler Servers that are registered at a given Edge Configuration Server.
9.1.2.2.2 Resource Definition
Resource URI: {apiRoot}/eecs-eesregistration/<apiVersion>/registrations
This resource shall support the resource URI variables defined in the table 9.1.2.2.2-1.
Table 9.1.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 7.5 |
9.1.2.2.3 Resource Standard Methods
9.1.2.2.3.1 POST
This method shall support the URI query parameters specified in table 9.1.2.2.3.1-1.
Table 9.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 9.1.2.2.3.1-2 and the response data structures and response codes specified in table 9.1.2.2.3.1-3.
Table 9.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EESRegistration |
M |
1 |
EES registration request information. |
Table 9.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EESRegistration |
M |
1 |
201 Created |
EES information is registered successfully at ECS. EES information registered with ECS is provided in the response body. The URI of the created resource shall be returned in the "Location" HTTP header. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 9.1.2.2.3.1-4: 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}/eecs-eesregistration/<apiVersion>/registrations/{registrationId} |
9.1.2.2.4 Resource Custom Operations
None.
9.1.2.3 Resource: Individual EES Registration
9.1.2.3.1 Description
This Individual EES Registration resource represents an individual EES registered at a given Edge Configuration Server.
9.1.2.3.2 Resource Definition
Resource URI: {apiRoot}/eecs-eesregistration/<apiVersion>/registrations/{registrationId}
This resource shall support the resource URI variables defined in the table 9.1.2.3.2-1.
Table 9.1.2.3.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 7.5 |
|
registrationId |
string |
The EES registration identifier. |
9.1.2.3.3 Resource Standard Methods
9.1.2.3.3.1 GET
This method retrieves the EES information registered at Edge Configuration Server. This method shall support the URI query parameters specified in table 9.1.2.3.3.1-1.
Table 9.1.2.3.3.1-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 9.1.2.3.3.1-2 and the response data structures and response codes specified in table 9.1.2.3.3.1-3.
Table 9.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 9.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EESResgistration |
M |
1 |
200 OK |
The EES registration information at the Edge Configuration Server. |
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 9.1.2.3.3.1-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 ECS. |
Table 9.1.2.3.3.1-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 ECS. |
9.1.2.3.3.2 PUT
This method updates the EES registration information at Edge Configuration Server by completely replacing the existing registration data (except the value of "eesId" within EESProfile data type and the value of "suppFeat" attribute within the EESRegistration data type). This method shall support the URI query parameters specified in the table 9.1.2.3.3.2-1.
Table 9.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 9.1.2.3.3.2-2 and the response data structures and response codes specified in table 9.1.2.3.3.2-3.
Table 9.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EESRegistration |
M |
1 |
Details of the EES registration information to be updated |
Table 9.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EESRegistration |
M |
1 |
200 OK |
The EES registration information updated successfully and the updated EES registration information is returned in the response. |
|
n/a |
204 No Content |
The EES registration information was updated successfully. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
NOTE: The manadatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 9.1.2.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 ECS. |
Table 9.1.2.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 ECS. |
9.1.2.3.3.3 DELETE
This method deregisters an EES registration from the ECS. This method shall support the URI query parameters specified in the table 9.1.2.3.3.3-1.
Table 9.1.2.3.3.3-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 9.1.2.3.3.3-2 and the response data structures and response codes specified in table 9.1.2.3.3.3-3.
Table 9.1.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 9.1.2.3.3.3-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 individual EES registration information matching the registrationId is deleted. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
NOTE: The manadatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 9.1.2.3.3.3-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 ECS. |
Table 9.1.2.3.3.3-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 ECS. |
9.1.2.3.3.4 PATCH
This method partially updates the EES registration information at Edge Configuration Server. This method shall support the URI query parameters specified in the table 9.1.2.3.3.4-1.
Table 9.1.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 9.1.2.3.3.4-2 and the response data structures and response codes specified in table 9.1.2.3.3.4-3.
Table 9.1.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EESRegistrationPatch |
M |
1 |
Details of the EES registration information to be updated |
Table 9.1.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EESRegistration |
M |
1 |
200 OK |
The Individual EES registration information was updated successfully and the updated EES registration information is returned in the response. |
|
n/a |
204 No Content |
The Individual EES registration information was updated successfully. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. |
||
|
NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
Table 9.1.2.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 ECS. |
Table 9.1.2.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 ECS. |
9.1.2.3.4 Resource Custom Operations
None.
9.1.3 Custom Operations without associated resources
None.
9.1.4 Notifications
None.
9.1.5 Data Model
9.1.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API
Table 9.1.5.1-1 specifies the data types defined specifically for the Eecs_EESRegistration API service.
Table 9.1.5.1-1: Eecs_EESRegistration API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
EESRegistration |
9.1.5.2.2 |
The EES registration information on ECS. |
|
|
EESProfile |
9.1.5.2.3 |
The profile information related to the EES in the EESRegistration data type. |
|
|
ACRScenario |
9.1.5.3.3 |
The ACR scenarios supported by EES. |
|
|
EESRegistrationPatch |
9.1.5.2.4 |
To partially update the EES Registration information. |
|
|
ServiceArea |
9.1.5.2.5 |
The topological and geographic areas served by EES. |
|
|
TopologicalServiceArea |
9.1.5.2.6 |
The topological areas served by EES. |
|
|
GeographicalServiceArea |
9.1.5.2.7 |
The geographic areas served by EES. |
Table 9.1.5.1-2 specifies data types re-used by the Eecs_EESRegistration API service.
Table 9.1.5.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
SupportedFeatures |
3GPP TS 29.571 [8] |
Used to negotiate the applicability of optional features defined in table 9.1.7-1. |
|
|
DateTime |
3GPP TS 29.122 [6] |
Used to capture the expiration time of EES registration. |
|
|
Ecgi |
3GPP TS 29.571 [8] |
Represents an EUTRA cell identifier. |
|
|
Ncgi |
3GPP TS 29.571 [8] |
Represents an NR cell identifier. |
|
|
Tai |
3GPP TS 29.571 [8] |
Represents a tracking area identity. |
|
|
GeographicArea |
3GPP TS 29.572 [11] |
Identifies the geographical information of the user(s). |
|
|
CivicAddress |
3GPP TS 29.572 [11] |
Identifies the civic address information of the user(s). |
|
|
PlmnId |
3GPP TS 29.122 [6] |
Used to indicate only the list of PLMN Ids as part of topological service areas. |
|
|
Dnai |
3GPP TS 29.571 [8] |
Used to represent the list of DNAI(s) information associated with EES. |
|
|
DateTimeRm |
3GPP TS 29.571 [8] |
Used to capture the expiration time EES registration patch. |
|
|
EndPoint |
8.1.5.2.5 |
The end point information of the Edge Enabler Server in the EES profile. |
9.1.5.2 Structured data types
9.1.5.2.1 Introduction
9.1.5.2.2 Type: EESRegistration
Table 9.1.5.2.2-1: Definition of type EESRegistration
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eesProf |
EESProfile |
M |
1 |
The profile information of the EES. |
|
|
expTime |
DateTime |
O |
0..1 |
Identifies the expiration time for the EES registration. If the expiration time is not present, then it indicates that the registration of EES never expires. |
|
|
suppFeat |
SupportedFeatures |
O |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 7.8. This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. |
9.1.5.2.3 Type: EESProfile
Table 9.1.5.2.3-1: Definition of type EESProfile
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eesId |
string |
M |
1 |
The identifier of the EES |
|
|
endPt |
EndPoint |
M |
1 |
Endpoint information (e.g. URI, FQDN, IP address) used to communicate with the EES. This information is provided to the EEC to connect to the EES. |
|
|
easIds |
array(string) |
O |
1..N |
The application identities of the Edge Application Servers, e.g. URI, FQDN, registered with the EES. |
|
|
provId |
string |
O |
0..1 |
Identifier of the ECSP that provides the EES provider. |
|
|
svcArea |
ServiceArea |
O |
0..1 |
The list of geographical and topological areas that the EES serves. EECs in the UE that are outside the area shall not be served. |
|
|
appLocs |
array(Dnai) |
O |
1..N |
List of DNAI(s) associated with the EES. This is a list of potential locations of the applications. It is a subset of the DNAI(s) associated with the EDN, where the EES resides. |
|
|
svcContSupp |
array(ACRScenario) |
O |
1..N |
The ACR scenarios supported by the EES for service continuity. If this attribute is not present, then the EES does not support service continuity. |
|
|
eecRegConf |
boolean |
M |
1 |
Set to TRUE if the EEC is required to register on the EES to use edge services. Set to FALSE if EEC is not required to register on the EES to use edge services. |
9.1.5.2.4 Type: EESRegistrationPatch
Table 9.1.5.2.4-1: Definition of type EESRegistrationPatch
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eesProf |
EESProfile |
O |
0..1 |
The profile information of the EES. |
|
|
expTime |
DateTimeRm |
O |
0..1 |
Identifies the expiration time for the EES registration. If the expiration time is not present, then it indicates that the registration of EES never expires. |
|
|
NOTE: The value of the "eesId" attribute within the EESProfile data type shall be the same as the one within the EES Registration data type during the creation of resource procedure. |
|||||
9.1.5.2.5 Type: ServiceArea
Table 9.1.5.2.5-1: Definition of type ServiceArea
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
topServAr |
TopologicalServiceArea |
O |
0..1 |
The topological service areas. (NOTE) |
|
|
geoServAr |
GeographicalServiceArea |
O |
0..1 |
The geographical service areas. |
|
|
NOTE: The "topServAr" attribute is not applicable for untrusted functional elements (EESs and/or EASs deployed outside the MNO trust domain). |
|||||
9.1.5.2.6 Type: TopologicalServiceArea
Table 9.1.5.2.6-1: Definition of type TopologicalServiceArea
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
ecgis |
array(Ecgi) |
O |
1..N |
This IE contains a list of E‑UTRA cell identities. |
|
|
ncgis |
array(Ncgi) |
O |
1..N |
This IE contains a list of NR cell identities. |
|
|
tais |
array(Tai) |
O |
1..N |
This IE contains a list of tracking area identities. |
|
|
plmnIds |
array(PlmnId) |
O |
1..N |
List of PLMN IDs. (NOTE) |
|
|
NOTE: A combination of these information elements should not have duplicate or overlapping information for the same topological Service Area. |
|||||
9.1.5.2.7 Type: GeographicalServiceArea
Table 9.1.5.2.7-1: Definition of type GeographicalServiceArea
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
geoArs |
array(GeographicArea) |
O |
1..N |
Identifies a list of geographic area of the user where the UE is located. |
|
|
civicAddrs |
array(CivicAddress) |
O |
1..N |
Identifies a list of civic addresses of the user where the UE is located. |
9.1.5.3 Simple data types and enumerations
9.1.5.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
9.1.5.3.2 Simple data types
The simple data types defined in table 9.1.5.3.2-1 shall be supported.
Table 9.1.5.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
9.1.5.3.3 Enumeration: ACRScenario
The enumeration ACRScenario represents the ACR scenarios supported. It shall comply with the provisions defined in table 9.1.5.3.3-1.
Table 9.1.5.3.3-1: Enumeration ACRScenario
|
Enumeration value |
Description |
Applicability |
|
EEC_INITIATED |
Represents the EEC initiated ACR scenario. |
|
|
EEC_EXECUTED_VIA_SOURCE_EES |
Represents the EEC ACR scenario executed via the S-EES. |
|
|
EEC_EXECUTED_VIA_TARGET_EES |
Represents the EEC ACR scenario executed via the T-EES. |
|
|
SOURCE_EAS_DECIDED |
Represents the EEC ACR scenario where the S-EAS decides to perform ACR. |
|
|
SOURCE_EES_EXECUTED |
Represents the EEC ACR scenario where S-EES executes the ACR. |
|
|
EEL_MANAGED_ACR |
Represents the EEC ACR scenario where the ACR is managed by the Edge Enabler Layer. |
9.1.6 Error Handling
General error responses are defined in clause 7.7.
9.1.7 Feature negotiation
General feature negotiation procedures are defined in clause 7.8 Table 9.1.7-1 lists the supported features for Eecs_EESRegistration API.
Table 9.1.7-1: Supported Features
|
Feature number |
Feature Name |
Description |
9.2 Eecs_TargetEESDiscovery API
9.2.1 Introduction
The Eecs_TargetEESDiscovery service shall use the Eecs_TargetEESDiscovery API.
The API URI of the Eecs_TargetEESDiscovery API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in clause 7.5.
– The <apiName> shall be "eecs-targeteesdiscovery".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 9.2.2.
9.2.2 Resources
9.2.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 9.2.2.1-1 depicts the resource URIs structure for the Eecs_TargetEESDiscovery API.
Figure 9.2.2.1-1: Resource URI structure of the Eecs_TargetEESDiscovery API
Table 9.2.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 9.2.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
EES Profiles |
/ees-profiles |
GET |
Retrieve the T-EES information. |
9.2.2.2 Resource: EES Profiles
9.2.2.2.1 Description
This resource allows the source EES (S-EES) to retrieve the target (T-EES) information from the ECS.
9.2.2.2.2 Resource Definition
Resource URI: {apiRoot}/eecs-targeteesdiscovery/<apiVersion>/ees-profiles
This resource shall support the resource URI variables defined in the table 9.2.2.2.2-1.
Table 9.2.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 7.5 |
9.2.2.2.3 Resource Standard Methods
9.2.2.2.3.1 GET
This method allows the S-EES to fetch the T-EES information as specified in 3GPP TS 23.558 [2], from the ECS with a given discovery filters. This method shall support the URI query parameters specified in table 9.2.2.2.3.1-1.
Table 9.2.2.2.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
ees-id |
string |
M |
1 |
Unique identifier of the S-EES. |
|
eas-id |
string |
M |
1 |
Represents the application identifier of the S-EAS, e.g. URI, FQDN. |
|
target-dnai |
Dnai |
O |
0..1 |
The DNAI information associated with the potential T-EES(s) and/or T-EAS(s). |
|
ue-id |
Gpsi |
O |
0..1 |
Identifier of the UE. |
|
ue-location |
LocationArea5G |
O |
0..1 |
The location information of the UE. |
This method shall support the request data structures specified in table 9.2.2.2.3.1-2 and the response data structures and response codes specified in table 9.2.2.2.3.1-3.
Table 9.2.2.2.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 9.2.2.2.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ECSServProvResp |
M |
1 |
200 OK |
The EDN configuration and the T-EES information determined by the ECS based on the query parameters. |
|
NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
9.2.2.2.4 Resource Custom Operations
None.
9.2.3 Custom Operations without associated resources
None.
9.2.4 Notifications
None.
9.2.5 Data Model
9.2.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API.
Table 9.2.5.1-1 specifies the data types defined specifically for the Eecs_TargetEESDiscovery API.
Table 9.2.5.1-1: Eecs_TargetEESDiscovery API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
Table 9.2.5.1-2 specifies data types re-used by the Eecs_TargetEESDiscovery API service.
Table 9.2.5.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
Dnai |
3GPP TS 29.571 [8] |
Used to indicate the target DNAI information. |
|
|
Gpsi |
3GPP TS 29.571 [8] |
Used to identify the UE in the query parameter. |
|
|
LocationArea5G |
3GPP TS 29.122 [6] |
Used to indicate the location information of the UE in the query parameter. |
|
|
ECSServProvResp |
3GPP TS 24.558 [14] |
The response to the target EES discovery request, which includes the EDN configuration along with list of EES(s) information. |
9.2.5.2 Structured data types
None.
9.2.5.3 Simple data types and enumerations
None.
9.2.6 Error Handling
General error responses are defined in clause 7.7.
9.2.7 Feature negotiation
General feature negotiation procedures are defined in clause 7.8. Table 9.2.7-1 lists the supported features for Eecs_TargetEESDiscovery API.
Table 9.2.7-1: Supported Features
|
Feature number |
Feature Name |
Description |