ACR Management Events Subscriptions

/subscriptions

GET

Query all the subscriptions.

POST

Create a new Individual ACR Management Events Subscription resource.

Individual ACR Management Events Subscription

/subscriptions/{subscriptionId}

GET

Query an existing Individual ACR Management Events Subscription resource identified by a subscriptionId.

PUT

Fully replace an existing Individual ACR Management Events Subscription resource identified by a subscriptionId.

PATCH

Partially update an existing Individual ACR Management Events Subscription resource identified by a subscriptionId.

DELETE

Remove an Individual ACR Management Events Subscription resource identified by a subscriptionId.

apiRoot

string

See clause 7.5

n/a

AcrMgntEventsSubscription

M

1

Parameters to create a subscription for notifications of ACR management events.

AcrMgntEventsSubscription

M

1

201 Created

An Individual ACR Management Events Subscription resource is successfully created, and the subscription information 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.

Location

string

M

1

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

supp-feat

SupportedFeatures

O

0..1

The features supported by the EAS.

n/a

array(AcrMgntEventsSubscription)

M

1..N

200 OK

All the ACR Management Events Subscriptions information is returned by the EES.

n/a

307 Temporary Redirect

Temporary redirection, during subscription retrieval. 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 [6].

n/a

308 Permanent Redirect

Permanent redirection, during subscription retrieval. 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 [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.

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

subscriptionId

string

Contains the identifier of an ACR Management Events Subscription.

n/a

AcrMgntEventsSubscriptionPatch

M

1

Request to partially update an existing Individual ACR Management Events Subscription.

AcrMgntEventsSubscription

M

1

200 OK

The Individual ACR Management Events Subscription is successfully modified and the updated subscription information is returned in the response.

n/a

204 No Content

The Individual ACR Management Events Subscription is successfully modified.

n/a

307 Temporary Redirect

Temporary redirection, during subscription 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 [6].

n/a

308 Permanent Redirect

Permanent redirection, during subscription 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 [6].

NOTE: The manadatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] 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

AcrMgntEventsSubscription

M

1

Parameters to replace an existing Individual ACR Management Events Subscription.

AcrMgntEventsSubscription

M

1

200 OK

The existing Individual ACR Management Events Subscription is successfully replaced and the updated subscription information is returned in the response.

n/a

204 No Content

The existing Individual ACR Management Events Subscription is successfully modified.

n/a

307 Temporary Redirect

Temporary redirection, during subscription 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 [6].

n/a

308 Permanent Redirect

Permanent redirection, during subscription 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 [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.

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 existing Individual ACR Management Events Subscription is successfully deleted.

n/a

307 Temporary Redirect

Temporary redirection, during subscription 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 [6].

n/a

308 Permanent Redirect

Permanent redirection, during subscription 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 [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.

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.

supp-feat

SupportedFeatures

O

0..1

The features supported by the EAS.

n/a

AcrMgntEventsSubscription

M

1

200 OK

The Individual ACR Management Events Subscription is returned by the EES.

n/a

307 Temporary Redirect

Temporary redirection, during subscription retrieval. 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 [6].

n/a

308 Permanent Redirect

Permanent redirection, during subscription retrieval. 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 [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.

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 Management Events Notification

{notificationDestination}

POST

Notifies the EAS the subscribed ACR management event(s).

User Plane Path Change Availability Notification

{notificationDestination}/report-availability

report-availability (POST)

Notifies the EAS of the availability of user plane path management events monitoring via the 3GPP 5GC network (e.g. due to UE mobility from 5GC to EPC).

AcrMgntEventsNotification

M

1

Notification of the ACR management events.

n/a

204 No Content

The receipt of the Notification is acknowledged.

N/A

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 EAS 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, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS 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 codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] 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.

notificationDestination

Uri

Callback reference provided by the EAS during the ACR Management Event subscription creation/update/modification procedure.

AvailabilityNotif

M

1

Notification of the ACR management events.

n/a

204 No Content

The notification is successfully received.

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 EAS 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 EAS 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 codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] 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.

AcrMgntEventFailureCode

8.6.5.3.6

Represents the reason for ACR Management subscription failure for an event.

AcrMgntEventFilter

8.6.5.3.4

Represents the ACR Management Event filter.

AcrMgntEventsSubscription

8.6.5.2.2

AcrMgntEventSubsc

8.6.5.2.3

AcrMgntEventsSubscriptionPatch

8.6.5.2.4

AcrMgntEventsNotification

8.65.2.5

AcrMgntEventReport

8.6.5.2.6

ActStatus

8.6.5.3.5

Represents ACT status, i.e. ACT start or stop.

AvailabilityNotif

8.6.5.2.11

Represents the availability information of user plane path management events monitoring via the 3GPP 5GC network.

AvailabilityStatus

8.6.5.3.7

Represents the availability status.

FailureAcrMgntEventInfo

8.6.5.2.7

AcrMgntEvent

8.6.5.3.3

IndtUeIdentification

8.6.5.2.10

Contains individual UE identification information.

TargetUeIdentification

8.6.5.2.8

Contains target UE(s) identification information.

UpPathChangeInfo

8.6.5.2.9

Contains user plane path change information.

EasCharacteristics

3GPP TS 24.558 [14]

Represents the EAS characteristics.

DateTime

3GPP TS 29.122 [6]

Dnai

3GPP TS 29.571 [8]

Identifies a DNAI.

DnaiChangeType

3GPP TS 29.571 [8]

DnaiChangeTypeRm

3GPP TS 29.571 [8]

Endpoint

Clause 8.1.5.2.5

Represents the endpoint information.

ExternalGroupId

3GPP TS 29.571 [8]

Represents an external group of UEs.

ExternalId

3GPP TS 29.122 [6]

Represents an external identifier of a UE.

Gpsi

3GPP TS 29.571 [8]

GroupId

3GPP TS 29.571 [8]

Represents an internal group of UEs.

IpAddr

3GPP TS 29.571 [8]

Ipv4Addr

3GPP TS 29.122 [6]

Identifying the IPv4 address of the UE.

Ipv6Prefix

3GPP TS 29.571 [8]

Identifies an IPv6 Prefix.

ReportingInformation

3GPP TS 29.523 [13]

RouteToLocation

3GPP TS 29.571 [8]

Describes the traffic routes to the locations of the application.

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of optional features.

TestNotification

3GPP TS 29.122 [6]

This type represents a notification that can be sent to test whether a chosen notification mechanism works

Uri

3GPP TS 29.122 [6]

WebsockNotifConfig

3GPP TS 29.122 [6]

This type represents configuration for the delivery of notifications over Websockets.

self

Uri

C

0..1

Link to the "Individual ACR Management Events Subscription" resource.

Shall only be present in the HTTP GET response on the "ACR Management Events Subscriptions" resource.

easId

string

M

1

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

eventSubscs

array(AcrMgntEventSubsc)

M

1..N

Indicates the subscribed ACR management events and the related information.

evtReq

ReportingInformation

O

0..1

Indicates the event reporting information.

(NOTE 1, NOTE 2)

notificationDestination

Uri

M

1

Contains the URI towards which the event notifications shall be delivered.

eventReports

array(AcrMgntEventReport)

C

1..N

Represents ACR management event report(s).

This attribute shall be present in an HTTP POST response if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the corresponding HTTP POST request, and the report(s) are available.

This attribute may be present in an HTTP PUT or PATCH response when the report(s) are available.

availabilityInfo

AvailabilityNotif

C

0..1

Indicates the availability information of user plane path management events monitoring via the 3GPP 5GC network.

This attribute may only be present in an HTTP POST/PUT/PATCH response, if the availability status information is available.

failEventReports

array(FailureAcrMgntEventInfo)

O

1..N

Represents the event(s) for which the subscription is not successful including the failure reason(s).

requestTestNotification

boolean

O

0..1

Set to true by the EAS to request the EES to send a test notification as defined in 3GPP TS 29.122 [6]. 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 3GPP TS 29.122 [6].

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

Represents the list of Supported features.

This attribute shall be present in the HTTP POST request if at least one feature is supported by the consumer. It shall be present in an HTTP POST response if it was provided in the corresponding HTTP POST request, or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the corresponding HTTP GET request.

NOTE 1: The "evtReq" of an AcrMgntEventSubsc data structure within the "eventSubscs" attribute takes precedence over the "evtReq" attribute defined in this data structure when both are present.

NOTE 2: When the "evtReq" is not provided in an AcrMgntEventSubsc data structure within the "eventSubscs" attribute, the "evtReq" attribute defined in this data structure applies for the corresponding ACR management event subscription.

event

AcrMgntEvent

M

1

Indicates the subscribed ACR management event.

eventFilter

AcrMgntEventFilter

O

0..1

Represents the event filter for the subscribed ACR management event.

This attribute may be provided only if the "event" attribute is set to "ACR_MONITORING".

evtReq

ReportingInformation

O

0..1

Indicates the event reporting requirements (e.g. reporting periodicity, immediate reporting indication, etc).

(NOTE)

tgtUeId

TargetUeIdentification

C

0..1

Contains the UE identification information.

This attribute shall be provided only if the "event" attribute is set to either "UP_PATH_CHG", "ACR_MONITORING" or "ACR_FACILITATION".

dnaiChgType

DnaiChangeType

O

0..1

Identifies a type of notification regarding UP path management event.

This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG".

easAckInd

boolean

O

0..1

Identifies whether EAS acknowledgement of UP path change event notifications is to be expected.

Set to "true" if the EAS acknowledgement is expected.

Default value is "false".

This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG".

easChars

array(EasCharacteristics)

O

1..N

Represents a list of EAS characteristics.

This attribute may be provided only if the "event" attribute is set to either "ACR_MONITORING" or "ACR_FACILITATION".

NOTE: The "evtReq" takes precedence over the "evtReq" attribute of the AcrMgntEventsSubscription data structure when both are present.

eventSubscs

array(AcrMgntEventSubsc)

O

1..N

Indicates the subscribed ACR management events.

evtReq

ReportingInformation

O

0..1

Indicates the event reporting information.

notificationDestination

Uri

O

0..1

URI where the event notification shall be delivered to.

subpId

string

M

1

String identifying the Individual ACR Management Events Subscription to which the notification is related.

eventReports

array(AcrMgntEventReport)

M

1..N

Represents a list of ACR management event `report(s).

event

AcrMgntEvent

M

1

Indicates the subscribed ACR management event.

timeStamp

DateTime

O

0..1

Represents the time stamp of the detected event.

easEndPoint

EndPoint

C

0..1

Represents the endpoint information of the EAS.

This attribute shall be provided either:

– when the "event" attribute is set to either "ACR_MONITORING" or "ACR_FACILITATION". In such case, it shall contain the endpoint information of the T-EAS; or

– when the "event" attribute is set to "ACT_START_STOP". In such case, it shall contain the endpoint information of the EAS towards/from which the ACT needs to be started/stopped.

actStatus

ActStatus

C

0..1

Represents the reported ACT status, i.e. ACT start or ACT stop.

This attribute shall be provided only when the "event" attribute is set to "ACT_START_STOP".

upPathChgInfo

UpPathChangeInfo

C

0..1

Represents the UP Path change information.

This attribute shall be provided when the "event" attribute is set to "UP_PATH_CHG".

event

AcrMgntEvent

M

1

Indicates the subscribed ACR management event.

failureCode

AcrMgntEventFailureCode

M

1

Identifies the failure reason.

gpsi

Gpsi

O

0..1

Represents external UE identifier.

intGrpId

GroupId

O

0..1

Represents a group of UEs identified by an Internal Group Identifier.

extGrpId

ExternalGroupId

O

0..1

Represents a group of UEs identified by an External Group Identifier.

ueIpAddr

IpAddr

O

0..1

Represents the UE IP address.

NOTE: Only one of the above attributes shall be present.

ueId

IndUeIdentification

M

1

Contains the concerned UE’s identification information.

dnaiChgType

DnaiChangeType

M

1

Identifies the type of notification regarding UP path management event.

sourceTrafficRoute

RouteToLocation

O

0..1

Identifies the N6 traffic routing information associated to the source DNAI.

targetTrafficRoute

RouteToLocation

O

0..1

Identifies the N6 traffic routing information associated to the target DNAI.

sourceDnai

Dnai

O

0..1

Source DN Access Identifier.

targetDnai

Dnai

O

0..1

Target DN Access Identifier.

srcUeIpv4Addr

Ipv4Addr

O

0..1

The IPv4 Address of the served UE for the source DNAI.

srcUeIpv6Prefix

Ipv6Prefix

O

0..1

The Ipv6 Address Prefix of the served UE for the source DNAI.

tgtUeIpv4Addr

Ipv4Addr

O

0..1

The IPv4 Address of the served UE for the target DNAI.

tgtUeIpv6Prefix

Ipv6Prefix

O

0..1

The Ipv6 Address Prefix of the served UE for the target DNAI.

gpsi

Gpsi

O

0..1

Represents the GPSI of the UE.

externalId

ExternalId

O

0..1

Represents the External Identifier of the UE.

ueIpAddr

IpAddr

O

0..1

Represents the UE IP address.

NOTE: Only one of the above attributes shall be present.

availabilityStatus

AvailabilityStatus

M

1

Indicates the availability information of user plane path management events monitoring via the 3GPP 5GC network.

UP_PATH_CHG

The subscribed ACR Management Event is user plane path change.

ACR_MONITORING

The subscribed ACR Management Event is ACR monitoring.

ACR_FACILITATION

The subscribed ACR Management Event is ACR facilitation.

ACT_START_STOP

The subscribed ACR Management Event is ACT start/stop.

INTRA_EDN_MOBILITY

Indicates that the ACR Management Event filter is intra-EDN mobility.

INTER_EDN_MOBILITY

Indicates that the ACR Management Event filter is inter-EDN mobility.

ACT_START

Indicates ACT start.

ACT_STOP

Indicates ACT stop.

3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE

Indicates that the ACR Management Event Subscription failed because user plane path management event notifications from the 3GPP network is NOT available.

This value is only applicable for the "UP_PATH_CHG", "ACR_MONITORING" and "ACR_FACILITATION" events.

OTHER_REASONS

Indicates that the ACR Management Event Subscription failed for other reasons.

This value is applicable for all events.

AVAILABLE

Indicates availability.

NOT_AVAILABLE

Indicates unavailability.

1

Notification_test_event

Testing of notification connection is supported according to clause 7.6.

2

Notification_websocket

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