EEC Registrations

/registrations

POST

Create a new EEC registration at the EES

Individual EEC registration

/registrations/{registrationId}

PUT

Update an existing EEC registration a the EES

DELETE

Remove an existing ECC registration at EES

PATCH

Partially update an existing EEC registration a the EES

apiRoot

string

See clause 6.1

n/a

EECRegistration

M

1

EEC registration request information

EECRegistration

M

1

201 Created

EEC information is registered successfully at EES. EEC information registered with EES is provided in the response body.

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.6-1 of 3GPP TS 29.122 [3] also apply.

n/a

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-eecregistration/<apiVersion>/registrations/{registrationId}

apiRoot

string

See clause 6.1

registrationId

string

The Identifier of a specific EEC registration.

n/a

EECRegistration

M

1

An Individual registration resource to be updated.

EECRegistration

M

1

200 OK

An individual EEC registration resource updated successfully and the EECRegistration data shall be included in the response.

n/a

204 No Content

An individual EEC registration resource updated successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

n/a

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

n/a

n/a

n/a

204 No Content

An individual EEC registration resource deleted successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

n/a

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

n/a

EECRegistrationPatch

M

1

An Individual registration resource to be updated.

EECRegistration

M

1

200 OK

An individual EEC registration resource updated successfully and the EECRegistration data shall be included in the response.

n/a

204 No Content

An individual EEC registration resource updated successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

NOTE: The manadatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

n/a

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

EECRegistration

6.2.5.2.2

Describes the parameters to perform EEC Registration related operations

acProfile

6.2.5.2.3

Describes information about AC used to determine services and service characteristics required

EASDetail

6.2.5.2.4

Describes EAS along with service KPIs that serves the AC

acServiceKPIs

6.2.5.2.5

Describes the KPIs required by the AC in order to receive required services

BitRate

3GPP TS 29.571 [5]

DateTime

3GPP TS 29.122 [3]

EndPoint

3GPP TS 29.558 [4]

ScheduledCommunicationTime

3GPP TS 29.122 [3]

LocationArea5G

3GPP TS 29.122 [3]

Uinteger

3GPP TS 29.571 [5]

DurationSec

3GPP TS 29.122 [3]

SupportedFeatures

3GPP TS 29.571 [5]

Gpsi

3GPP TS 29.571 [5]

ACRScenario

3GPP TS 29.558 [4]

eecId

string

M

0..1

Represents a unique identifier of the EEC.

ueId

Gpsi

O

0..1

Represents the identifier of the UE.

acProfs

array(ACProfile)

O

1..N

Profiles of ACs for which the EEC provides edge enabling services.

eecSvcContSupp

array(ACRScenario)

O

0..1

The ACR scenarios supported by the EEC for service continuity. If this attribute is not present, then the EEC does not support service continuity.

expTime

DateTime

O

0..1

Represents an expiration time for the registration.

This attribute shall be present in the response of the HTTP POST message from EEC to create a new registration or in the response of the HTTP PUT message from EEC to update a specific registration.

If abesent, then it indicates that the registration of EEC never expires.

eecCntxId

string

O

0..1

Identifier of the EEC context obtained from a previous registration.

srcEesId

string

O

0..1

Identifier of the EES that provided EEC context ID.

srcEesEndpoint

EndPoint

O

0..1

The endpoint address of the EES that provided EEC context ID.

unfulfilledAcProfs

array(UnfulfilledAcProfile)

O

1..N

Represents the list of ACIDs of the AC Profile(s) sent from EES, for which the requirements indicated in the AC profile(s) cannot be fulfilled as shared in reason

acId

string

M

1

Identity of the AC.

acType

string

O

0..1

The category or type of AC.

prefEcsps

array(string)

O

1..N

Indicates to the ECS which ECSPs are preferred for the AC. The ECS may use this information in the selection of EESs.

acSchedule

ScheduledCommunicationTime

O

0..1

Indicates the expected operation schedule of the AC (e.g. time windows)

expAcGeoServArea

LocationArea5G

O

0..1

Indicates the expected location(s) (e.g. route) of the hosting UE during the AC’s operation schedule.

acSvcContSupp

array(ACRScenario)

O

0..1

Indicates if service continuity support is required or not for the application.

The ACR scenarios supported by the AC for service continuity. If this attribute is not present, then the AC does not support service continuity.

eass

Array(EasDetail)

O

1..N

Provides the list of EAS that serve the AC along with the service KPIs required by the AC

easId

string

M

1

The application identifier of the EAS, e.g. FQDN, URI.

expectedSvcKPIs

ACServiceKPIs

O

0..1

Describes the KPIs expected in order for ACs to receive currently required services from the EAS

minimumReqSvcKPIs

ACServiceKPIs

O

0..1

Describes the minimum KPIs required in order for ACs to receive meaningful services from the EAS

connBand

BitRate

O

0..1

The required connection bandwidth in Kbit/s for the application.

reqRate

Uinteger

O

0..1

The request rate to be generated by the AC.

respTime

DurationSec

O

0..1

Response time required for the server servicing the requests.

avail

Uinteger

O

0..1

Percentage of time the server is required to be available for the AC’s use.

reqComp

string

O

0..1

The compute resources required by the AC.

reqGrapComp

string

O

0..1

The graphical compute resources required by the AC.

reqMem

string

O

0..1

The memory resources required by the AC.

reqStrg

string

O

0..1

The storage resources required by the AC.

acProfs

array(ACProfile)

O

1..N

Profiles of ACs for which the EEC provides edge enabling services.

expTime

DateTime

O

0..1

Represents an expiration time for the registration.

unfulfilledAcProfs

array(UnfulfilledAcProfile)

O

1..N

Represents the list of ACIDs of the AC Profile(s) sent from EES, for which the requirements indicated in the AC profile(s) cannot be fulfilled as shared in reason

acId

string

M

0..1

The list of identifier of the AC profile

reason

UnfulfillACProfRsn

O

0..1

Reason indicating the cause (e.g. EAS not available, requirements cannot be fulfilled)

EAS_NOT_AVAILABLE

EAS not available

REQ_UNFULFILLED

Requirements cannot be fulfilled

RESOURCE_NOT_FOUND

404 Not Found

Indicates that the requirements included in the EEC registration request e.g., the AC Profile(s) cannot be fulfilled.

EAS Discovery Subscriptions

/subscriptions

POST

Creates a new individual EAS discovery subscription.

Individual EAS Discovery Subscription

/subscriptions/{subscriptionId}

PUT

Updates an existing individual EAS discovery subscription identified by the subscriptionId.

DELETE

Deletes an existing individual EAS discovery subscription identified by the subscriptionId.

PATCH

Partial update an existing EAS Discovery Subscription resource identified by a subscriptionId.

EAS Profiles

/eas-profiles/request-discovery

request-discovery (POST)

Request EAS discovery.

apiRoot

string

See clause 6.1.

n/a

EASDiscoverySubscription

M

1

Create an Individual EAS Discovery Subscription resource.

EASDiscoverySubscription

M

1

201 Created

Successful case. An Individual EAS Discovery Subscription resource was successfully created and a representation of the created resource is returned in the response body.

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

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

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-easdiscovery/<apiVersion>/subscriptions/{subscriptionId}

apiRoot

string

See clause 6.1.

subscriptionId

string

The identifier of the individual EAS discovery subscription.

n/a

EASDiscoverySubscription

M

1

An individual EAS discovery subscription resource to be updated.

EASDiscoverySubscription

M

1

200 OK

The Individual EAS Discovery Subscription resource was successfully updated and a representation of the updated resource is returned in the response body.

n/a

204 No Content

The Individual EAS Discovery Subscription resource was successfully updated and no content is returned in the response body.

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Location

string

M

1

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

Location

string

M

1

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

n/a

n/a

n/a

204 No Content

The targeted Individual EAS Discovery Subscription resource was successfully 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 EES.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Location

string

M

1

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

Location

string

M

1

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

n/a

EasDiscoverySubscriptionPatch

M

1

Contains the parameters to request the modification of an existing Individual EAS Discovery Subscription resource.

EasDiscoverySubscription

M

1

200 OK

The Individual EAS Discovery Subscription resource was successfully modified and a representation of the modified resource is returned in the response body.

n/a

204 No Content

The Individual EAS Discovery Subscription resource was successfully modified and no content is returned in the response body.

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

Location

string

M

1

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

Location

string

M

1

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

apiRoot

string

See clause 6.1

Request-Discovery

eees-easdiscovery/<apiVersion>/eas-profile /request-discovery

POST

Request EAS discovery information

EASDiscoveryReq

M

1

Contains the necessary information to request EAS discovery.

EASDiscoveryResp

M

1

200 OK

The requested EAS discovery information was successfully returned.

n/a

204 No Content

The processing of the request is successful but no matching EAS was found.

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

EAS Discovery Notification

{notificationDestination}

POST

Notifies a subscribed EEC about EAS discovery information..

notificationDestination

String formatted as URI with the Callback Uri.

EasDiscoveryNotification

M

1

Notification of EAS discovery information.

n/a

204 No Content

The receipt of the Notification is acknowledged.

n/a

307 Temporary Redirect

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

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

n/a

308 Permanent Redirect

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

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

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

Location

string

M

1

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

Location

string

M

1

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

EasDiscoveryReq

6.3.5.2.2

EasDiscoveryResp

6.3.5.2.3

EasDiscoverySubscription

6.3.5.2.4

EasDiscoveryNotification

6.3.5.2.5

EasDiscoveryFilter

6.3.5.2.6

EasCharacteristics

6.3.5.2.7

DiscoveredEas

6.3.5.2.8

EasDynamicInfoFilter

6.3.5.2.9

TimeWindow

3GPP TS 29.122 [3]

DurationSec

3GPP TS 29.122 [3]

LocationArea5G

3GPP TS 29.122 [3]

ACProfile

clause 6.2.5.2.3

LocationInfo

3GPP TS 29.122 [3]

EndPoint

3GPP TS 29.558 [4]

EASProfile

3GPP TS 29.558 [4]

Dnai

3GPP TS 29.571 [5]

RouteToLocation

3GPP TS 29.571 [5]

Gpsi

3GPP TS 29.571 [5]

Used to identify a UE.

Uri

3GPP TS 29.122 [3]

requestorId

RequestorId

M

1

Represents a unique identifier of the requestor (e.g. EEC, EAS, EES).

ueId

string

O

0..1

Represents the identifier of the UE.

easDiscoveryFilter

EasDiscoveryFilter

O

0..1

Contains EAS characteristics

eecSvcContinuity

string

O

0..1

Contains service continuity support; indicates EEC supported ACR scenarios

eesSvcContinuity

String

O

0..1

Contains service continuity support; indicates EES supported ACR scenarios

easSvcContinuity

string

O

0..1

Contains service continuity support; indicates EAS supported ACR scenarios

locInf

LocationInfo

O

0..1

Represents location information of the UE.

easTDnais

array(Dnai)

O

1..N

Contains the target DNAI information which can be associated with potential target-EAS(s)

discoveredEas

array(DiscoveredEas)

M

1..N

List of EAS discovery information

eecId

string

M

1

Represents a unique identifier of the EEC.

ueId

Gpsi

O

0..1

Represents the identifier of the UE.

easEventType

EASDiscEventIDs

M

1

Event type for which the EEC should be notified;

easDiscoveryFilter

EasDiscoveryFilter

O

0..1

EAS characteristics filter; Applicable when easEventType is set to "EAS_AVAILABILITY_CHANGE" event

easDynInfoFilter

EasDynamicInfoFilter

O

0..1

EAS dynamic information changes filter; Applicable when easEventType is set to "EAS_DYNAMIC_INFO_CHANGE" event

eecSvcContinuity

array(ACRScenario)

O

0..1

Service continuity support; indicates EEC supported ACR scenarios

notificationDestination

Uri

M

1

URI where the EAS discovery notification should be delivered to. This attribute shall be present in HTTP POST message to EES.

expTime

DateTime

O

0..1

Expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the EES to send a test notification as defined in clause 6.1. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6.

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

Represents a list of Supported features used as described in clause 6.3.7.

Shall be present in the HTTP POST request/response;

subId

string

M

1

String identifying the individual subscription for which the service provisioning notification is delivered.

eventType

EASDiscEventIDs

M

1

Event type for which the notification is delivered;

discoveredEas

array(DiscoveredEas)

M

1..N

List of EAS discovery information

acChars

array(ACCharacteristics)

O

1..N

AC description for which an EAS is needed

easChars

array(EasCharacteristics)

O

1..N

Required EAS characteristics

NOTE 1: Either acChars or easChars shall be present.

NOTE 2: prefEcsps from the ACProfile shall not be present.

easId

string

O

0..1

The application identifier of the EAS, e.g. FQDN, URI.

easProvId

string

O

0..1

EAS provider identifier

easType

string

O

0..1

EAS type

easSched

TimeWindow

O

0..1

EAS availability schedule

svcArea

LocationArea5G

O

0..1

Service availability area (geographical and topological)

easSvcContinuity

array(ACRScenario)

O

0..1

The ACR scenarios required by the EAS for service continuity. If this attribute is not present, then the EAS does not require to support service continuity.

svcPermLevel

string

O

0..1

Service permissions level

svcFeats

array(string)

O

1..N

Service features

NOTE: Must include at least one optional IE

eas

EASProfile

M

1

Contains an EAS matching the discovery request filters

lifeTime

DateTime

O

0..1

Indicates the time duration for which the EAS information is valid and supposed to be cached in the EEC.

dynInfoFilter

array(EasDynamicInfoFilterData)

M

1

List of EAS dynamic information required by the EEC per EAS

easId

string

M

1

The application identifier of the EAS, e.g. FQDN, URI.

easStatus

boolean

O

0..1

Notify if EAS status changed

easAcIds

boolean

O

0..1

Notify if list of AC identifiers changed

easDesc

boolean

O

0..1

Notify if EAS description changed

easPt

boolean

O

0..1

Notify if EAS endpoint changed

easFeature

boolean

O

0..1

Notify if EAS feature changed

easSchedule

boolean

O

0..1

Notify if EAS schedule changed

svcArea

boolean

O

0..1

Notify if EAS service area changed

svcKpi

boolean

O

0..1

Notify if EAS KPIs changed

svcCont

boolean

O

0..1

Notify if EAS supported ACR changed

acProf

ACProfile

M

1

Profiles of ACs for which the EEC provides edge enabling services.

easDiscoveryFilter

EasDiscoveryFilter

O

0..1

EAS characteristics filter; Applicable when easEventType is set to "EAS_AVAILABILITY_CHANGE" event

easDynInfoFilter

EasDynamicInfoFilter

O

0..1

EAS dynamic information changes filter; Applicable when easEventType is set to "EAS_DYNAMIC_INFO_CHANGE" event

eecSvcContinuity

array(ACRScenario)

O

0..1

Service continuity support; indicates EEC supported ACR scenarios

expTime

DateTime

O

0..1

Expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

easEventType

EASDiscEventIDs

O

0..1

Event type for which the EEC should be notified;

EesId

string

C

0..1

The identifier of the EES (e.g. S-EES).

EasId

string

C

0..1

The application identifier of the EAS (e.g. S-EAS), e.g. FQDN, URI.

eecId

string

C

0..1

The identifier of the EEC.

NOTE: Either the "eecId" attribute, the "EesId" attribute or the "EasId" attribute shall be provided, they are mutually exclusive.

EAS_AVAILABILITY_CHANGE

Represents the EAS availability change event

EAS_DYNAMIC_INFO_CHANGE

Represents the EAS dynamic information change event

REGISTRATION_REQUIRED

403 Forbidden

Indicates that the registration is required for the EEC to perform the operation.

1

Notification_test_event

Testing of notification connection is supported according to clause 6.1.

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 6.1. This feature requires that the Notification_test_event feature is also supported.

ACR events subscriptions

/subscriptions

POST

Creates a new individual ACR events subscription.

Individual ACR events subscription

/subscriptions/{subscriptionId}

PUT

Updates an existing individual ACR events subscription identified by the subscriptionId.

DELETE

Deletes an existing individual ACR events subscription identified by the subscriptionId.

PATCH

Partially updates an existing individual ACR events subscription identified by the subscriptionId.

apiRoot

string

See clause 6.4.1.

n/a

ACREventsSubscription

M

1

Create an Individual ACR events subscription resource.

ACREventsSubscription

M

1

201 Created

Individual ACR events subscription resource 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.6-1 of 3GPP TS 29.122 [3] also apply.

n/a

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-acrevents/<apiVersion>/subscriptions/{subscriptionId}

apiRoot

string

See clause 6.4.1.

subscriptionId

string

The identifier of a specific individual ACR events subscription.

n/a

ACREventsSubscription

M

1

An individual ACR events subscription resource to be updated.

ACREventsSubscription

M

1

200 OK

An individual ACR events subscription resource updated successfully and the ACREventsSubscription data shall be included in the response.

n/a

204 No Content

An individual ACE events subscription resource updated successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

n/a

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

n/a

n/a

n/a

204 No Content

An individual individual ACR events subscription resource deleted successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

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

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

n/a

ACREventsSubscriptionPatch

M

1

An individual ACR events subscription resource to be updated.

ACREventsSubscription

M

1

200 OK

An individual ACR events subscription resource updated successfully and the ACREventsSubscription data shall be included in the response.

n/a

204 No Content

An individual ACE events subscription resource updated successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3] with the difference that the SCEF is replaced by the EES and the SCS/AS is replaced by the EEC.

NOTE: The manadatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

n/a

n/a

n/a

Location

string

M

1

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

Location

string

M

1

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

ACR Information Notification

{notificationDestination}

POST

Notifies EEC for the ACR information notification.

n/a

ACRInfoNotification

M

1

Notification of ACR information.

n/a

204 No Content

The receipt of the Notification is acknowledged.

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

ACREventsSubscription

6.4.5.2.2

ACRInfoNotification

6.4.5.2.3

ACREventIDs

6.4.5.3.3

DateTime

3GPP TS 29.122 [3]

Uri

3GPP TS 29.122 [3]

WebsockNotifConfig

3GPP TS 29.122 [3]

SupportedFeatures

3GPP TS 29.571 [5]

EDNConfigInfo

Clause 8.1.5.2.7

DiscoveredEas

Clause 6.3.5.2.8

ImplicitRegDetail

3GPP TS 29.558 [4]

eecId

string

M

0..1

Represents a unique identifier of the EEC.

ueId

Gpsi

O

0..1

Represents the identifier of the UE.

expTime

DateTime

O

0..1

Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

easIds

array(string)

M

1..N

The list of application identifiers of the EASs, e.g. FQDN, URI.

acIds

array(string)

O

1..N

The list of identifier of the AC(s) (NOTE)

eventIds

ACREventIDs

M

1

Specifies the events for which EEC is subscribing.

notificationDestination

Uri

M

1

URI where the ACR Information Notification should be delivered to.

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the ECS to send a test notification as defined in clause 7.6 of 3GPP TS 29.558 [4]. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6 of 3GPP TS 29.558 [4].

Notification_websocket

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 7.8 of 3GPP TS 29.558 [4].

This attribute shall be provided in the HTTP POST request and in the response of successful resource creation.

NOTE: If acIds attribute is not included, it implies that the subscription corresponds to all ACs that can be served by the EAS(s) included this message.

subId

string

M

1

String identifying the Individual ACR events subscription for which the ACT Information notification is delivered.

easId

string

M

1

The application identifier of the EAS, e.g. FQDN, URI.

eventId

ACREventIDs

M

1

Specifies the events for which notification is sent

acId

string

O

0..1

Contains the identifier of the AC.

trgtInfo (NOTE 1)

TargetInfo

O

0..1

Details of the selected T-EAS and the T-EES.

acrStatus

ACRCompleteEventInfo

C

0..1

Details of a completed ACR and its result.

This attribute shall be included when Event ID indicates ‘ACR_COMPLETE’ event

eecCtxtReloc (NOTE 3)

EecCtxtRelocStatus

O

0..1

Specifies the registration id and expiry time of the registration.

NOTE 1: This attribute shall be included when Event ID indicates ‘TARGET_INFORMATION’ event

NOTE 2: This attribute shall be included when the ACRRes attribute indicates failure.

NOTE 3: This attribute shall be included when eventId indicates ‘ACR_COMPLETE’ event and EEC context relocation was attempted.

trgetEASInfo

DiscoveredEas

M

1

EAS discovery information.

trgetEESInfo

EDNConfigInfo

O

0..1

Provides EDN configuration information. This attribute shall be included only if the selected T-EES is different from the S-EES.

expTime

DateTime

O

0..1

Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

easIds

array(string)

O

1..N

The list of application identifiers of the EASs, e.g. FQDN, URI.

eventIds

ACREventIDs

O

0..1

Specifies the events for which EEC is subscribing.

notificationDestination

Uri

O

0..1

URI where the ACR Information Notification should be delivered to. This attribute shall be present in HTTP POST message to EES.

implReg

ImplicitRegDetails

O

0..1

Provides implicit registration details

(NOTE)

NOTE 1: This attribute shall be included when the S-EES has received it in EEC Context Push response.

acrRes

boolean

M

1

Indicates whether the ACR is successful or failure

tEasEndpoint

EndPoint

M

1

Contains the endpoint address of the T-EAS to which an ACR has been performed.

failReason

string

C

0..1

Indicates the cause information for the failure

This attribute shall be included when the acrRes attribute indicates failure

TARGET_INFORMATION

ACR_COMPLETE

Determine

/determine

POST

EES or EAS determines if ACR is needed and may initiate the procedure

Initiate

/initiate

POST

EES initiates the requested ACR procedure

Declare

/declare

POST

EAS declares the selected target EAS and the associated information.

AcrDeterReq

M

1

Information about the requestor and requested ACR operation

n/a

204 No Content

Successful case. The ACR request is successfully received and processed.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

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

Location

string

M

1

An alternative target URI located in an alternative EES.

Location

string

M

1

An alternative target URI located in an alternative EES.

AcrInitReq

M

1

Information about the requestor and requested ACR operation

n/a

204 No Content

Successful case. The ACR request is successfully received and processed.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

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

Location

string

M

1

An alternative target URI located in an alternative EES.

Location

string

M

1

An alternative target URI located in an alternative EES.

AcrDecReq

M

1

Contains the selected target EAS information.

n/a

204 No Content

Successful case. The selected target EAS information is successfully received.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.

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

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

Location

string

M

1

An alternative target URI located in an alternative EES.

Location

string

M

1

An alternative target URI located in an alternative EES.

AcrDecReq

6.5.5.2.4

AcrDetermReq

6.5.5.2.2

AcrInitReq

6.5.5.2.3

EecCtxtReloc

6.5.5.2.5

RouteToLocation

3GPP TS 29.571 [5]

Represent the N6 traffic routing information and/or routing profile ID for a DNAI.

EndPoint

3GPP TS 29.558 [4]

Represents the endpoint information of an EAS.

Gpsi

3GPP TS 29.571 [5]

Represents a GPSI.

requestorId

string

M

1

Contains the identifier of the EEC or the EAS that is sending the request.

easId

string

O

0..1

Contains the application identifier of the EAS, e.g. FQDN, URI..

sEasEndpoint

EndPoint

M

1

Contains the endpoint information of the selected S-EAS.

ueId

Gpsi

M

1

Contains the identifier of the concerned UE.

acId

string

O

0..1

Contains the identifier of the AC.

requestorId

string

M

1

Contains the identifier of the EEC that is sending the request.

easId

string

O

0..1

Contains the application identifier of the EAS, e.g. FQDN, URI.

ueId

Gpsi

M

1

Contains the identifier of the concerned UE.

acId

string

O

0..1

Contains the identifier of the AC.

tEasEndpoint

EndPoint

M

1

Contains the endpoint information of the T-EAS.

sEasEndpoint

EndPoint

C

0..1

Contains the endpoint information of the S-EAS.

This attribute shall be provided when the "easNotifInd" attribute is set to "true" or when the "prevEasNotifInd" attribute is present and set to "true".

prevTEasEndpoint

EndPoint

C

0..1

Contains the endpoint information of the previous T-EAS.

This attribute shall be provided when the EEC re-sends the ACR request to indicate that a previous ACR is to be cancelled.

routeReq

RouteToLocation

O

0..1

Contains the T-EAS’s DNAI information and the corresponding N6 traffic routing information and/or routing profile ID.

easNotifInd

boolean

M

1

Indicates whether the EAS should be notified about the need for ACR or ACR cancellation.

"true": Notification required.

"false" (default): Notification not required.

prevEasNotifInd

boolean

C

0..1

Indicates whether the EAS should be notified about ACR cancellation.

"true": Notification required.

"false" (default): Notification not required.

This attribute shall be provided when the EEC re-sends the ACR request to indicate that a previous ACR is to be cancelled.

eecCtxtReloc

EecCtxtReloc

O

0..1

Contains EEC context relocation information.

requestorId

string

M

1

Contains the identifier of the EAS that is sending the request.

ueId

Gpsi

M

1

Contains the identifier of the concerned UE.

acId

string

O

0..1

Contains the identifier of the AC.

tEasId

string

M

1

Contains the application identifier of the selected target EAS, e.g. FQDN, URI.

tEasEndpoint

EndPoint

M

1

Contains the endpoint information of the selected target EAS.

eecCtxtId

string

M

1

Contains the identifier of the concerned EEC context.

sEesId

string

O

0..1

Contains the identifier of the S-EES.

This attribute may be provided only if the ACR request is from the EEC to the T-EES.

sEesEndpoint

EndPoint

O

0..1

Contains the endpoint information of the selected S-EES.

This attribute may be provided only if the ACR request is from the EEC to the T-EES.

tEesId

string

O

0..1

Contains the identifier of the T-EES.

This attribute may be provided only if the ACR request is from the EEC to the S-EES.

tEesEndpoint

EndPoint

O

0..1

Contains the endpoint information of the selected T-EES.

This attribute may be provided only if the ACR request is from the EEC to the S-EES.