Tech-invite  3GPPspace  IETFspace
21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x

Content for  TS 23.222  Word version:  19.5.0

Top   Top   Up   Prev   Next
0…   4…   5…   6…   6.3…   6.4…   7…   8…   8.5…   8.8…   8.9…   8.13…   8.17…   8.21…   8.25…   8.26…   8.28…   8.30…   8.33…   8.36…   9…   10…   10.4…   10.7…   11…   A   B…   B.2…   B.3…   C…   D… 
8.8 Subscription, unsubscription and notifications for the CAPIF events  8.8.1 General  8.8.2 Information flows  8.8.2.1 Event subscription request  8.8.2.2 Event subscription response  8.8.2.3 Event notification  8.8.2.4 Event notification acknowledgement  8.8.2.5 Event unsubscription request  8.8.2.6 Event unsubscription response  8.8.2.7 Event subscription update request  8.8.2.8 Event subscription update response  8.8.3 Procedure for CAPIF event subscription  8.8.4 Procedure for CAPIF event notifications  8.8.5 Procedure for CAPIF event unsubscription  8.8.5a Procedure for CAPIF event subscription update  8.8.6 List of CAPIF events 
...

 

8.8  Subscription, unsubscription and notifications for the CAPIF events  p. 54

8.8.1  General  p. 54

The CAPIF core function enables the subscribing entity (i.e. the API invoker, the API exposing function, the API publishing function, the API management function) to subscribe to and unsubscribe from the CAPIF events such as availability events of service APIs, change in service API information, monitoring service API invocations, API invoker onboarding events, etc. The subscription, unsubscription and notification for the CAPIF events are enabled on the following CAPIF reference points:
  • CAPIF-1 or CAPIF-1e: the API invoker can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function;
  • CAPIF-3 or CAPIF-3e: the AEF can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function;
  • CAPIF-4 or CAPIF-4e: the API publishing function can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function; and
  • CAPIF-5 or CAPIF-5e: the API management function can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function.
Up

8.8.2  Information flows  p. 54

8.8.2.1  Event subscription request  p. 54

Table 8.8.2.1-1 describes the information flow for event subscription request from the subscribing entity to the CAPIF core function.
Information element Status Description
Identity informationMThe information to determine the identity of the subscribing entity
Event criteriaMThe event criteria include event type information like failure API invocation event, new API available event, API version change event, API location change event, API invoker status etc and other query information like service API identifier, service API name, onboarding criteria etc.
Notification reception informationOThe information of the subscribing entity for receiving the notifications for the event.
Up

8.8.2.2  Event subscription response  p. 55

Table 8.8.2.2-1 describes the information flow for event subscription response from the CAPIF core function to the subscribing entity.
Information element Status Description
ResultMIndicates the success or failure of the event subscription operation
CauseOThe cause for the request failure.
Subscription identifierO
(see NOTE)		The unique identifier for the event subscription.
NOTE:
Shall be present if the Result information element indicates that the event subscription operation is successful. Otherwise subscription identifier shall not be present.
Up

8.8.2.3  Event notification  p. 55

Table 8.8.2.3-1 describes the information flow for event notification from the CAPIF core function to the subscribing entity. A notification about an event is sent to a subscribing entity if the event criteria in the related subscription match the corresponding attributes of the event content.
Information element Status Description
Subscription identifierMThe unique identifier of the event subscription
Event identifierMThe unique identifier for the event. For the list of events, refer subclause 8.8.6
Event related informationMThe event related information (e.g. time at which the event originated, location of event)
Event contentMThe content of the event information.
Up

8.8.2.4  Event notification acknowledgement  p. 55

Table 8.8.2.4-1 describes the information flow event notification acknowledgement from the subscribing entity to the CAPIF core function.
Information element Status Description
AcknowledgementMAcknowledgement for the event notification received.
Up

8.8.2.5  Event unsubscription request  p. 55

Table 8.8.2.5-1 describes the information flow for event unsubscription request from the subscribing entity to the CAPIF core function.
Information element Status Description
Identity informationMThe information to determine the identity of the subscribing entity
Subscription identifierMThe unique identifier for the event subscription that was provided to the subscribing entity during the CAPIF event subscription operation.
Up

8.8.2.6  Event unsubscription response  p. 56

Table 8.8.2.6-1 describes the information flow for event unsubscription response from the CAPIF core function to the subscribing entity.
Information element Status Description
ResultMIndicates the success or failure of the event unsubscription operation
CauseOThe cause for the request failure.
Up

8.8.2.7  Event subscription update request |R18|  p. 56

Table 8.8.2.7-1 describes the information flow for event subscription update request from the subscribing entity to the CAPIF core function.
Information element Status Description
Identity informationMThe information to determine the identity of the subscribing entity.
Subscription identifierMThe unique identifier for the event subscription that was provided to the subscribing entity during the CAPIF event subscription operation.
Event criteria changesO
(NOTE)		Updates to the event criteria which are defined in clause 8.8.2.1.
Notification reception information changesO
(NOTE)		Updates to the information of the subscribing entity for receiving the notifications for the event.
NOTE:
At least one of these information elements shall be present.
Up

8.8.2.8  Event subscription update response |R18|  p. 56

Table 8.8.2.8-1 describes the information flow for event subscription update response from the CAPIF core function to the subscribing entity.
Information element Status Description
ResultMIndicates the success or failure of the event subscription update operation.
CauseOThe cause for the request failure.
Up

8.8.3  Procedure for CAPIF event subscription  p. 56

Figure 8.8.3-1 illustrates the procedure for CAPIF events subscription.
Pre-condition:
  1. The subscribing entity has the authorization to subscribe for the CAPIF events.
Reproduction of 3GPP TS 23.222, Fig. 8.8.3-1: Procedure for CAPIF event subscription
Figure 8.8.3-1: Procedure for CAPIF event subscription
Up
Step 1.
The subscribing entity sends an event subscription request to the CAPIF core function in order to receive notification of events.
Step 2.
Upon receiving the event subscription request from the subscribing entity, the CAPIF core function checks for the relevant authorization for the event subscription.
Step 3.
If the authorization is successful, the CAPIF core function stores the subscription information.
Step 4.
The CAPIF core function sends an event subscription response indicating successful operation.

8.8.4  Procedure for CAPIF event notifications  p. 57

Figure 8.8.4-1 illustrates the procedure for CAPIF event notifications.
Pre-condition:
  1. The subscription procedure as illustrated in Figure 8.8.3-1 is performed by the subscribing entity.
Reproduction of 3GPP TS 23.222, Fig. 8.8.4-1: Procedure for CAPIF event notifications
Figure 8.8.4-1: Procedure for CAPIF event notifications
Up
Step 1.
The CAPIF core function generates events to be consumed by the subscribing entity(s).
Step 2.
For the generated event, the CAPIF core function retrieves the list of corresponding subscriptions.
Step 3.
The CAPIF core function sends event notifications to all the subscribing entity(s) that have subscribed for the event matching the criteria. If a notification reception information is available as part of the subscribing entity event subscription, then the notification reception information is used by the CAPIF core function to send event notifications to the subscribing entity.
Step 4.
The subscribing entity sends an event notification acknowledgement to the CAPIF core function for the event notification received.
Up

8.8.5  Procedure for CAPIF event unsubscription  p. 58

Figure 8.8.5-1 illustrates the procedure for CAPIF event unsubscription.
Pre-condition:
  1. The subscribing entity has subscribed to the CAPIF events.
Reproduction of 3GPP TS 23.222, Fig. 8.8.5-1: Procedure for CAPIF event unsubscription
Figure 8.8.5-1: Procedure for CAPIF event unsubscription
Up
Step 1.
The subscribing entity sends an event unsubscription request to the CAPIF core function with the information of the subscribed CAPIF event.
Step 2.
Upon receiving the event unsubscription request from the subscribing entity, the CAPIF core function checks for the event subscription corresponding to the subscribing entity and further checks if the subscribing entity is authorized to unsubscribe from the CAPIF event.
Step 3.
If the event subscription information corresponding to the subscribing entity is available and the subscribing entity is authorized to unsubscribe for the CAPIF event, the CAPIF core function removes the subscription information.
Step 4.
The CAPIF core function sends an event unsubscription response indicating successful operation.
Up

8.8.5a  Procedure for CAPIF event subscription update |R18|  p. 58

Figure 8.8.5a-1 illustrates the procedure for CAPIF events subscription update.
Pre-conditions:
  1. The subscribing entity has the authorization to update subscriptions for CAPIF events.
  2. The subscribing entity has created subscriptions for CAPIF events.
Reproduction of 3GPP TS 23.222, Fig. 8.8.5a-1: Procedure for CAPIF event subscription
Figure 8.8.5a-1: Procedure for CAPIF event subscription
Up
Step 1.
The subscribing entity sends an event subscription update request to the CAPIF core function in order update a previous subscription to receive notification of events.
Step 2.
Upon receiving the event subscription update request from the subscribing entity, the CAPIF core function checks for the relevant authorization for the event subscription update.
Step 3.
If the authorization is successful, the CAPIF core function updates the subscription information.
Step 4.
The CAPIF core function sends an event subscription update response indicating successful operation.
Up

8.8.6  List of CAPIF events  p. 59

Table 8.8.6-1 provides a non-exhaustive list of CAPIF events.
Events Events Description
Availability of service APIsAvailability events of service APIs (e.g. active, inactive).
Service API updatedEvents related to change in service API information.
Monitoring service API invocationsEvents corresponding to service API invocations.
API invoker statusEvents related to API invoker status in CAPIF (onboarded, offboarded, onboarding criteria not met status along with the criteria information that is not met).
API topology hiding statusEvents related to API topology hiding status in CAPIF (created, revoked).
System related eventsAlarm events providing fault information.
Performance related eventsEvents related to system load conditions.
CAPIF-1/1e interaction eventsEvents related to CAPIF-1/1e interactions for a service API (e.g. onboarded API invokers).
Up

Up   Top   ToC