CAPIF Events Subscriptions

/{subscriberId}/subscriptions

POST

Creates a new individual CAPIF Event Subscription

Individual CAPIF Events Subscription

/{subscriberId}/subscriptions/
{subscriptionId}

DELETE

Deletes an individual CAPIF Event Subscription identified by the subscriptionId

apiRoot

string

See clause 7.5

subscriberId

string

ID of the Subscriber

n/a

EventSubscription

M

1

Create a new individual CAPIF Events Subscription resource.

EventSubscription

M

1

201 Created

CAPIF Events Subscription resource created successfully.

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

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

Location

string

M

1

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

apiRoot

string

See clause 7.5

subscriberId

string

ID of the Subscriber

subscriptionId

string

Identifies an individual Events Subscription

n/a

n/a

n/a

204 No Content

The individual CAPIF Events Subscription matching the subscriptionId is deleted.

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 CAPIF core function.

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

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 CAPIF core function.

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

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

Location

string

M

1

An alternative URI of the resource located in an alternative CAPIF core function.

Location

string

M

1

An alternative URI of the resource located in an alternative CAPIF core function.

Event notification

{notificationDestination}

POST

Notifies Subscriber of a CAPIF Event

n/a

EventNotification

M

1

Notification information of a CAPIF Event

n/a

204 No Content

The receipt of the Notification is acknowledged.

n/a

307 Temporary Redirect

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

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

n/a

308 Permanent Redirect

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

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

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

Location

string

M

1

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

Location

string

M

1

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

AccessControlPolicyListExt

Clause 8.3.4.2.6

Represents the extension for access control policies.

CAPIFEvent

Clause 8.3.4.3.2

Describes the CAPIF event.

CAPIFEventDetail

Clause 8.3.4.2.5

Represents the CAPIF event detail.

Enhanced_event_report

CAPIFEventFilter

Clause 8.3.4.2.4

Represents the CAPIF event filter.

Enhanced_event_report

EventNotification

Clause 8.3.4.2.3

Represents an individual CAPIF Event Subscription Notification.

EventSubscription

Clause 8.3.4.2.2

Represents an individual CAPIF Event Subscription resource.

TopologyHiding

Clause 8.3.4.2.7

Represents the routing rules information of a service API.

ReportingInformation

3GPP TS 29.523 [26]

Used to indicate the reporting requirement, only the following information are applicable for CAPIF:

– immRep

– notifMethod

– maxReportNbr

– monDur

– repPeriod

Enhanced_event_report

SupportedFeatures

3GPP TS 29.571 [19]

Used to negotiate the applicability of optional features defined in table 8.3.6-1.

events

array(CAPIFEvent)

M

1..N

Subscribed events

eventFilters

array(CAPIFEventFilter)

O

1..N

Subscribed event filters.

The n^th entry in the "eventFilters" attribute shall correspond to the n^th entry in the "events" attribute. For event not having event filter, an empty event filter entry without any sub-attribute shall be provided.

Enhanced_event_report

eventReq

ReportingInformation

O

0..1

Represents the reporting requirements of the event subscription.

Enhanced_event_report

notificationDestination

Uri

M

1

URI where the notification should be delivered to.

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in clause 7.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 clause 7.6.

Notification_websocket

supportedFeatures

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.

subscriptionId

string

M

1

Identifier of the subscription resource to which the notification is related – CAPIF resource identifier

events

CAPIFEvent

M

1

Notifications of individual events

eventDetail

CAPIFEventDetail

O

0..1

Detailed information for the event.

Enhanced_event_report

apiIds

array(string)

O

1..N

API identifiers that the event subscriber wants to know in the interested event.

apiInvokerIds

array(string)

O

1..N

API invokers that the event subscriber wants to know in the interested event.

aefIds

array(string)

O

1..N

String identifying the AEF.

serviceAPIDescriptions

array(ServiceAPIDescription)

O

1..N

Description of the service API as published by the APF.

apiIds

array(string)

O

1..N

API identifiers.

apiInvokerIds

array(string)

O

1..N

API invokers that are onboarded/offboarded.

accCtrlPolList

AccessControlPolicyListExt

O

0..1

Access control policy updated list.

invocationLogs

array(InvocationLog)

O

1..N

Invocation logs

apiTopoHide

TopologyHiding

O

0..1

Topology hiding information for a service API

apiId

string

M

1

Identifier of the service API

NOTE: This data type also contains all the properties defined for AccessControlPolicyList data type.

apiId

string

M

1

Identifier of the service API

routingRules

array(RoutingRule)

M

1..N

Routing rules

n/a

SERVICE_API_AVAILABLE

Events related to the availability of service APIs after the service APIs are published.

SERVICE_API_UNAVAILABLE

Events related to the unavailability of service APIs after the service APIs are unpublished.

SERVICE_API_UPDATE

Events related to change in service API information

API_INVOKER_ONBOARDED

Events related to API invoker onboarded to CAPIF

API_INVOKER_OFFBOARDED

Events related to API invoker offboarded from CAPIF

SERVICE_API_INVOCATION_SUCCESS

Events related to the successful invocation of service APIs

SERVICE_API_INVOCATION_FAILURE

Events related to the failed invocation of service APIs

ACCESS_CONTROL_POLICY_UPDATE

Events related to the update for the access control policy related to the service APIs

ACCESS_CONTROL_POLICY_UNAVAILABLE

Events related to the unavailability of the access control policy related to the service APIs (NOTE)

API_INVOKER_AUTHORIZATION_REVOKED

Events related to the revocation of the authorization of API invokers to access the service APIs. (NOTE)

API_INVOKER_UPDATED

Events related to API invoker profile updated to CAPIF.

API_TOPOLOGY_HIDING_CREATED

Events related to the creation or update of the API topology hiding information of the service API after the service APIs are published

API_TOPOLOGY_HIDING_REVOKED

Events related to the revocation of the API topology information of the service API after the service APIs are unpublished

NOTE: The present release does not specify further details (e.g. event filters) for this event.

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.

3

Enhanced_event_report

This feature supports the enhanced event report including event reporting requirement and event reporting details as defined in clause 5.4.2.2.2.