CPS Design

Offered APIs

CPS supports the public APIs listed in the following sections.


CPS-Core functionality.

CPS Rest OpenApi Specification


XNF data access and module information.

CPS NCMP RestOpenApi Specification


DMI-Plugin Inventory.

CPS NCMP RestOpenApi Inventory Specification

View Offered APIs

The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS 3, which is based on the original “Swagger Specification”, is being widely used in API developments.

Specification can be accessed using following URI:


Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core, CPS-NCMP and CPS-NCMP-Inventory using the drop down table in the top right:


Consumed APIs

CPS Core uses API’s from the following ONAP components

  • DMI-Plugin: REST based interface which is used to provide integration and allow the DMI registry API’s have access to the corresponding NCMP API’s within CPS Core. More information on the DMI-Plugins offered APIs can be found on the DMI-Plugin’s Design Page.

CPS Path

Several CPS APIs use the cps-path (or cpsPath in Java API) parameter. The CPS Path is described in detail in CPS Path.

NCMP CM Handle Querying

The CM Handle searches endpoints can be used to query for CM Handles or CM Handle IDs. This endpoint is described in detail in CM Handle Query Endpoints.