STATUS: Draft

External API:

1 High Level Component Definition and Architectural Relationships

External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.

It provides

External API provides the following interfaces:

Interface Name	Interface Definition	Interface Capabilities
ExternalAPIE-1 NBI Management Interface	Provides a healthcheck to verify that the NBI component is running fine	Provides: Healthcheck of a NBI service
ExternalAPIE-2 Subscription Management Interface	Provides the ability to subscribe to and unsubscribe from External API events. (also known as the External API Hub interface)	Provides: Create/Delete a Notification List notification Retrieve a notification Listen to notifications
ExternalAPIE-3 Service Catalogue Interface	Find service specifications that can be instantiated	Provides: Search for services in the catalogue (with filters) Retrieve a service specification from the catalogue
ExternalAPIE-4 Service Ordering Interface	Request the instantiation of a service	Provides Search for service orders Retrieve a service order Request a service instantiation
ExternalAPIE-5 Service Inventory Interface	Query information about instantiated services	Provides Search for instantiated Services Retrieve information about an instantiated order

Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface

The current API documents can be found at:

ExternalAPI consumes the following Interfaces:

Interface Name	Purpose Reason For Use
SDCE-6	To receive the notifications of a new service.
SDCE-7	To query the catalogue for service specifications
SOE-X	To request a service instantiation
AAIE-1	To query the instantiated services
MSBE-1	Register NBI API
DMAAPE-1	Poll 2 topics: AAI events SDC events

A more detailed figure and description of the component.

<< For later inclusion >>

ExternalAPI uses the following models: