Operation
get /data/restnbi/connection/{id}/routeSwitchData
routeSwitchDataById (routeSwitchDataById : /data/restnbi/connection/{id}/routeSwitchData)
Retrieves the route data along with the switch data for a given connection id
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id can be obtained from '/data/otn/connections' REST call with attribute name as 'id' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
RestNbiConnectionRouteSwitchDataResp
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/restnbi/connection/207/routeSwitchData
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
Example Response Data
{ "routeConnInventoryResp": { "reqCompletionStatus": 0, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [ ], "errcde": null, "errorParams": null, "nextTasks": null, "items": [ { "className": "routeComponent", "id": "0", "key": "routeComponent/0", "fromPort": "11DPM12-1-2-C1", "fromPortId": "105589", "fromNe": "SITE-1", "fromNeId": "9", "fromSubNeId": "0", "fromNode": "SITE-1", "fromNodeId": "4", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-L1-1-1", "toPortId": "105542", "toNe": "SITE-1", "toNeId": "9", "toSubNeId": "0", "toNode": "SITE-1", "toNodeId": "4", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "NA", "serverConnectionRate": "NA", "directionality": "CD_BID", "linkProtectionType": "Service", "connectiontype": "RCLink_CrossConnection" }, { "className": "routeComponent", "id": "226000", "key": "routeComponent/226000", "fromPort": "11DPM12-1-2-L1-1-1", "fromPortId": "105542", "fromNe": "SITE-1", "fromNeId": "9", "fromSubNeId": "0", "fromNode": "SITE-1", "fromNodeId": "4", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-L1-1-1", "toPortId": "105798", "toNe": "SITE-2", "toNeId": "13", "toSubNeId": "0", "toNode": "SITE-2", "toNodeId": "5", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "odu2-shilpa1", "serverConnectionRate": "ODU2", "directionality": "CD_BID", "linkProtectionType": "Service", "connectiontype": "RCLink_ExternalServer" }, { "className": "routeComponent", "id": "0", "key": "routeComponent/0", "fromPort": "11DPM12-1-2-L1-1-1", "fromPortId": "105798", "fromNe": "SITE-2", "fromNeId": "13", "fromSubNeId": "0", "fromNode": "SITE-2", "fromNodeId": "5", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-C1", "toPortId": "105845", "toNe": "SITE-2", "toNeId": "13", "toSubNeId": "0", "toNode": "SITE-2", "toNodeId": "5", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "NA", "serverConnectionRate": "NA", "directionality": "CD_BID", "linkProtectionType": "Service", "connectiontype": "RCLink_CrossConnection" }, { "className": "routeComponent", "id": "0", "key": "routeComponent/0", "fromPort": "11DPM12-1-2-C1", "fromPortId": "105589", "fromNe": "SITE-1", "fromNeId": "9", "fromSubNeId": "0", "fromNode": "SITE-1", "fromNodeId": "4", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-L2-1-1", "toPortId": "105570", "toNe": "SITE-1", "toNeId": "9", "toSubNeId": "0", "toNode": "SITE-1", "toNodeId": "4", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "NA", "serverConnectionRate": "NA", "directionality": "CD_BID", "linkProtectionType": "Protection", "connectiontype": "RCLink_CrossConnection" }, { "className": "routeComponent", "id": "238300", "key": "routeComponent/238300", "fromPort": "11DPM12-1-2-L2-1-1", "fromPortId": "105570", "fromNe": "SITE-1", "fromNeId": "9", "fromSubNeId": "0", "fromNode": "SITE-1", "fromNodeId": "4", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-L2-1-1", "toPortId": "105826", "toNe": "SITE-2", "toNeId": "13", "toSubNeId": "0", "toNode": "SITE-2", "toNodeId": "5", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "odu2-infra2", "serverConnectionRate": "ODU2", "directionality": "CD_BID", "linkProtectionType": "Protection", "connectiontype": "RCLink_ExternalServer" }, { "className": "routeComponent", "id": "0", "key": "routeComponent/0", "fromPort": "11DPM12-1-2-L2-1-1", "fromPortId": "105826", "fromNe": "SITE-2", "fromNeId": "13", "fromSubNeId": "0", "fromNode": "SITE-2", "fromNodeId": "5", "fromNeType": "Wdm1830PSS_32", "toPort": "11DPM12-1-2-C1", "toPortId": "105845", "toNe": "SITE-2", "toNeId": "13", "toSubNeId": "0", "toNode": "SITE-2", "toNodeId": "5", "toNeType": "Wdm1830PSS_32", "serverConnectionName": "NA", "serverConnectionRate": "NA", "directionality": "CD_BID", "linkProtectionType": "Protection", "connectiontype": "RCLink_CrossConnection" } ], "data": null, "successfulCompletion": false, "failedCompletion": false }, "switchDataResp": { "message": null, "status": "SUCCESS", "invariantConnId": null, "connId": "207", "pgswitchData": [ { "nodeName": "SITE-1", "nativeName": "11DPM12-1-2-C1", "ObjectId": "105589", "displayName": "11DPM12-1-2-C1", "workingPortPTPDisplayName": "11DPM12-1-2-L1", "workingPortType": "0", "activePortCTPInterfaceName": "/odu0=1", "pgRate": "200", "protectionPortPTPDisplayName": "11DPM12-1-2-L2", "protectionPortRef": "105570", "workingPortCTPInterfaceName": "/odu0=1", "reliablePortCTPInterfaceName": "/dsr=1", "workingPortRef": "105542", "protectionPortType": "0", "meRef": "9", "reliablePortType": "0", "protectionGroupType": "PGT_SNCP", "protectionPortCTPInterfaceName": "/odu0=1", "activePortPTPDisplayName": "11DPM12-1-2-L1", "switchReason": "SR_NO_REQUEST", "activePortType": "0", "reliablePortPTPDisplayName": "11DPM12-1-2-C1", "activePortRef": "105542" }, { "nodeName": "SITE-2", "nativeName": "11DPM12-1-2-C1", "ObjectId": "105845", "displayName": "11DPM12-1-2-C1", "workingPortPTPDisplayName": "11DPM12-1-2-L1", "workingPortType": "0", "activePortCTPInterfaceName": "/odu0=1", "pgRate": "200", "protectionPortPTPDisplayName": "11DPM12-1-2-L2", "protectionPortRef": "105826", "workingPortCTPInterfaceName": "/odu0=1", "reliablePortCTPInterfaceName": "/dsr=1", "workingPortRef": "105798", "protectionPortType": "0", "meRef": "13", "reliablePortType": "0", "protectionGroupType": "PGT_SNCP", "protectionPortCTPInterfaceName": "/odu0=1", "activePortPTPDisplayName": "11DPM12-1-2-L1", "switchReason": "SR_NO_REQUEST", "activePortType": "0", "reliablePortPTPDisplayName": "11DPM12-1-2-C1", "activePortRef": "105798" } ], "listOfAsonIds": [ ] }, "status": "SUCCESS", "message": null }
Collection
Name |
Type |
Description |
Enum |
---|
ConnectionInventoryResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
reqCompletionStatus | Integer integer |
A value which indicates completion status of the request | --- |
requestId | Long long |
Id generated for the Request passed | --- |
clientName | String string |
Indicates name of the client | --- |
clientLocation | String string |
Indicates location of the client | --- |
clientUser | String string |
Indicates the client User | --- |
sessionId | String string |
Session Id of the event | --- |
mdcId | String string |
MDC Id,if any | --- |
sequenceNum | Integer integer |
Indicates the sequence Number generated for the response | --- |
moreToCome | Boolean boolean |
Indicates with true/false if more responses are to come | --- |
messages | array[OtnI18nMessage] OtnI18nMessage |
Response Messages,if any from the response like an Info,Warning etc | --- |
errcde | String string |
Indicates error code,if any error generated | --- |
errorParams | array[Object] object |
Indicates different error parameters,if any error generated | --- |
nextTasks | array[String] string |
Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} | --- |
items | array[Object] object |
Items | --- |
data | array[Object] object |
data | --- |
failedCompletion | Boolean boolean |
Indicates response completion failed with true/false | --- |
successfulCompletion | Boolean boolean |
Indicates successful response completion with true/false | --- |
timeout | Long long |
--- | --- |
nadString | String string |
--- | --- |
Nbi switch Data Response
Name |
Type |
Description |
Enum |
---|---|---|---|
message | String string |
Message | --- |
status | String string |
Status | --- |
invariantConnId | String string |
Data | --- |
connId | String string |
ConnectionID | --- |
listOfAsonIds | Collection Collection |
List of Ason Id's | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
---|---|---|---|
messageTime | Long long |
Message Time | --- |
messageType | String string |
Message Type | [Info, Warning, Error] |
messageUnformatted | String string |
Message Unformatted | --- |
validPropertyResourceMessage | Boolean boolean |
--- | --- |
messageId | String string |
Message Id | --- |
messageParams | array[String] string |
Message Params | --- |
message | String string |
Message | --- |
RestNbiConnectionRouteSwitchDataResp
Name |
Type |
Description |
Enum |
---|---|---|---|
routeConnInventoryResp | ConnectionInventoryResponse ConnectionInventoryResponse |
Connection Route Data | --- |
switchDataResp | Nbi switch Data Response Nbi switch Data Response |
Switch Data | --- |
status | String string |
Status | --- |
message | String string |
Message | --- |