GET/swim/jobDetailsById/{jobId} Fetches Ne list per Job based on job id
GET/data/swim/upsert/data Fetches all the EmlGroup
GET/data/swim/backupNeInfo Returns Success/Failed and Non backup Nes
Response contains 2 attributes
label : which will have values Failed, Success or Nobackup
value : number of NEs having the state
GET/data/swim/backupFiles/{neLabel}/ Fetches list or files for restoring
GET/data/swim/anaytics/softwareVersionStatus Fetch software version status.
GET/data/swim/anaytics/backupStatus/{period} Fetch NE Types
GET/data/swim/SnaInstances/{emlInstance} Fetches all the EmlGroup
GET/data/otn/connections/networkConnections/stats/services/serviceUptime gives the total serviceUptime of a service connection for a given period of From and To time in milliseconds
PUT/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
POST/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
DELETE/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
PATCH/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
HEAD/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
OPTIONS/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
GET/data/restnbi/{trailId}/currentRouteSwitchData Retrieves the current route along with the switch data information for a given connection id. If there is no switching on the current route, switchdata will be empty. The response consists of - current Route details, switch details and the API's request status
Response
Changed response : [200]//Retrieve current route data successfully
Changed response : [200]//If the given node id is available, corresponding node name will be returned. If the given node id is not available, Object not found message will be returned.
GET/data/otn/node/id Retrieves the OTN node id for the given OTN node name
Response
Changed response : [200]//If the given node name is available, corresponding node id will be returned as a string. If the given node name is not available, Object not found message will be returned.
Changed response : [200]//If the given connection id is available, corresponding connection name will be returned. If given connection id is not available, Object not found message will be returned.
Changed response : [200]//If the given connection name is available, corresponding connection id will be returned as a string. If the given connection name is not available, Object not found message will be returned.
Changed response : [200]//If the given NPR node id is available, corresponding NPR node name will be returned. If the given NPR node id is not available, Object not found message will be returned.
GET/data/npr/node/id Retrieves the NPR node id of the given NPR node name
Response
Changed response : [200]//If the given NPR node name is available, corresponding NPR node id will be returned as a string. If the given NPR name id is not available, Object not found message will be returned.
Changed response : [200]//If the given NPR NE name is available, corresponding NPR NE id will be returned. If the given NPR NE name is not available, Object not found message will be returned.
GET/data/npr/ne/id Retrieves the NPR NE id of the given NPR NE name
Response
Changed response : [200]//If the given NPR NE id is available, corresponding NPR NE name will be returned. If the given NPR NE id is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON telink id is available, corresponding ASON telink name will be returned. If the given ASON telink id is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON telink name is available, corresponding ASON telink id will be returned as a string. If the given ASON telink name is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON SRG name is available, corresponding ASON SRG id will be returned as a string. If the given ASON SRG id is not available, Object not found message will be returned.
GET/data/ason/srg/id Retrieves the ASON SRG id of the given ASON SRG name.
Response
Changed response : [200]//If the given ASON SRG name is available, corresponding ASON SRG name will be returned. If the given ASON SRG name is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON SNC id is available, corresponding ASON SNC name will be returned. If the given ASON SNC id is not available, Object not found message will be returned.
GET/data/ason/snc/id Retrieves the ASON SNC id of the given ASON SNC name.
Response
Changed response : [200]//If the given ASON SNC name is available, corresponding ASON SNC id will be returned as a string. If the given ASON SNC id is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON phyconn id is available, corresponding ASON phyconn name will be returned. If the given ASON phyconn id is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON phyconn id is available, corresponding ASON phyconn name will be returned as a string. If the given ASON phyconn id is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON NPA id is available, corresponding ASON NPA name will be returned. If the given ASON NPA id is not available, Object not found message will be returned.
GET/data/ason/npa/id Retrieves the ASON NPA id of the given ASON NPA name.
Response
Changed response : [200]//If the given ASON NPA name is available, corresponding ASON NPA id will be returned. If the given ASON NPA name is not available, Object not found message will be returned.
Changed response : [200]//If the given ASON link id is available, corresponding ASON link name will be returned. If the given ASON link id is not available, Object not found message will be returned.
GET/data/ason/link/id Retrieves the ASON link id for the given ASON link name.
Response
Changed response : [200]//If the given ASON link name is available, corresponding ASON link id will be returned as a string. If the given ASON link name is not available, Object not found message will be returned.
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
POST/data/otn/connection/renameConnection/{connId} To rename the connection name or the alias for the connection using the connection ID,connection Id is mandatory for single connection rename
Response
New response : [400]//Bad request
New response : [500]//Internal server error
Changed response : [200]//Connection rename done
Schema
Changed body: '*/*'
POST/data/otn/connection/renameConnection/ To rename the connection name or the alias for the connection using the connection ID,connection Id is mandatory for single connection rename
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
New response : [400]//Bad Request. If the payload data is incorrect
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
POST/asap/asapSet/neLevel/{groupId}/{neId}/{category} This is used to @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned"),
@ApiResponse(responseCode = "400", description = "Bad Request"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")})
Response
New response : [500]//Internal Server Error
New response : [400]//Bad Request
Changed response : [200]//If the operation is success, Object with key SUCCESS and value Success will be returned and if the operation is failure, Object with key FAILURE and value Failure will be returned
Changed response : [200]//Retrieve baud rates for base profile id successfully
Schema
Changed body: 'application/json'
POST/data/otn/labelUnassign This API is to un-assign the label from the business object(s).
The POST request body used for WS-NOC operations can have following fields.
The "nameSpace" can be any string and is a mandatory field. For WS-NOC, preferred value is "NOC".
The "type" distinguishes the request type and is a mandatory field. It can have multiple values like “newLabel” (for createLabel request), “genericObject” (for labelAssign/labelUnassign).
The "businessObjectId" is the Id of the object and is a mandatory field. The connection id can be obtained from 'data/otn/connections' REST call as id. The ne id can be retrieved as 'id' from the REST call '/data/npr/nes'.
The "businessObjectType" is the type of the object and is a mandatory field. For WS-NOC it can be “trail” or "lopc" or ”path” or ”physicalConn” or ”ne”.
The "labelNames" is the string array and is a mandatory field.