Operation
get /otn/NBI/topoMgmt/TopologicalLinks/{includeInternalLinks}
Retrieves all the internal links (getAllTopologicalLinks : /otn/NBI/topoMgmt/TopologicalLinks/{includeInternalLinks})
getAllTopologicalLinks
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
includeInternalLinks | required | includeInternalLinks supported values: all , external | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Nbi Topological Response
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/otn/NBI/topoMgmt/TopologicalLinks/external
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.
application/json
Example Response Data
{ "message": null, "status": "SUCCESS", "topoData": [ { "Z1TpId": "177", "A1TpDisplayLabel": "AHPHG-1-15-LINE", "Z1NeId": "43", "ALLPATHCOST": "20", "ConnectionRate": "30", "ALIAS": "OTS-S13X100RPathSyncIssue", "ImplSt": "ImplementationState_implemented", "OrderStackId": "75", "A2TpType": "0", "Z2TpInterfaceName": null, "ASONADMSTATE": "Not Applicable", "Z2NodeName": null, "OrderType": "2", "Z2NeId": "0", "Z2TpId": "0", "Z1NodeId": "3", "A2NodeName": null, "A1TpUserLabel": null, "Z2TpName": null, "A1NeName": "PSS32-41.37.180", "CREATIONTIME": "20180217053208.0Z", "ID": "110", "NPRID": "42", "Z2TpUserLabel": null, "Z2TpDisplayLabel": null, "A1NeId": "62", "A2NeName": null, "A1TpId": "29529", "A2TpDisplayLabel": null, "A2NodeId": "0", "Z1TpType": "0", "INEFFECTDATE": "20180217053209.0Z", "OrderId": "105", "NAME": "OTS-S13X100RPathSyncIssue", "A1TpName": "AHPHG-1-15-LINE", "A2NeId": "0", "NCID": "72", "signalType": "notMeaningful", "Z1TpInterfaceName": "AHPHG-1-15-LINE", "ConnectionState": "9", "Z1TpDisplayLabel": "AHPHG-1-15-LINE", "A2TpId": "0", "OrderState": "2", "ConnectionShape": "simple", "A2TpUserLabel": null, "ConnectionCategory": "0", "Z2TpType": "0", "pm15MinuteCollectionType": "COLLECT", "A1NodeId": "23", "Z1NeName": "PSS32-41.37.179", "A2TpName": null, "SERVICESTATE": "Not In Service", "UserLabel": null, "LINKTYPE": "LEGACY", "Z1NodeName": "PSS32-41.37.179", "A1NodeName": "PSS32-41.37.180", "LATENCY": "0", "CustomerName": "None", "A1TpType": "0", "Z1TpUserLabel": null, "ALARMSTATUS": "Cleared", "pm24HourCollectionType": "COLLECT", "A1TpInterfaceName": "AHPHG-1-15-LINE", "ASONWTR": "60", "A2TpInterfaceName": null, "Z2NodeId": "0", "Z2NeName": null, "OPERATIONALSTATE": "Enabled", "ConnectionDirection": "CD_BID", "Z1TpName": "AHPHG-1-15-LINE" }, { "Z1TpId": "186", "A1TpDisplayLabel": "AHPHG-1-10-LINE", "Z1NeId": "43", "ALLPATHCOST": "20", "ConnectionRate": "30", "ALIAS": "PSS32-41.37.180/AHPHG-1-10-LINE-PSS32-41.37.179/AHPHG-1-10-LINE", "ImplSt": "ImplementationState_implemented", "OrderStackId": "26", "A2TpType": "0", "Z2TpInterfaceName": null, "ASONADMSTATE": "Not Applicable", "Z2NodeName": null, "OrderType": "2", "Z2NeId": "0", "Z2TpId": "0", "Z1NodeId": "3", "A2NodeName": null, "A1TpUserLabel": null, "Z2TpName": null, "A1NeName": "PSS32-41.37.180", "CREATIONTIME": "20180209074743.0Z", "ID": "70", "NPRID": "1", "Z2TpUserLabel": null, "Z2TpDisplayLabel": null, "A1NeId": "62", "A2NeName": null, "A1TpId": "29299", "A2TpDisplayLabel": null, "A2NodeId": "0", "Z1TpType": "0", "INEFFECTDATE": "20180209074744.0Z", "OrderId": "31", "NAME": "PSS32-41.37.180/AHPHG-1-10-LINE-PSS32-41.37.179/AHPHG-1-10-LINE", "A1TpName": "AHPHG-1-10-LINE", "A2NeId": "0", "NCID": "26", "signalType": "notMeaningful", "Z1TpInterfaceName": "AHPHG-1-10-LINE", "ConnectionState": "9", "Z1TpDisplayLabel": "AHPHG-1-10-LINE", "A2TpId": "0", "OrderState": "2", "ConnectionShape": "simple", "A2TpUserLabel": null, "ConnectionCategory": "0", "Z2TpType": "0", "pm15MinuteCollectionType": "COLLECT", "A1NodeId": "23", "Z1NeName": "PSS32-41.37.179", "A2TpName": null, "SERVICESTATE": "Not In Service", "UserLabel": null, "LINKTYPE": "LEGACY", "Z1NodeName": "PSS32-41.37.179", "A1NodeName": "PSS32-41.37.180", "LATENCY": "0", "CustomerName": "None", "A1TpType": "0", "Z1TpUserLabel": null, "ALARMSTATUS": "Cleared", "pm24HourCollectionType": "COLLECT", "A1TpInterfaceName": "AHPHG-1-10-LINE", "ASONWTR": "60", "A2TpInterfaceName": null, "Z2NodeId": "0", "Z2NeName": null, "OPERATIONALSTATE": "Enabled", "ConnectionDirection": "CD_BID", "Z1TpName": "AHPHG-1-10-LINE" }, { "Z1TpId": "24", "A1TpDisplayLabel": "AHPHG-2-3-LINE", "Z1NeId": "43", "ALLPATHCOST": "20", "ConnectionRate": "30", "ALIAS": "PSS32-41.37.180/AHPHG-2-3-LINE-PSS32-41.37.179/AHPHG-2-7-LINE", "ImplSt": "ImplementationState_implemented", "OrderStackId": "28", "A2TpType": "0", "Z2TpInterfaceName": null, "ASONADMSTATE": "Not Applicable", "Z2NodeName": null, "OrderType": "2", "Z2NeId": "0", "Z2TpId": "0", "Z1NodeId": "3", "A2NodeName": null, "A1TpUserLabel": null, "Z2TpName": null, "A1NeName": "PSS32-41.37.180", "CREATIONTIME": "20180209074753.0Z", "ID": "71", "NPRID": "2", "Z2TpUserLabel": null, "Z2TpDisplayLabel": null, "A1NeId": "62", "A2NeName": null, "A1TpId": "29462", "A2TpDisplayLabel": null, "A2NodeId": "0", "Z1TpType": "0", "INEFFECTDATE": "20180209074754.0Z", "OrderId": "34", "NAME": "PSS32-41.37.180/AHPHG-2-3-LINE-PSS32-41.37.179/AHPHG-2-7-LINE", "A1TpName": "AHPHG-2-3-LINE", "A2NeId": "0", "NCID": "28", "signalType": "notMeaningful", "Z1TpInterfaceName": "AHPHG-2-7-LINE", "ConnectionState": "9", "Z1TpDisplayLabel": "AHPHG-2-7-LINE", "A2TpId": "0", "OrderState": "2", "ConnectionShape": "simple", "A2TpUserLabel": null, "ConnectionCategory": "0", "Z2TpType": "0", "pm15MinuteCollectionType": "COLLECT", "A1NodeId": "23", "Z1NeName": "PSS32-41.37.179", "A2TpName": null, "SERVICESTATE": "Not In Service", "UserLabel": null, "LINKTYPE": "LEGACY", "Z1NodeName": "PSS32-41.37.179", "A1NodeName": "PSS32-41.37.180", "LATENCY": "0", "CustomerName": "None", "A1TpType": "0", "Z1TpUserLabel": null, "ALARMSTATUS": "Cleared", "pm24HourCollectionType": "COLLECT", "A1TpInterfaceName": "AHPHG-2-3-LINE", "ASONWTR": "60", "A2TpInterfaceName": null, "Z2NodeId": "0", "Z2NeName": null, "OPERATIONALSTATE": "Enabled", "ConnectionDirection": "CD_BID", "Z1TpName": "AHPHG-2-7-LINE" }, { "Z1TpId": "74812", "A1TpDisplayLabel": "AHPLG-13-13-LINE", "Z1NeId": "43", "ALLPATHCOST": "20", "ConnectionRate": "30", "ALIAS": "ots_12", "ImplSt": "ImplementationState_implemented", "OrderStackId": "43", "A2TpType": "0", "Z2TpInterfaceName": null, "ASONADMSTATE": "Not Applicable", "Z2NodeName": null, "OrderType": "2", "Z2NeId": "0", "Z2TpId": "0", "Z1NodeId": "3", "A2NodeName": null, "A1TpUserLabel": null, "Z2TpName": null, "A1NeName": "PSS32-41.37.180", "CREATIONTIME": "20180214032608.0Z", "ID": "90", "NPRID": "21", "Z2TpUserLabel": null, "Z2TpDisplayLabel": null, "A1NeId": "62", "A2NeName": null, "A1TpId": "78051", "A2TpDisplayLabel": null, "A2NodeId": "0", "Z1TpType": "0", "INEFFECTDATE": "20180214032609.0Z", "OrderId": "65", "NAME": "ots_12", "A1TpName": "AHPLG-13-13-LINE", "A2NeId": "0", "NCID": "43", "signalType": "notMeaningful", "Z1TpInterfaceName": "AHPLG-3-14-LINE", "ConnectionState": "9", "Z1TpDisplayLabel": "AHPLG-3-14-LINE", "A2TpId": "0", "OrderState": "2", "ConnectionShape": "simple", "A2TpUserLabel": null, "ConnectionCategory": "0", "Z2TpType": "0", "pm15MinuteCollectionType": "COLLECT", "A1NodeId": "23", "Z1NeName": "PSS32-41.37.179", "A2TpName": null, "SERVICESTATE": "Not In Service", "UserLabel": null, "LINKTYPE": "LEGACY", "Z1NodeName": "PSS32-41.37.179", "A1NodeName": "PSS32-41.37.180", "LATENCY": "0", "CustomerName": "None", "A1TpType": "0", "Z1TpUserLabel": null, "ALARMSTATUS": "Cleared", "pm24HourCollectionType": "COLLECT", "A1TpInterfaceName": "AHPLG-13-13-LINE", "ASONWTR": "60", "A2TpInterfaceName": null, "Z2NodeId": "0", "Z2NeName": null, "OPERATIONALSTATE": "Enabled", "ConnectionDirection": "CD_BID", "Z1TpName": "AHPLG-3-14-LINE" } ] }
External Docs
See Also :
Nbi Topological Response
Name |
Type |
Description |
Enum |
---|---|---|---|
message | String string |
Topological Data | --- |
status | String string |
Status | --- |
topoData | array[Map«string,string»] Map«string,string» |
Topological Data | --- |