Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 254
  
 
 
Cisco EPN Manager 2.0.3 RESTCONF NBI Guide  
 
 
12 
2  Northbound RESTCONF Interface  
 
Cisco EPN Manager implements the RESTCONF API as a standards-based Northbound Interface for 
integrating Cisco EPN Manager with a standards-compliant OSS. It is a set of RESTFul services confirmed to 
the RESTCONF/YANG specification. 
 
The Cisco EPN Manager implementation of the RESTCONF/YANG interface supports the retrieval of device 
inventory, circuit inventory, circuit provisioning and notifications about respective resource changes and 
provisioning. This includes: 
 
  Managed Elements and Equipment Inventory 
  Termination Point and Topological Link Inventory 
  Virtual Connection (RFS) Resource Inventory 
  Service (CFS) Inventory 
  Service Provisioning 
  Inventory Object Create, Delete and Attribute Value Change (AVC) Notifications 
 
2.1  RESTCONF and Web Services Standards 
RESTCONF NBI in Cisco EPN Manager is a RESTFul Web Services Interface that follows the IETF Draft 
specification of RESTCONF protocol for defining its interfaces and YANG specification for defining the data 
model. The following W3C and IETF standards are used  
 
  RESTCONF Specification – IETF Draft 9 (draft-ietf-netconf-restconf-13) 
  YANG Specification – RFC 6020  
  RESTful Web Services (JAX-RS) 
  XML Schema version 1.0 (XSD) 
  Hypertext Transfer Protocol HTTP 1.1 - RFCs 7230-7237 
 
While no standard exists for information model exposed by this interface, the model is loosely based on 
TeleManagement Forum (TMF) standards governing the modeling of physical and service inventory. 
2.2  Communication Patterns 
RESTCONF interfaces supported by Cisco EPN Manager use REST (Representational State Transfer) 
techniques. REST is stateless and uses a client-server protocol (HTTP 1.1). 
2.3  Batch Retrieval  
The operations in the API would return a single or multiple objects. In case of operations that return multiple 
objects, set of standard query parameters are defined to manage the number of objects retrieved per 
request. The following http query parameters can be used to control the batch retrieval 
 
Request Query Params 
 
Query Param 
Description 
.startIndex  
 0 based index as a start index of the data to be retrieved.   
Note the dot (.) prefix in the parameter name. This is required to identify this as a 
special parameter. 
.maxCount 
Maximum number of objects to be retrieved.