Tech-invite3GPPspaceIETFspace
21222324252627282931323334353637384‑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.5  Retrieve service APIsp. 49

8.5.1  Generalp. 49

The CAPIF supports retrieving the published service APIs information by the API provider. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.

8.5.2  Information flowsp. 49

8.5.2.1  Service API get requestp. 49

Table 8.5.2.1-1 describes the information flow service API get request from the API publishing function to the CAPIF core function.
Information element Status Description
API publisher informationMThe information of the API publisher may include identity, authentication and authorization information
Service API published information referenceMThe information provided by the CAPIF core function which can be for referencing the information (set) about the published service API by the API publishing function.
Up

8.5.2.2  Service API get responsep. 49

Table 8.5.2.2-1 describes the information flow service API get response from the CAPIF core function to the API publishing function.
Information element Status Description
ResultMIndicates the success or failure of retrieving the service API information
CauseOThe cause for the request failure.
Service API informationO
(see NOTE)
The service API information as specified in Table 8.3.2.1-1.
NOTE:
Shall be present if the Result information element indicates that the service API get request is successful. Otherwise service API information shall not be present.
Up

8.5.3  Procedurep. 49

Figure 8.5.3-1 illustrates the procedure for retrieving the service APIs. The service API retrieval mechanism is supported by the CAPIF core function.
Pre-condition:
  1. Authorization details of the APF are available with the CAPIF core function.
Reproduction of 3GPP TS 23.222, Fig. 8.5.3-1: Retrieve service APIs
Up
Step 1.
The API publishing function sends a service API get request to the CAPIF core function, with service API published information reference provided by the CAPIF core function when the service API was published.
Step 2.
Upon receiving the service API get request, the CAPIF core function checks whether the API publishing function is authorized to get published service APIs information. If the check is successful, the corresponding service API information is retrieved from the CAPIF core function (API registry).
Step 3.
The CAPIF core function provides a service API get response to the API publishing function which includes the service API information.
Up

8.6  Update service APIsp. 50

8.6.1  Generalp. 50

The CAPIF core function allows the service API provider to update the information related to the published service API, e.g. a change in the characteristics of the service API. This procedure is initiated by the API publishing function to the CAPIF core function. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.

8.6.2  Information flowsp. 50

8.6.2.1  Service API update requestp. 50

Table 8.6.2.1-1 describes the information flow service API update request from the API publishing function to the CAPIF core function.
Information element Status Description
API publisher informationMThe information of the API publisher may include identity, authentication and authorization information
Service API published information referenceMThe information (set) provided by the CAPIF core function about the published service API which can be used for reference by the API publishing function.
Service API informationM The service API information as specified in Table 8.3.2.1-1, as required to replace the existing service API information.
ReasonOThe reason of the update (e.g. change log).
Up

8.6.2.2  Service API update responsep. 51

Table 8.6.2.2-1 describes the information flow service API update response from the CAPIF core function to the API publishing function.
Information element Status Description
ResultMIndicates the success or failure of updating the service API information.
CauseOThe cause for the request failure.
Service API informationO The authorized service API information during update, applicable when the update result is success. This can be a subset or the full set, of the Service API information as specified in Table 8.3.2.1-1.
Up

8.6.3  Procedurep. 51

Figure 8.6.3-1 illustrates the procedure for updating the published service APIs information. The service API update mechanism is supported by the CAPIF core function.
Pre-conditions:
  1. Authorization details of the APF are available with the CAPIF core function.
  2. API invokers may have subscribed with the CAPIF core function to obtain notification regarding update to service API information.
Reproduction of 3GPP TS 23.222, Fig. 8.6.3-1: Update service APIs
Up
Step 1.
The API publishing function sends a service API update request to the CAPIF core function, which includes the service API published information reference provided by the CAPIF core function when the service API was published and the new service API information which is to be updated.
Step 2.
Upon receiving the service API update request, the CAPIF core function checks whether the API publishing function is authorized to update the published service APIs information. If the check is successful, the service API information provided by the API publishing function is updated at the CAPIF core function (API registry).
Step 3.
The CAPIF core function provides a service API update response to the API publishing function and triggers notifications to subscribed API invokers as described in subclause 8.8.4.
Up

8.7  Discover service APIsp. 52

8.7.1  Generalp. 52

The following procedure in this subclause corresponds to the architectural requirements on discover service APIs. This procedure may be invoked by different types of API invokers (i.e., application management client, hosted application) at different phases (i.e., hosted application development, test phase and hosted application running phase). Different API invokers utlize this procedure for different purpose:
  • service API discovery for interested service APIs with service API informaiton including e.g., API name, API provider name, API category.
  • service API discovery for the interface information (e.g. IP address, port number, URI) of a particular service API in case of the interface information is not provided in the service API information during hosted application running phase.
Up

8.7.2  Information flowsp. 52

8.7.2.1  Service API discover requestp. 52

Table 8.7.2.1-1 describes the information flow service API discover request from the API invoker to the CAPIF core function.
Information element Status Description
API invoker identity informationMIdentity information of the API invoker discovering service APIs
Query informationO
(NOTE 2)
Criteria for discovering matching service APIs (e.g. service API category, Serving Area Information (optional), preferred AEF location (optional), required API provider name (optional), UE IP address (optional), interfaces, protocols, Service KPIs (optional), security methods, service API operation(s) and resource(s) (optional), and Network Slice Info (optional)).
(see NOTE 1).
Service API identificationO
(NOTE 2)
The identification information of the service API(s) for which the request is targeting.
NOTE 1:
It should be possible to discover all the service APIs.
NOTE 2:
Either "Query information" IE or " Service API identification" IE shall be present.
Up

8.7.2.2  Service API discover responsep. 52

Table 8.7.2.2-1 describes the information flow service API discover response from the CAPIF core function to the API invoker.
Information element Status Description
ResultMIndicates the success or failure of the discovery of the service API information
Service API information
(see NOTE 2)
O
(see NOTE 1, NOTE 3)
The service API information as specified in Table 8.3.2.1-1, except for the service API status (e.g. active, inactive).
Interface informationO
(NOTE 3)
The interface details (e.g. IP address, port number, URI) of the requested service API(s).
CAPIF core function identity informationO
(see NOTE 1, NOTE 3)
Indicates the CAPIF core function serving the service API category provided in the query criteria
NOTE 1:
The service API information or the CAPIF core function identity information or both shall be present if the Result information element indicates that the service API discover operation is successful. Otherwise, both shall not be present.
NOTE 2:
If topology hiding is enabled for the service API, the interface details shall be the interface details of AEF acting as service communication entry point for the service API.
NOTE 3:
"Interface information" IE shall not be present when "Service API information" or "CAPIF core function identity information" is present.
Up

8.7.3  Procedurep. 53

Figure 8.7.3-1 illustrates the procedure for discover service APIs.
The service API discovery mechanism is supported by the CAPIF core function.
Pre-conditions:
  1. The API invoker is onboarded and has received an API invoker identity.
  2. The CAPIF core function is configured with a discovery policy information (e.g. to restrict discovery to category of APIs) for API invoker(s).
Reproduction of 3GPP TS 23.222, Fig. 8.7.3-1: Discover service APIs
Up
Step 1.
The API invoker sends a service API discover request to the CAPIF core function. It includes the API invoker identity, either query information or the service API identification.
For service API discovery for interested service APIs, the query information is included.
For service API discovery for interface information, service API identification is included.
Step 2.
Upon receiving the service API discover request, the CAPIF core function verifies the identity of the API invoker (via authentication).
If the query information is included, the CAPIF core function retrieves the stored service API(s) information from the CAPIF core function (API registry) as per the query information in the service API discover request. Further, the CAPIF core function applies the discovery policy and performs filtering of service APIs information retrieved from the CAPIF core function.
If the service API identification is included, the CAPIF core function retrieves the interface information of the requested service API(s).
Step 3.
The CAPIF core function sends a service API discover response to the API invoker.
If the query information is included, the list of service API information is returned.
If the service API identification is included, the interface information is returned.
Up

Up   Top   ToC