OVERVIEW
This is the reference document for the
REST API and resources provided by NFM-T. The REST APIs are for
the developers who want to integrate NFM-T with other standalone or
web applications.
The REST APIs provide an interface to
interact with NFM-T Application via URI path. To use a REST API,
REST client application will make an HTTP(s) Request and parse the
response. The methods will be standard HTTP(s) methods like GET,
PUT, POST and DELETE.
The input and out format for the REST APIs
is either JSON or XML.
All the OTN, ASON, Network Element,
Alarm, PM and Ethernet Management services are available as RESTful
APIs. Please refer REST Controller section for the deatils of
available services.
REST APIs are programming language
independent. They are accessible from any language that has a HTTP
client library including Java, Python, Perl, and so on. Examples
shown in this document use Spring Java
Authentication
NFM-T is a secured application. Before accessing any REST services, external application needs to authenticate itself to NFM-T application by using authentication REST APIs. Please refer 7 step Authentication below for more details
Quick Reference to Main REST APIs
Bulk Upload REST APIs
API Function |
URL |
Example |
---|---|---|
Get All Equipments | Get All Equipment Example | |
Get All Network Elements | GET /networkinventory/networkelements | Get All Network Elements Example |
Get All Topological Links
|
Get All Topological Links Example | |
Get All Network Connections
|
Get All Network Connections Example |
Templates Retrieval (Used during provisioning) REST APIs
API Function |
URL |
---|---|
Get All Templates (OTN) | |
Get Template Details (OTN) | GET /data/otn/connectionTemplates/{templateName} |
Get ERP Template (ESM)
|
|
Get Service Template (ESM)
|
|
Get OAM Template (ESM)
|
OTN Conection Management REST APIs
API Function |
URL |
Example |
---|---|---|
Service or Infra Creation | ||
Service or Infra Deletion | POST /data/otn/connections/{id}/delete | |
Physical connection creation (OTS/OPS)
|
Physical Connection Creation Example | |
Physical Connecton Deletion (OTS/OPS)
|
Physical Connection Deletion Example | |
Retrieval of Connection provisioning
parameters (Example Transimission parameters etc)
|
Ethernet Service/ERP REST APIs
API Function |
URL |
Example |
---|---|---|
ERP Creation | ERP Creation Example | |
Ethernet Service Creation | POST /esmService/schedDeployEPLService | |
Activate/Deactivate ERP
|
||
Activate/Deactivate Service
|
||
Move EPL Service Back to Allocate
|
||
Move ERP Back to Allocate
|
||
Delete ERP
|
||
Delete Service
|
Node and Port Details Retrievals REST APIs
API Function |
URL |
Example |
---|---|---|
Retreiving Nodes/NEs (Useful during Physical Connection Provisioning) |
GET /data/npr/{table}
{table} = Node |
|
Retreiving Physical Port Details (Useful during Physical Connection Provisioning) |
{table} = Port |
|
Retrieval of Ports detail (useful during
Service Or Infra cration)
|
Alarms Retrieval REST APIs
API Function |
URL |
Example |
---|---|---|
Service or Infra Creation | ||
Service or Infra Deletion | POST /data/otn/connections/{id}/delete | |
Physical connection creation (OTS/OPS)
|
Physical Connection Creation Example | |
Physical Connecton Deletion (OTS/OPS)
|
||
Retrieval of Connection provisioning
parameters (Example Transimission parameters etc)
|
Authentication
API Function |
HTTP Method |
URL |
---|---|---|
User authentication with CAS.
|
POST
|
|
Get Service Ticket for NFM-T
|
POST
|
|
Service Ticket NspOs
|
GET |
|
Register SSO session Manager
|
GET |
|
Service Ticket for Session Manager
|
POST |
|
Service Ticket for NFM-T Application
|
GET |
|
Fetch Session Information from NFM-T Application
|
GET |