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.1.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…   9…   10…   10.4…   10.7…   11…   A   B…   B.2…   B.3…   C…   D… 
10 CAPIF core function APIs  10.1 General  10.2 CAPIF_Discover_Service_API API  10.2.1 General  10.2.2 Discover_Service_API operation  10.2.3 Subscribe_Event operation  10.2.4 Notify_Event operation  10.2.5 Unsubscribe_Event operation  10.2.6 Update_Event_Subscription operation  10.3 CAPIF_Publish_Service_API API  10.3.1 General  10.3.2 Publish_Service_API operation  10.3.3 Unpublish_Service_API operation  10.3.4 Update_Service_API operation  10.3.5 Get_Service_API operation  10.3.6 Subscribe_Event operation  10.3.7 Notify_Event operation  10.3.8 Unsubscribe_Event operation  10.3.9 Update_Event_Subscription operation 
...

 

10  CAPIF core function APIs  p. 102

10.1  General  p. 102

Table 10.1-1 illustrates the CAPIF core function APIs.
API Name API Operations Known Consumer(s) Communication Type
CAPIF_Discover_Service_APIDiscover_Service_APIAPI Invoker,
CAPIF core function		Request/ Response
Subscribe_EventAPI InvokerRequest/ Response
Update_Event_SubscriptionAPI InvokerRequest/ Response
Notify_EventAPI InvokerNotify
Unsubscribe_EventAPI InvokerRequest/ Response
CAPIF_Publish_Service_APIPublish_Service_APIAPI Publishing Function,
CAPIF core function		Request/ Response
Unpublish_Service_APIAPI Publishing Function,
CAPIF core function		Request/ Response
Update_Service_APIAPI Publishing Function,
CAPIF core function		Request/ Response
Get_Service_APIAPI Publishing Function,
CAPIF core function		Request/ Response
Subscribe_EventAPI Publishing FunctionRequest/ Response
Update_Event_SubscriptionAPI Publishing FunctionRequest/ Response
Notify_EventAPI Publishing FunctionNotify
Unsubscribe_EventAPI Publishing FunctionRequest/ Response
CAPIF_Events APISubscribe_EventAPI Invoker,
API Publishing Function,
API Management Function,
API Exposing Function		Request/ Response
Update_Event_SubscriptionAPI Invoker,
API Publishing Function,
API Management Function,
API Exposing Function		Request/ Response
Notify_EventAPI Invoker,
API Publishing Function,
API Management Function,
API Exposing Function		Notify
Unsubscribe_EventAPI Invoker,
API Publishing Function, API Management Function, API Exposing Function		Request/ Response
CAPIF_API_Invoker_management APIOnboard_API_InvokerAPI InvokerRequest/ Response
Offboard_API_InvokerAPI InvokerRequest/ Response
Subscribe_EventAPI Management FunctionRequest/ Response
Update_Event_SubscriptionAPI Management FunctionRequest/ Response
Notify_EventAPI Management FunctionNotify
Unsubscribe_EventAPI Management FunctionRequest/ Response
CAPIF_API_Provider_Management_APIRegister_API_ProviderAPI Management FunctionRequest/Response
Update_API_ProviderAPI Management FunctionRequest/Response
Deregister_API_ProviderAPI Management FunctionRequest/Response
CAPIF_Security APIObtain_Security_MethodAPI InvokerRequest/ Response
Obtain_AuthorizationAPI InvokerRequest/ Response
Obtain_API_Invoker_InfoAPI Exposing FunctionRequest/ Response
Revoke_AuthorizationAPI Exposing FunctionRequest/ Response
CAPIF_Monitoring APISubscribe_EventAPI Management FunctionRequest/ Response
Update_Event_SubscriptionAPI Management FunctionRequest/ Response
Notify_Monitoring_Service_EventAPI Management FunctionNotify
Unsubscribe_EventAPI Management FunctionRequest/ Response
CAPIF_Logging_API_Invocation APILog_API_InvocationAPI exposing functionRequest/ Response
CAPIF_Auditing APIQuery_API_Invocation_LogAPI management functionRequest/ Response
CAPIF_Access_Control_Policy APIObtain_Access_Control_PolicyAPI exposing functionRequest/Response
CAPIF_Routing_Info APIObtain_Routing_InfoAPI exposing functionRequest/Response
Up

10.2  CAPIF_Discover_Service_API API  p. 104

10.2.1  General  p. 104

API description:
This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information over CAPIF-1 or CAPIF-1e.

10.2.2  Discover_Service_API operation  p. 104

API operation name:
Discover_Service_API
Description:
Provides the published service APIs information.
Known Consumers:
API invoker.
Inputs:
Refer subclause 8.7.2.1.
Outputs:
Refer subclause 8.7.2.2.
See subclause 8.7.3 for the details of usage of this API operation.

10.2.3  Subscribe_Event operation  p. 104

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API invoker.
Inputs:
Refer subclause 8.8.2.1.
Outputs:
Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.

10.2.4  Notify_Event operation  p. 104

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API invoker.
Inputs:
Refer subclause 8.8.2.3.
Outputs:
Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.

10.2.5  Unsubscribe_Event operation  p. 104

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API invoker.
Inputs:
Refer subclause 8.8.2.5.
Outputs:
Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.

10.2.6  Update_Event_Subscription operation |R18|  p. 105

API operation name:
Update_Event_Subscription
Description:
Updates a subscription to CAPIF related event information.
Known Consumers:
API invoker.
Inputs:
Refer subclause 8.8.2.7.
Outputs:
Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.

10.3  CAPIF_Publish_Service_API API  p. 105

10.3.1  General  p. 105

API description:
This API enables the API publishing function to communicate with the CAPIF core function to publish the service API information and manage the published service API information over CAPIF-4.

10.3.2  Publish_Service_API operation  p. 105

API operation name:
Publish_Service_API
Description:
Publish the service API information.
Known Consumers:
API publishing function, CAPIF core function.
Inputs:
Refer subclause 8.3.2.1, 8.25.2.1.
Outputs:
Refer subclause 8.3.2.2, 8.25.2.2.
See subclause 8.3.3 and 8.25.3.1 for the details of usage of this API operation.

10.3.3  Unpublish_Service_API operation  p. 105

API operation name:
Unpublish_Service_API
Description:
Remove the published service API information.
Known Consumers:
API publishing function, CAPIF core function.
Inputs:
Refer subclause 8.4.2.1, 8.25.2.5.
Outputs:
Refer subclause 8.4.2.2, 8.25.2.6.
See subclause 8.4.3 and 8.25.3.4 for the details of usage of this API operation.

10.3.4  Update_Service_API operation  p. 105

API operation name:
Update_Service_API
Description:
Update the published service API information.
Known Consumers:
API publishing function, CAPIF core function.
Inputs:
Refer subclause 8.6.2.1, 8.25.2.9.
Outputs:
Refer subclause 8.6.2.2, 8.25.2.10.
See subclause 8.6.3 and 8.25.3.6 for the details of usage of this API operation.

10.3.5  Get_Service_API operation  p. 106

API operation name:
Get_Service_API
Description:
Retrieve the published service API information.
Known Consumers:
API publishing function, CAPIF core function.
Inputs:
Refer subclause 8.5.2.1, 8.25.2.7.
Outputs:
Refer subclause 8.5.2.2, 8.25.2.8.
See subclause 8.5.3 and 8.25.3.5 for the details of usage of this API operation.

10.3.6  Subscribe_Event operation  p. 106

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API publishing function.
Inputs:
Refer subclause 8.8.2.1.
Outputs:
Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.

10.3.7  Notify_Event operation  p. 106

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API publishing function.
Inputs:
Refer subclause 8.8.2.3.
Outputs:
Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.

10.3.8  Unsubscribe_Event operation  p. 106

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API publishing function.
Inputs:
Refer subclause 8.8.2.5.
Outputs:
Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.

10.3.9  Update_Event_Subscription operation |R18|  p. 107

API operation name:
Update_Event_Subscription
Description:
Updates a subscription to CAPIF related event information.
Known Consumers:
API publishing function.
Inputs:
Refer subclause 8.8.2.7.
Outputs:
Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.

Up   Top   ToC