Api Change Log

Application Versions⇑

Changes between 24.6 to 25.12

What's New⇑

1. GET/tca/v1/alarm-profiles/{profileId} Get TCA Profile with Threshold configs
2. PUT/tca/v1/alarm-profiles/{profileId} Modifies TCA Profile
3. PUT/tca/v1/alarm-profiles-association/{type}/{profileId}/bulk Associate multiple NE, Card and Port to a tca profile
4. PUT/ptpclock/{neGroupId}/{neId}/{cardName}/ This method is used to modify the ptp clock parameters
5. PUT/data/otn/schedule/servicetest/reschedule/{jobDetailsId}/{jobName} description:Reschedule Service Testing job for specified 'jobDetailsId'
6. PUT/data/otn/mIntervals/updateInterval/{id} update Maintenance Interval Data
7. PUT/data/otn/commonscheduler/job/reschedule/{jobHandleId} description: reschedule common scheduler job from joblist for specified 'jobHandleId'
8. GET/tca/v1/alarm-profiles Get TCA Profiles
9. POST/tca/v1/alarm-profiles Creates TCA profile for Non Compliant and At Risk thresholds
10. POST/schedule/data/otn/ports/{id}/protectionSwitch Schedule protection switch operation on Protection Group from RD, schedule info specified in 'payload'.
11. POST/schedule/data/otn/ports/{id}/loopback Schedule loopback operation, schedule info specified in 'payload'.
12. POST/schedule/data/otn/connections/{id}/manage Schedule protection switch job, schedule info is specified in 'payload'.
13. POST/schedule/data/otn/connections/{id}/action Schedule change connection state schedule info specified in 'payload'.
14. POST/schedule/data/npr/asonSwitchs/{cointoIdList}/switchCmd Schedule ASON SNC protection switch job, schedule info is specified in 'payload'.
15. POST/pm/tcaProfiles/{tcaId} Modifies TCA Profile
16. DELETE/pm/tcaProfiles/{tcaId} Deletes TCA
17. GET/pm/tcaProfiles Lists all TCA Profiles
18. POST/pm/tcaProfiles Creates TCA profile
19. POST/data/otn/schedule/servicetest/schedule Schedule an Service Testing test at an immediate or specified time.
20. POST/data/otn/renameLabel Renaming of the label name.
21. POST/data/otn/notes/deleteAllNotes delete a new note
22. POST/data/otn/mIntervals/miAssociation create Maintenance Interval Association
23. POST/data/otn/mIntervals/miAssociation/{maintenanceIntervalId}/bulk Create maintenance interval associations for bulk entities for a maintenance interval id
24. POST/data/otn/mIntervals/miAssociation/delete/bulk delete maintenance interval associations in bulk for list of association ids
25. POST/data/otn/mIntervals/createInterval Create Maintenance Interval Data
26. POST/data/otn/mIntervals/createIntervalHistory/{intervalId}/objectType/{objectType} create Maintenance Interval History for the given maintenance interval id.
27. POST/data/otn/deleteLabel deletion of the label.
28. POST/data/otn/darkfibers/dcm/update/{dfIds} Update DCM flag for one or multiple dfId
29. POST/data/otn/darkfiber/dcm/update/{dfIds} Update DCM flag for one or multiple dfId
30. POST/data/otn/connections/unlockStatus to set lockstatus to unlocked for given testIds
31. POST/data/otn/connections/measurements/{measurementType}/CustomServiceTesting Returns the Custom service test results for a set of connection id(s) or connection name(s) or both. Service testing include bit rate error testing which simulates message data using either Pseudo Random Binary Sequence (PRBS) or Idle Test Signal depending on the configuration. When supported by the configuration, in addition to monitoring bit error rate, additional PM counters are also monitored during the bit rate error testing. When supported by the configuration latency measurements are performed after bit rate error testing. Note: connection inputs can be retrieved from the REST call ‘/data/otn/connections’.
32. POST/data/otn/connections/lockStatus to set lockstatus to locked for given testIds
33. POST/data/otn/connection/{id}/wlt2/protected/power/{direction} Retrieves power data for protected path of specific connection in specific direction
34. POST/data/otn/commonscheduler/bulk/schedule Schedule multiple common REST jobs for different connections/objects specified in 'bulkPayload'.
35. POST/data/npr/teLinks/realignLatency Bulk Realign Latency
36. POST/data/eml/NE/GRI/timeStamp Gets Last Modified Time of GRI Files
37. POST/emlnemgr/NE/GRI/timeStamp Gets Last Modified Time of GRI Files
38. POST/data/npr/trails/optimizeCurrentRouteCmd/{trailId} optimizeCurrentRouteCmd
39. POST/data/asonNBI/trails/optimizeCurrentRouteCmd/{trailId} optimizeCurrentRouteCmd
40. GET/tca/v1/alarm-profiles/configuration-params API to fetch TCA configuration parameters for different types of connections.
41. GET/tca/v1/alarm-profile-config/{entityId}/{entityType} Get TCA Config counter for entity id and entity type
42. GET/data/plat/usermgt/password-status/{username} Get password expiration status for a specific user
43. GET/data/otn/schedule/servicetest/joblist/{jobHandleId} To retrieve the Service Testing job data for the specified jobHandleId
44. GET/data/otn/mIntervals/progressOfMaintenanceInterval Get the progress of maintenance Interval
45. GET/data/otn/mIntervals/progressOfMaintenanceIntervalList Get the progress of maintenance Interval data for each object
46. GET/data/otn/mIntervals/maintenanceIntervals Get all the data related to Maintenance Interval Data
47. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/trail/{trailId} Get All Maintenance Interval and Maintenance Interval History Data for the network trail connection
48. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/shelf/{shelfId} Get All Maintenance Interval and Maintenance Interval History Data with respect to shelf
49. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/port/{portId} Get all Maintenance Interval and Maintenance Interval History Data with respect to the port
50. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/phyconn/{phyconnId} Get All Maintenance Interval and Maintenance Interval History Data for the network physical Connection
51. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/path/{pathId} Get All Maintenance Interval and Maintenance Interval History Data for the given network path
52. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/ne/{neId} Get all Maintenance Interval and Maintenance Interval History Data with respect to Network Element
53. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/card/{cardId} Get All Maintenance Interval and Maintenance Interval History Data with respect to network card
54. GET/data/otn/mIntervals/intervalDetails/{id} Get All Maintenance Interval Details for the given interval id
55. GET/data/otn/mIntervals/intervalAssociationDetails/{intervalId} Get All Interval Association Details for the given interval id
56. GET/data/otn/mIntervals/intervalAssociationDetails/{intervalId}/objectType/{objectType} Get All Interval Association Details for the given interval id and the object type
57. GET/data/otn/mIntervals/intervalAssociationDetails/objectType/{objectType} Get All Interval Association Details for the given object type and FDN Number
58. GET/data/otn/mIntervals/countOfMaintenanceInterval Get all the count of maintenance Interval for each object
59. GET/data/otn/mIntervals/cascade/ne/{neId} Get all the cascade connection details for Network Element
60. GET/data/otn/customExpertProfiles To retrieve all the Custom Expert Profiles
61. GET/data/otn/customExpertProfiles/{customExpertProfileId} To retrieve the particular custom profile id
62. GET/data/otn/customExpertProfiles/trails/{iProfileId} Retrieve the list of Tunnels created using the particular custom profile id.
63. GET/data/otn/customExpertProfiles/networkElements/{iProfileId} To retrieve Network Elements details based on the particular Custom Expert Profile Id
64. GET/data/otn/connections/{id}/wlt/{dir1}/{dir2}/{band} Retrieves the power details for all the physical ports involved for a given connection ID and particular AZ or ZA direction.
65. GET/data/otn/connection/customExpertProfiles/{id} To retrieve the list of custom expert profiles configured in the particular node
66. GET/data/otn/cardLists Get Card List
67. GET/data/eml/getPortPluggableData Gets the pluggable type and subtype for GX NEs
68. GET/data/npr/getPortPluggableData Gets the pluggable type and subtype for GX NEs
69. DELETE/tca/v1/alarm-profiles/{profileIds} Deletes TCA Profiles
70. DELETE/tca/v1/alarm-profiles-association/{type}/{entityIds}/bulk Un-Associate multiple NE, Card and Port from the tca profile
71. DELETE/data/plat/usermgt/deleteuser Used to Delete the User
72. DELETE/data/otn/schedule/servicetest/delete/{jobHandleId} description: delete Service Testing job from joblist for specified 'jobHandleId'
73. DELETE/data/otn/mIntervals/deleteIntervalAssociationByType/{objectType}/{id} delete Maintenance Interval Association by object type and entity id
74. DELETE/data/otn/mIntervals/deleteIntervalAssociation/{associationId} delete Maintenance Interval Association
75. DELETE/data/otn/mIntervals/deleteInterval/{id} delete Maintenance Interval Data
76. DELETE/data/otn/commonscheduler/job/delete/{jobHandleIds} description: delete common scheduler job from joblist for specified 'jobHandleIds'

What's Deleted⇑

1. PUT/ptpclock/{neGroupId}/{neId}/{cardName} This method is used to modify the ptp clock parameters
2. PUT/data/npr/trails/reversion/joblist/{jobDetailsId}/{jobName} description:Reschedule ASON reversion job for specified 'jobDetailsId'
3. PUT/data/asonNBI/trails/reversion/joblist/{jobDetailsId}/{jobName} description:Reschedule ASON reversion job for specified 'jobDetailsId'
4. PUT/data/npr/ports/reversion/joblist/{jobDetailsId}/{jobName} description:Reschedule ASON reversion job for specified 'jobDetailsId'
5. POST/pae/paeSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category} Create,Modify or DELETE the Protection Audit Entity for OPSOSM packs for VWM NE.
6. POST/data/npr/ports/{trailId}/switchCmd switchCmd
7. POST/data/npr/ports/{trailId}/modifyconstraints modify constraints
8. POST/ason/schedule/{trailId}/modifyconstraints modify constraints
9. POST/data/npr/ports/{trailId}/connectId/{connectId}/{mode} moveTraffic
10. POST/data/npr/ports/{trailId}/connectId/{connectId} moveTraffic
11. POST/data/npr/ports/{trailIds} commandTrail
12. POST/ason/schedule/{trailIds} commandTrail
13. POST/data/npr/ports/moveSNC/{trailId} moveSNC
14. POST/ason/schedule/moveSNC/{trailId} moveSNC
15. POST/ason/schedule modifyTrailAttributes
16. GET/swim/jobDetailsById/{jobId} Fetches Ne list per Job based on job id
17. GET/pae/paeGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category} Retrieves the Shelf and Card PAE Entity for 1830VWM.
18. GET/data/swim/upsert/data Fetches all the EmlGroup
19. 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
20. GET/data/swim/backupFiles/{neLabel}/ Fetches list or files for restoring
21. GET/data/swim/anaytics/softwareVersionStatus Fetch software version status.
22. GET/data/swim/anaytics/jobStatus Fetch job status.
23. GET/data/swim/anaytics/firmwareStatus Fetch firmware status.
24. GET/data/swim/anaytics/backupStatus/{period} Fetch NE Types
25. GET/data/swim/SnaInstances/{emlInstance} Fetches all the EmlGroup
26. GET/data/otn/otdrscan/sync/{neId} Get custom profiles from NE for a given ID.
27. GET/data/otn/sync/{neId} Get custom profiles from NE for a given ID.
28. GET/data/npr/ports/{trailId}/switchTab switchTab
29. GET/data/npr/ports/{trailId}/nominalRoute Trails
30. GET/data/npr/ports/{trailId}/nominalRoutecard Trails
31. GET/data/npr/ports/{trailId}/currentRoute Trails
32. GET/data/npr/ports/{trailId}/currentRoutecard Trails
33. GET/data/npr/ports/{trailId}/backupRoute Trails
34. GET/data/npr/ports/{trailId}/configuredBackupRoute Trails
35. GET/data/npr/ports/{trailId}/revBlockedSnc Trails
36. GET/data/npr/ports/{trailId}/pof Trails
37. GET/data/npr/ports/{trailId}/priorities Trails
38. GET/data/npr/ports/{trailId}/asonRoutingFailureInfo Trails
39. GET/data/npr/ports/{trailId}/routingConstraints Trails
40. GET/ason/schedule/{trailId}/nominalRoute Trails
41. GET/ason/schedule/{trailId}/nominalRoutecard Trails
42. GET/ason/schedule/{trailId}/currentRoute Trails
43. GET/ason/schedule/{trailId}/currentRoutecard Trails
44. GET/ason/schedule/{trailId}/backupRoute Trails
45. GET/ason/schedule/{trailId}/configuredBackupRoute Trails
46. GET/ason/schedule/{trailId}/revBlockedSnc Trails
47. GET/ason/schedule/{trailId}/pof Trails
48. GET/ason/schedule/{trailId}/priorities Trails
49. GET/ason/schedule/{trailId}/asonRoutingFailureInfo Trails
50. GET/ason/schedule/{trailId}/routingConstraints Trails
51. GET/data/npr/ports/{trailId}/linkAsonsSnc getLinkInAsonsSnc
52. GET/data/npr/trails/{portId}/invmuxports portInvmuxports
53. GET/ason/schedule/{portId}/invmuxports portInvmuxports
54. GET/data/npr/ports/pie pieAsonSnc
55. GET/data/npr/trails/joblist/{jobHandleId} get ASON reversion data job
56. GET/data/npr/ports/joblist/{jobHandleId} get ASON reversion data job
57. GET/data/npr/trails/isNeVersion14/{trailId} NeVersion
58. GET/data/asonNBI/trails/isNeVersion14/{trailId} NeVersion
59. GET/data/npr/ports/isNeVersion14/{trailId} NeVersion
60. GET/ason/schedule/isNeVersion14/{trailId} NeVersion
61. GET/data/npr/ports/getHistoricalRoutes/{trailOrConnId} Get stored previous routes of ASON SNC
62. GET/ason/schedule/getHistoricalRoutes/{trailOrConnId} Get stored previous routes of ASON SNC
63. GET/data/npr/ports/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes
64. GET/ason/schedule/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes
65. GET/data/npr/ports/alarmed/{probCause} Get Alarmed ASON SNCs
66. GET/ason/schedule/alarmed/{probCause} Get Alarmed ASON SNCs
67. DELETE/data/plat/usermgt/deleteuser/{id} Delete User
68. POST/data/npr/ports modifyTrailAttributes
69. GET/data/network/generateReport Generate Network Report
70. GET/data/otn/generateReport Generate Network Report
71. PUT/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
72. POST/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
73. DELETE/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
74. PATCH/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
75. HEAD/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection
76. OPTIONS/data/otn/otdrscaninfo/physicalconn/{physConnId} Scan information for the specified connection

What's Deprecated⇑

1. GET/data/npr/trails/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes (Deprecated)
2. GET/data/asonNBI/trails/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes (Deprecated)
3. POST/tcaProfiles Creates TCA profile
4. POST/tcaProfiles/{tcaId} Modifies TCA Profile
5. DELETE/tcaProfiles/{tcaId} Deletes TCA
6. GET/tcaProfiles/ Lists all TCA Profiles
7. GET/data/plat/status System Status of WS-NOC OTNE
8. GET/data/otn/labelsByObjectId This API is to retrieve all the labels associated with the given business object.
9. POST/data/otn/connection/{id}/wlt2/service/power/{direction} Retrieves power data for service/working path of a specific connection in specific direction
10. GET/data/otn/connection/{id}/wlt2/protected/power/{direction} Deprecated: Please use POST: /connection/{id}/wlt2/protected/power/{direction} to fetch power with Wlt2_Response layout data.

What's Changed⇑

1. PUT/eqm/setEqpAttr/{neGrpId}/{neId}/{cardType}

   • 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
2. GET/data/npr/ports This API is used to get all ports

   • Response

     • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the port, can be retrieved as IdClass from /data/npr/ports?guiLabel={userLabel} accessPortRole : AccessPortRole_notMeaningful alarmStatus : AlarmStatus of the port. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] boardType : Represents board type of the port. cardType : Represents card type. clonePortPresent : Represents clone port present or not.Possible values [ Boolean_false, Boolean_true] compModule : Represents computational module. consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] currentFrequency : Represents RX frequency of port. designatedPortMode : WdmTransMode_notMeaningful direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] displayLabel : Display label of the port. encoding : Possible values [ Encoding_notMeaningful,Encoding_nrz,Encoding_psbt,Encoding_dpsk,Encoding_pdpsk,Encoding_pdmbpsk,Encoding_pdmqpsk,Encoding_qam8,Encoding_qam16,Encoding_spqpsk,Encoding_pbsk,Encoding_qam16250g,Encoding_qam64,Encoding_qpskabs,Encoding_coherent ] ethInterfaceRate : Ethernet interface rate.Possible values [ EthInterfaceRate_ethFE,EthInterfaceRate_eth1GE,EthInterfaceRate_eth10GE,EthInterfaceRate_notMeaningful,EthInterfaceRate_eth40GE,EthInterfaceRate_eth100GE ] ethInterfaceType : Ethernet interface type.Possible values [ EthInterType_notApplicable,EthInterType_eth10BaseTFD,EthInterType_eth10BaseTHFD,EthInterType_eth100BaseTXFD,EthInterType_eth100BaseTXHD,EthInterType_eth100BaseFXFD,EthInterType_eth1000BaseSXFD,EthInterType_eth1000BaseLXFD,EthInterType_eth1000BaseTFD,EthInterType_eth1000BaseXFD,EthInterType_eth1000BaseCXFD,EthInterType_eth10GBaseLR,EthInterType_eth10GbaseER,EthInterType_eth10GBaseSR,EthInterType_eth10GBaseR ] fdnMapper : NC_n=*EML_101_SNA/NE_n=*1/PTPn=*SFD-41-1-9410/:PORT fecType : Possible values [ FecType_notMeaningful,FecType_nofec,FecType_sfec,FecType_efec,FecType_ufec,FecType_efec2,FecType_afec,FecType_sdfec,FecType_sdfec_g2,FecType_fec802_3bjFE,FecType_sdfec_acc ] frequency : Frequency of the port. internalEmlAid : Internal eml aid. involvedIn3R : Indicates port involved in 3R or not.Possible values [ Boolean_false, Boolean_true] involvedOnInternalCable : Indicates port involved in internal connection or not.Possible values [ Boolean_false, Boolean_true] involvedOnPhyConn : Indicates port involved in physical connection or not.Possible values [ Boolean_false, Boolean_true] neId : Unique Identifier of the network element [NE]. neLabel : Userlabel of the network element [NE]. networkInterfaceType : Network interface type.Possible values [ NetworkInterfaceType_notMeaningful,NetworkInterfaceType_uni,NetworkInterfaceType_nni ] operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otuSignalType : Represents the signal type of the port. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] physicalPortType : Represents physical port type.Possible values [ PortType_stm1,PortType_stm4,PortType_stm16,PortType_c4,PortType_c3,PortType_c12,PortType_c2,PortType_stm64,PortType_stm0,PortType_c345Mb,PortType_c3C12,PortType_c4Conf,PortType_c3Conf,PortType_c4C12Conf,PortType_c3C12Conf,PortType_c4conc4,PortType_c4conc16,PortType_c4conc64,PortType_ec1,PortType_oc3,PortType_oc12,PortType_oc48,PortType_oc192,PortType_ds3,PortType_sts1,PortType_sts3c,PortType_sts12c,PortType_sts48c,PortType_sts192c,PortType_c12HDSL,PortType_ethFast_rateAdapt,PortType_eth100Mb_transp,PortType_eth1Gb_rateAdapt,PortType_eth1Gb_transp,PortType_fddi,PortType_escon,PortType_digitalVideo,PortType_fiberChannel,PortType_isaPrea,PortType_isaPr,PortType_ethFeb6,PortType_ethFast_rateAdaptLCAS,PortType_eth1Gb_rateAdaptLCAS,PortType_isaPreaLCAS,PortType_ethFast_rateAdaptLCAS_GMII,PortType_eth10Gb_rateAdaptLCAS,PortType_digitalVideoBroadcasting,PortType_ethFast_rateAdaptEnabledLCAS,PortType_ethEvpl_rateAdapt,PortType_eth10Gb_MultiService,PortType_eth1GbGfpTransp,PortType_notMeaningful,PortType_fiberChannelGfpTransp,PortType_ethernet,PortType_eth10Gb_ES64,PortType_oc1,PortType_oc768,PortType_stm256,PortType_ethStm16TrunkPR,PortType_ethStm64TrunkPR,PortType_c11 ] portBitRate : Port bit rate. id : Unique identifier of the port. key : AllPortsUI/2165 className : Name of class for physical connection:AllPortsUI sdiRate : Possible values [ SdiRate_notApplicable,SdiRate_nominal,SdiRate_subrate ] technology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] uplink : Represents is card uplink.Possible values [ Boolean_false, Boolean_true] uploadSt : Indicates upload status.Possible values [ normal,uploading,notFound,wrong ] usedDir : Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] usedOnOtn : Represents port is used in OTN connection.Possible values [ Boolean_false, Boolean_true] guiLabel : Userlabel of the port. wdmClientSignalType : Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] wdmInterfaceType : Possible values [ WdmInterfaceType_blackAndWhite,WdmInterfaceType_coloredDense,WdmInterfaceType_coloredCoarse ] wdmPhysicalPortRate : Represents physical port rate. wdmPortType : Possible values [ WdmPortType_ops0,WdmPortType_ots,WdmPortType_otsReg ] wdmTransmissionMode : Possible values [ WdmTransMode_notMeaningful,WdmTransMode_crossRegen,WdmTransMode_addDrop,WdmTransMode_regen,WdmTransMode_addOnly,WdmTransMode_dropAndContinue,WdmTransMode_dropOnly,WdmTransMode_thru ] width : Represents width. ----------------------------------------------------------------------------------------------------
3. GET/ptpclock/{neGroupId}/{neId}/{cardName}/{portID}/portstats

   • Response

     • New response : [500]//Internal server error
     • Changed response : [200]//Successful response

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: (object -> string)

4. GET/ptpclock/{neGroupId}/{neId}/{cardName}/{portID}/portmod

   • Response

     • New response : [500]//Internal server error
     • Changed response : [200]//Successful response

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: (object -> string)

5. GET/ptpclock/{neGroupId}/{neId}/{cardName}/{nPorts}/portrefresh

   • Response

     • New response : [500]//Internal server error
     • Changed response : [200]//Successful response

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: (array -> string)

6. GET/ptpclock/{neGroupId}/{neId}/{cardName}/additionalinfo Retrieves all the scan params and additionalinfo for that specific card

   • Response

     • New response : [500]//Internal server error
     • Changed response : [200]//Successful response

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: (object -> string)

7. GET/ptpclock/{neGroupId}/{neId}/{cardJsonName}/{cardName}

   • Response

     • New response : [500]//Internal server error
     • Changed response : [200]//Successful response

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: (object -> string)

8. GET/otn/schedule/otdr/file/{fileName} Download specified OTDR SOR files by file name

   • Response

     • New response : [404]//SOR files not found
     • New response : [500]//Internal server error
     • New response : [400]//Invalid connection SOR file provided
     • Changed response : [200]//Successfully Downloaded the SOR files
9. GET/data/otn/otdr/file/{fileName} Download specified OTDR SOR files by file name

   • Response

     • New response : [404]//SOR files not found
     • New response : [500]//Internal server error
     • New response : [400]//Invalid connection SOR file provided
     • Changed response : [200]//Successfully Downloaded the SOR files
10. GET/data/otn/schedule/otdr/file/{fileName} Download specified OTDR SOR files by file name

    • Response

      • New response : [404]//SOR files not found
      • New response : [500]//Internal server error
      • New response : [400]//Invalid connection SOR file provided
      • Changed response : [200]//Successfully Downloaded the SOR files
11. GET/networkinventory/equipments Retrieves a list of equipment for Network Elements.

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request
      • Changed response : [200]//Retrieves a list of equipment for all the Network Elements.
12. GET/eqm/snmpTable/wavekey/out Access Log Retrieval from WaveKey out data for the ports.

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request
      • Changed response : [200]//Retrieves Wavekey OUT data for the given port from the NE.
        • New body: 'application/json'
        • Deleted body: '*/*'
13. GET/eqm/snmpTable/wavekey/in Access Log Retrieval from WaveKey in data for the ports.

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request
      • Changed response : [200]//Retrieves Wavekey IN data for the given port from the NE.
        • New body: 'application/json'
        • Deleted body: '*/*'
14. GET/eqm/snmpTable/unexpectedWtkey Access Log Retrieval from Unexpected WaveKey data for the ports.

    • Response

      • Changed response : [200]//OK
        • New body: 'application/json'
        • Deleted body: '*/*'
15. GET/eqm/snmpTable/targetPowerOffset/ingress

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request. If the payload data is incorrect
      • Changed response : [200]//Retrieves wavekey in data for the given port.
        • New body: 'application/json'
        • Deleted body: '*/*'
16. GET/eqm/snmpTable/targetPowerOffset/egress

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request. If the payload data is incorrect
      • Changed response : [200]//Retrieves wavekey out data for the port.
        • New body: 'application/json'
        • Deleted body: '*/*'
17. GET/eqm/snmpTable/perChannelTargetPowerOffset/ingress

    • Response

      • New response : [500]//Internal Server Error
      • New response : [400]//Bad Request
      • Changed response : [200]//Retrieves Per Channel Target Power Offset Ingress Data for the given port from the NE.
        • New body: 'application/json'
        • Deleted body: '*/*'
18. GET/eqm/snmpTable/perChannelTargetPowerOffset/egress Retrieve Per Channel Target Power Offset Egress Data.

    • Response

      • Changed response : [200]//OK
        • New body: 'application/json'
        • Deleted body: '*/*'
19. GET/eqm/otdr/portScan/{ptpName}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

20. GET/eqm/otdr/otdrPorts/{neName}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

21. GET/eqm/otdr/listFilesOfEML/{ptpName}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

22. GET/eqm/ne/xc/getNeOCS/{grpID}/{neID}/{retrieveFunction} Retrieves OCS NE level details and attributes for the Network Element.

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

23. GET/eqm/ne/getNeOCS/{grpID}/{neID}/{retrieveFunction} Retrieves OCS NE level details and attributes for the Network Element.

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

24. GET/eqm/ne/getNeIntOCS/{grpID}/{neID}/{retrieveIntFunction} Retrieves OCS NE level details and attributes.

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

25. GET/eqm/Tp/JsonCTP

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

26. GET/eqm/Tp/All/{neGroupId}/{neId}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

27. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

28. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

29. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}/{subSlot}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

30. GET/eqm/Tp/AdditionalInfo/{neGroupId}/{neId}/{ehName}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

31. GET/eqm/Ports/PortViewWavelite/{grpID}/{neID}/{sysDesc}/{omsPortAid}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

32. GET/eqm/Ports/PortViewEQMGUI/{grpID}/{neID}/{cardAid}/{omsPortAid}/{signalType}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

33. GET/eqm/Ports/PortView/{grpID}/{neID}/{cardAid}/{omsPortAid}/{signalType}

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

34. GET/eqm/Equipment/All/{grpID}/{neID}

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

35. GET/data/eml/All/{grpID}/{neID}

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

36. GET/emlnemgr/secureCheck/{emlID} Validate the presence of secure transaction functionality of OCS NE

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response
37. GET/data/eml/secureCheck/{emlID} Validate the presence of secure transaction functionality of OCS NE

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response
38. GET/emlnemgr/associations Obtain the cluster association information for a specified node or Network Element (NE)

    • Response

      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

39. GET/data/eml/associations Obtain the cluster association information for a specified node or Network Element (NE)

    • Response

      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

40. GET/emlnemgr/NE/{neGroupId_neId} Get detailed information about the Network Element(NE)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

41. GET/data/eml/NE/{neGroupId_neId} Get detailed information about the Network Element(NE)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

42. GET/emlnemgr/NE/AutoDiscovery/{neGroupId}_{neId} This function facilitates the identification of adjacent Network Elements (NEs)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

43. GET/data/eml/NE/AutoDiscovery/{neGroupId}_{neId} This function facilitates the identification of adjacent Network Elements (NEs)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

44. GET/emlnemgr/NE/AutoDiscovery/{neGroupId_neId_userLabel} This function facilitates the identification of adjacent Network Elements (NEs)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

45. GET/data/eml/NE/AutoDiscovery/{neGroupId_neId_userLabel} This function facilitates the identification of adjacent Network Elements (NEs)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

46. GET/emlnemgr/GENNELIST/{emlID} Generate a list of generic Network Elements (NEs) for a given Element Management Layer (EML)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

47. GET/data/eml/GENNELIST/{emlID} Generate a list of generic Network Elements (NEs) for a given Element Management Layer (EML)

    • Response

      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

48. GET/data/restnbi/{trailId}/currentRouteSwitchData Retrieves the current route along with the switch data information for a given connection id.

    • Response

      • Changed response : [200]//Retrieved current route switch data successfully
49. GET/data/plat/userprofile/groupstruct This provides list of ACD Groups and assigned ACDs

    • Response

      • Changed response : [200]//Obtained group and ACD structure successfully.
        • New body: 'application/json'
        • Deleted body: '*/*'
50. GET/data/plat/userprofile/acds Retrieve all Acd List

    • Response

      • Changed response : [200]//Obtained ACD list successfully.
        • New body: 'application/json'
        • Deleted body: '*/*'
51. GET/data/otn/physicalConns/{nprId}/otnConnectionId To get physical link connection Id for physical connection specified by nprId

    • Response

      • Changed response : [200]//Physical connection retrieved successfully
52. GET/data/otn/otdrscan/scanresult/physicalconn/{phyLinkId} Retrieve detailed scan results of a physical connection using the specified id.

    • Response

      • New response : [404]//OTDR scan details not found
      • New response : [400]//Invalid connection id supplied
      • New response : [500]//Internal server error
      • Changed response : [200]//Successfully retrieved OTDR scan result details
53. GET/data/otn/node/name Retrieves the node name for the given node id

    • Response

      • 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.
54. 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.
55. GET/data/otn/networkinventory/alltopologicalinks Retrieves a list of topological links which have been deployed in the user domain Network as well as cross domain objects.

    • Response

      • Changed response : [200]//OK
        • New body: 'application/json'
56. GET/data/otn/darkfiber/scanresult/{dfId} Retrieve detailed scan results of a dark fiber connection using the specified id.

    • Response

      • New response : [404]//Connection not found
      • New response : [400]//Invalid connection ID provided
      • New response : [500]//Internal server error
      • Changed response : [200]//Successful response

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> no schema)

57. GET/data/otn/connections/{id}/asonId

    • Response

      • Changed response : [200]//asonId retrieved successfully
58. GET/data/otn/connection/name Retrieves the connection name for the given connection id in the OTN context

    • Response

      • 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.
59. GET/data/otn/connection/id Retrieves the connection id for the given connection name in the OTN context

    • Response

      • 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.
60. GET/data/npr/trails/{trailId}/switchTab The API is used to switch between SNC and SCNP

    • Response

      • Changed response : [200]//OK
        • Deleted body: 'text/xml'
61. GET/data/npr/trails/{trailId}/nominalRoute The API retrieves the nominal route for the given trail

    • Parameters

      • Add carrierNumber in query//'carrierNumber' is a mandatory parameter for Inverse Multiplex connections,which can be of either 1 or 2

    • Response

      • Changed response : [200]//Response is list of route
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
62. GET/data/npr/trails/{trailId}/nominalRoutecard The API retrieves the nominal route card for the given trail

    • Parameters

      • Add carrierNumber in query//'carrierNumber' is a mandatory parameter for Inverse Multiplex connections,which can be of either 1 or 2

    • Response

      • Changed response : [200]//Response is list of NomRoute
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
63. GET/data/npr/trails/{trailId}/currentRoute The API retrieves the current route for the given trail

    • Parameters

      • Add carrierNumber in query//'carrierNumber' is a mandatory parameter for Inverse Multiplex connections,which can be of either 1 or 2

    • Response

      • Changed response : [200]//Response is list of route data
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
64. GET/data/npr/trails/{trailId}/currentRoutecard The API retrieves the current route card for the given trail

    • Parameters

      • Add carrierNumber in query//'carrierNumber' is a mandatory parameter for Inverse Multiplex connections,which can be of either 1 or 2

    • Response

      • Changed response : [200]//Response is list of route data
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
65. GET/data/npr/trails/{trailId}/backupRoute The API retrieves the backup route for the given trail

    • Response

      • Changed response : [200]//Response is list of route data
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
66. GET/data/npr/trails/{trailId}/configuredBackupRoute The API retrieves the configured backup route for the given trail

    • Response

      • Changed response : [200]//Response is list of route data
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
67. GET/data/npr/trails/{trailId}/revBlockedSnc The API retrieves reversion blocked SNC

    • Response

      • Changed response : [200]//Response is list of reversion blocked SNCs
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
68. GET/data/npr/trails/{trailId}/pof The API provides details about the point of failure in the nominal route

    • Response

      • Changed response : [200]//List of Point Of Failures (POF)
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
69. GET/data/npr/trails/{trailId}/priorities The API provides the inherited priorities of the given trail

    • Response

      • Changed response : [200]//List of inherited priorities
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
70. GET/data/npr/trails/{trailId}/asonRoutingFailureInfo The API provides the routing failure informations of the given trail

    • Response

      • Changed response : [200]//Response is list route failure info
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
71. GET/data/npr/trails/{trailId}/routingConstraints The API provides the routing constraints for the given trail

    • Response

      • Changed response : [200]//Response is list of routing constraints
        • New body: 'application/json'
        • Deleted body: 'application/json;charset=UTF-8'
72. GET/data/npr/trails/{trailId}/linkAsonsSnc The API retrieves the ASON SNC links for the given trail ID

    • Response

      • Changed response : [200]//Response is list of link ASON SNCs
        • Deleted body: 'text/xml'
73. GET/data/npr/trails/pie The API is used to get the ASON trail alarms pies analysis result

    • Response

      • Changed response : [200]//Pie analysis report contains- <br> Availability of the nominal route for the retrieved trails If there is any failure in the current route for the retrieved trails <br>Availability of the Backup route for the retrieved trails <br>Whether the current route is degraded or not <br>Restoration is enabled or disabled for the retrieved trails <br>Whether the retrieved trails or in Restored or normal state <br> The response contains the count and tag which can be Parameters Violation, Nominal Unavailable, Current Failure, Ready To Revert, Rerouted.
74. GET/data/npr/trails/getHistoricalRoutes/{trailOrConnId}

    • Parameters

      • Add sortAscending in query//To retrieve historical routes in ascending order, 'sortAscending' should be sent as true
      • Add csvResponse in query//To return the detailedRoute data in legacy CSV string format for backward compatibility, set to true (default). Set to false to receive the data as a JSON array.

    • Response

      • Changed response : [200]//Response is list of route data

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

75. GET/data/asonNBI/trails/getHistoricalRoutes/{trailOrConnId}

    • Parameters

      • Add sortAscending in query//To retrieve historical routes in ascending order, 'sortAscending' should be sent as true
      • Add csvResponse in query//To return the detailedRoute data in legacy CSV string format for backward compatibility, set to true (default). Set to false to receive the data as a JSON array.

    • Response

      • Changed response : [200]//Response is list of route data

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> string)

76. GET/data/npr/trails/alarmed/{probCause} The API retrieves ASON SNCs with alarms that match the given probable cause

    • Response

      • Changed response : [200]//Successfully retervie the list of alarms with the provided probable cause
        • Deleted body: 'text/xml'
77. GET/data/asonNBI/trails/alarmed/{probCause} The API retrieves ASON SNCs with alarms that match the given probable cause

    • Response

      • Changed response : [200]//Successfully retervie the list of alarms with the provided probable cause
        • Deleted body: 'text/xml'
78. GET/data/npr/threeRs/{npaid}/nodes Retrieve nodes for 3R creation in NPA.

    • Response

      • Changed response : [200]//Response is List of Nodes
        • New body: 'application/json'
        • Deleted body: '*/*'
79. GET/data/npr/threeRNodes/{npaid}/nodes Retrieve nodes for 3R creation in NPA.

    • Response

      • Changed response : [200]//Response is List of Nodes
        • New body: 'application/json'
        • Deleted body: '*/*'
80. GET/data/otn/threeRs/{npaid}/nodes Retrieve nodes for 3R creation in NPA.

    • Response

      • Changed response : [200]//Response is List of Nodes
        • New body: 'application/json'
        • Deleted body: '*/*'
81. GET/data/npr/slte/{physicalConnId} Retrieves all the repeaters associated to physical connection for given connection id

    • Response

      • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Identifier for the class of the associated repeaters. connectId : Unique indentifier of the connection. direction : Direction of the port.Possible values are: Direction_bidirectional,Direction_sink,Direction_source,Direction_notMeaningful and Direction_unidirectional. id : Unique identifier of the AssocSlte. key : Reference key for tracking. Possible value is AssocSlte/2 className : Class designation of the NE. nodeId : Unique identifier of the Transmitter/Receiver node. nodeType : Type of Transmitter/Receiver node. prtUserLabel : User label of the prot which involved in the connection.n slteUserLabel : UserLabel of Associated Repeater. --------------------------------------------------------------------------------------------------
82. GET/data/asonNBI/slte/{physicalConnId} Retrieves all the repeaters associated to physical connection for given connection id

    • Response

      • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Identifier for the class of the associated repeaters. connectId : Unique indentifier of the connection. direction : Direction of the port.Possible values are: Direction_bidirectional,Direction_sink,Direction_source,Direction_notMeaningful and Direction_unidirectional. id : Unique identifier of the AssocSlte. key : Reference key for tracking. Possible value is AssocSlte/2 className : Class designation of the NE. nodeId : Unique identifier of the Transmitter/Receiver node. nodeType : Type of Transmitter/Receiver node. prtUserLabel : User label of the prot which involved in the connection.n slteUserLabel : UserLabel of Associated Repeater. --------------------------------------------------------------------------------------------------
83. GET/data/npr/reversionGroups/detail/{groupId} Retrieves the details of a specific reversion group

    • Response

      • Changed response : [200]//The response contains the details of the 2 SNCs used to create the Reversion Group
        • New body: 'application/json'
        • Deleted body: '*/*'
84. GET/ason/schedule/reversionGroups/detail/{groupId} Retrieves the details of a specific reversion group

    • Response

      • Changed response : [200]//The response contains the details of the 2 SNCs used to create the Reversion Group
        • New body: 'application/json'
        • Deleted body: '*/*'
85. GET/data/npr/physicalConns/{id}/physicalConnsList Retrieve physical connections associated with dark fiber.

    • Parameters

      • Add operationalState in query//operationalState is a field from '/data/otn/darkfiber'
      • Add wdmConnectionType in query//wdmConnectionType is a field from '/data/otn/darkfiber'
      • Add guiLabel in query//guiLabel is an entity from '/data/otn/darkfiber'
      • Add labelName in query//labelName is an entity from '/data/otn/darkfiber'
      • Add shape in query//shape is an entity from '/data/otn/darkfiber'
      • Add implSt in query//implSt is an entity from '/data/otn/darkfiber'
      • Add wrkSt in query//wrkSt is an entity from '/data/otn/otdr'
      • Add aPortLabel in query//aPortLabel is an entity from '/data/otn/darkfiber'
      • Add zPortLabel in query//zPortLabel is an entity from '/data/otn/darkfiber'
      • Add linkUtilProfileName in query//linkUtilProfileName is an entity from '/data/otn/darkfiber'
      • Add allPathCost in query//allPathCost is an entity from '/data/otn/darkfiber'

    • Response

      • New response : [404]//Connection not found
      • New response : [400]//Invalid connection ID provided
      • New response : [500]//Internal server error
      • Changed response : [200]//Successfully retrieved physical connections associated with dark fiber

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (string -> no schema)

86. GET/data/npr/physicalConns/{id}/darkfiber Retrieve a list of eligible dark fiber connections.

    • Response

      • New response : [404]//Connection not found
      • New response : [400]//Invalid connection ID provided
      • New response : [500]//Internal server error
      • Changed response : [200]//Successfully retrieved a list of eligible dark fiber connection

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> no schema)

87. GET/data/npr/physicalConns/{connectId}/fiberCharacteristic Used to get fiber characteristic associated to physical connection for given connectId

    • Response

      • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the fiber characteristics, can be retrieved as IdClass from /data/npr/FiberChar?id={id} bandStr : Represents band of the connection. baselineSpanLoss : Represents base line span loss. calcSpanLoss : Indicates calucated span loss. commSpanLoss : comm span loss value. connectId : Unique indentifier of the connection. egressPowerOut : Indicates egress power out. fiberLength : Indicates fiber length. fiberLengthSource : Indicates fiber length of source. fiberType : Indicates type of the fiber. Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] fromLabel : Represents 'from' end port label. gainStr : Represents gain. id : Unique identifier of fiber characteristics. key : FiberChar/96 className : Name of the class : FiberChar ingGainStr : Indicates in gain. ingMaxGainStr : Indicates maximum in gain. ingMinGainStr : Indicates minimum in gain. ingressPowerIn : Indicates ingress power in. maxGainStr : Indicates maximum gain. maxSpanLoss : Indicates maximum span loss. minGainStr : Indicates minimum gain. minSpanLoss : Indicates minimum span loss. portId : Unique identifier of the port. ramanGainStr : Indicates raman amplifier gain. spanLoss : Indicates span loss. targetGainStr : Indicates target gain. toLabel : Represents 'to' end port label. otdrSpanLossStr : Represents otdr span loss. otdrSpanLossDate : Represents otdr span loss occurred date. fiberLatency : Represents fiber latency. ------------------------------------------------
88. GET/data/asonNBI/physicalConns/{connectId}/fiberCharacteristic Used to get fiber characteristic associated to physical connection for given connectId

    • Response

      • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the fiber characteristics, can be retrieved as IdClass from /data/npr/FiberChar?id={id} bandStr : Represents band of the connection. baselineSpanLoss : Represents base line span loss. calcSpanLoss : Indicates calucated span loss. commSpanLoss : comm span loss value. connectId : Unique indentifier of the connection. egressPowerOut : Indicates egress power out. fiberLength : Indicates fiber length. fiberLengthSource : Indicates fiber length of source. fiberType : Indicates type of the fiber. Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] fromLabel : Represents 'from' end port label. gainStr : Represents gain. id : Unique identifier of fiber characteristics. key : FiberChar/96 className : Name of the class : FiberChar ingGainStr : Indicates in gain. ingMaxGainStr : Indicates maximum in gain. ingMinGainStr : Indicates minimum in gain. ingressPowerIn : Indicates ingress power in. maxGainStr : Indicates maximum gain. maxSpanLoss : Indicates maximum span loss. minGainStr : Indicates minimum gain. minSpanLoss : Indicates minimum span loss. portId : Unique identifier of the port. ramanGainStr : Indicates raman amplifier gain. spanLoss : Indicates span loss. targetGainStr : Indicates target gain. toLabel : Represents 'to' end port label. otdrSpanLossStr : Represents otdr span loss. otdrSpanLossDate : Represents otdr span loss occurred date. fiberLatency : Represents fiber latency. ------------------------------------------------
89. GET/data/npr/physicalConns/pie Shows alarmed physical connections in the form of pie chart

    • Response

      • Changed response : [200]//Response is json with count and tag value. count : Indicates total number of connections with particular tag. tag : Indicates alarm name. Possible values [ Power Failure,Underlying Resource Unavailable,APR Line,Media Failure,APR Unavailable,Degraded Transmission,Equipment Failure,Transport Failure,Loss of Payload,OSC Failure,Not alarmed,ExBer,Ason TElink Failure,Loss Of Tones,Optical Channel Monitoring Issue,Protection Active,Configuration Mismatch, Gain Out Of Planned Range,Optical Intrusion,Optical Intrusion Monitoring Suspended,Optical Power Out of Range,Quality Threshold Crossed 15m,Quality Threshold Crossed 24h,Failure On Repeater SA,Failure On Repeater NSA,Temperature Problem,Unprovisioned Channels,Failed To Align Consistency Status,Not Aligned Consistency Status,Tandem Connection Failure ] ----------------------------------------
90. GET/data/npr/npas/{ids}/{table2}/{ids2} Retrive details of second entity associated with NPA

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of LinkAson. alarmSyntesis: Status indicating active reportable critical alarms. asonCtrPlaneType: Type of control plane for Ason (OCS and PHN). cTAccessStatus: Status indicating CT access is enabled. comment1: User-defined string (max 24 characters). comment2: User-defined string (max 24 characters). communicationState: Current communication state. ethPresent: Indicates if Ethernet is present. hierarchySubnet: Hierarchy subnet. isMultiNEs: Indicates if multiple NE instances exist. localization: Localization information. masterNeId: ID of the master network element. latitude: Latitude of the site. longitude: Longitude of the site. altitude: Altitude of the site. mibAlignmentState: MIB alignment state. neAlignment: Network element alignment status. neSubType: Subtype of the network element. key: Identifier for the resource. loopbackIp: Loopback IP address. secondaryAddress: Secondary address. className: Name of the class for physical connection. otnConfDownldSt: OTN configuration download status. parentId: ID of the parent resource. parentLabel: Label for the parent resource. position: 3D position coordinates. sdhPresent: Indicates if SDH is present. supervisionState: Current supervision state. guiLabel: Name of the LinkAson for GUI display. version: Software version. wdmPresent: Indicates if WDM is present. confDownldSt: Configuration download status. nadString: Default unknown value. productName: Product name. reachable: Indicates if the resource is reachable. shortProductName: Short name for the product. siteName: Name of the site. nodeType: Type of node. emlNeType: Type of network element. comment3: Additional user-defined comment. associationPresent: Indicates if association is present. neSubRelease: Sub-release version of the network element. associatedPtnNeId: ID of associated PTN network element. comments: General comments. actualRelease: Actual software release version. auditStatus: Audit status. configNeStatus: Configuration status of the network element. newCommunicationState: New communication state. newSupervisionState: New supervision state. alignmentState: Current alignment state. creationDate: Timestamp of resource creation. modifiedDate: Timestamp of last modification. nodeModifiedDate: Timestamp of the node last modification. createdBy: User who created the resource. modifiedBy: User who last modified the resource. latestNote: Most recent note. scheduledForGri: GRI scheduling status. systemAbnormalState: Indicates if the system is in an abnormal state. systemMode: Current mode of the system.
91. GET/data/npr/linkAsons/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason links

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. phyConnType : Type of physical connection (e.g., WDM). a2PortLabel : Label for the port at the second end connection (A2). aNodeId : Identifier for the node at the first end connection (A). aPortLabel : Label for the port at the first end connection. alarmStatus : Status of alarms associated with the connection. allPathCost : Total cost associated with all paths. asonAdmState : Administrative state of the connection. asonAutoRestoration : Status of automatic restoration settings. asonWTR : Wait-to-Restore time setting. category : Category of the connection (e.g., terminal tunnel). colorProfileId : Identifier for the color profile used. colorProfileName : Name of the color profile used. colorString : String representation of the color profile. id : Unique identifier for the connection resource. key : Key for accessing the connection resource. className : Name of the class associated with the connection. defTime : Default time setting for the connection. implSt : Implementation state of the connection. infrastructure : Type of infrastructure used (e.g., LINK). latency : Latency associated with the connection. linkType : Type of link (e.g., NNI). npaId : Identifier for the Network Point of Access. otnMapper : Identifier for the OTN mapper. otuSignalType : Type of OTU signal (e.g., OTSIG Tunnel). srgPresent : Status indicating presence of SRG. teLinkId : Identifier for the TE link. teLinkName : Name of the TE link. threerResource : Resource indication related to 3R. tunnelTrailId : Identifier for the tunnel trail. guiLabel : User-friendly label for display purposes. wrkSt : Working state of the connection. z2PortLabel : Label for the port at the second end connection (Z2). zNodeId : Identifier for the node at the second end connection (Z). zPortLabel : Label for the port at the second end connection (Z). frequencyNumber : Frequency setting associated with the connection. flexGridSupport : Status of flex grid support for the connection. band : Band identification for the connection. interShelf : Status of inter-shelf connection. tcmDefectRaisingTime : Time setting for raising TCM defects. sharedLink : Status of shared link settings. otnLatency : OTN latency associated with the connection. remoteNpaId : Identifier for the remote NPA (if applicable). remoteNpaUserLabel : User-defined label for the remote NPA.
92. GET/data/npr/trails/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason trails

    • Response

      • Changed response : [200]//Response is ason data Additional info: The response contains the response status and HTTP URL where the data can be accessed. Idclass: Represents the class ID of AsonControlPlane. a2EndClSlotNum : Indicates the slot number for the second end connection (A2). a2EndPortId : Identifier for the port at the second end connection. a2EndPortLabel : Label for the port at the second end connection. a2EndTS : Time slot identifier for the second end connection. a2EndTSGran : Granularity level of the time slot for the second end connection. aEndClSlotNum : Slot number for the first end connection (A). aEndPortId : Identifier for the port at the first end connection. aEndPortLabel : Label for the port at the first end connection. confSoftRevSncpMode : Configuration for the soft revertive SNCP mode. confSoftRevSncpTimeout : Timeout setting for the soft revertive SNCP. usedSoftRevSncpMode : Actual used soft revertive SNCP mode. usedSoftRevSncpTimeout : Timeout setting for the used soft revertive SNCP. backupRoute : Indicates whether a backup route is available. aEndTS : Time slot identifier for the first end connection. aEndTSGran : Granularity level of the time slot for the first end connection. aWdmFrequency : Frequency setting for WDM (Wavelength Division Multiplexing). alarmStatus : Status of alarms associated with the connection. asapName : Name of the ASAP (Any Service Access Point). asonProtection : Type of protection applied to the connection. backupSt : Status of the backup route. clientDependency : Indicates dependencies related to client ports. confSt : Configuration state of the connection. defaultPriority : Default priority level assigned to the connection. defaultRerouting : Default rerouting mode for the connection. defaultReversionMode : Default mode for reversion. defaultSetupPriority : Default setup priority for the connection. disjointedSt : Status indicating whether the paths are disjointed. endToEndOtnTrailId : Identifier for the end-to-end OTN trail. endToEndOtnTrailLabel : Label for the end-to-end OTN trail. excludeAnyColorId : Identifier for excluded color profiles. excludeAnyColorName : Name of the excluded color profile. excludeAnyColorString : String representation of the excluded color profile. gmreLabel : Label for GMRE (Generalized Multi-Rate Ethernet) service. includeAnyColorId : Identifier for included color profiles. includeAnyColorName : Name of the included color profile. includeAnyColorString : String representation of the included color profile. maxLatency : Maximum latency allowed for the connection. pathAlarmMoveMaxAttempt : Maximum attempts for moving path alarms. pathAlarmMoveHoldOffTime : Hold-off time for moving path alarms. nativeName : Native name representation for the connection. nodeId : Identifier for the associated node. npaId : Identifier for the NPA (Network Point of Access). npaLabel : Label for the NPA. operationalState : Current operational state of the connection. priority : Assigned priority level for the connection. protType : Protection type for the connection. protectionGroup : Identifier for the protection group. rerouting : Rerouting mode in effect. reversionBlockedSt : Status indicating whether reversion is blocked. reversionMode : Mode for reversion. reversionSt : Status of reversion readiness. routingSt : Current state of routing. sbnConnShape : Connection shape type. serviceState : Current state of the service. setupPriority : Priority level for setting up the connection. sncId : Identifier for the subnetwork connection. sncType : Type of the subnetwork connection. sncSwitchSt : Status of SNCP switch. tSlotGranularity : Granularity of the time slot. testMode : Current mode of testing for SNCP. consistSt : Consistency status of the connection. id : Unique identifier for the trail. key : Key for accessing the trail resource. className : Name of the class associated with the connection. trailWrkSt : Working state of the trail. transportNtw : Type of transport network. tunnelType : Type of tunnel associated with the connection. guiLabel : User-friendly label for display purposes. waitForServerRestoration : Indicates whether to wait for server restoration. wdmTrailLayer : Layer information for WDM trail. z2EndClSlotNum : Slot number for the second end connection (Z2). z2EndPortId : Identifier for the port at the second end connection (Z2). z2EndPortLabel : Label for the port at the second end connection (Z2). z2EndTS : Time slot identifier for the second end connection (Z2). z2EndTSGran : Granularity level of the time slot for the second end connection (Z2). zEndClSlotNum : Slot number for the end connection (Z). zEndPortId : Identifier for the port at the end connection (Z). zEndPortLabel : Label for the port at the end connection (Z). zEndTS : Time slot identifier for the end connection (Z). zEndTSGran : Granularity level of the time slot for the end connection (Z). nadString : Default value for unknown associations. diversityMode : Mode of diversity for connections. groupName : Name of the group associated with the connection. maxRestorationAttempts : Maximum attempts for restoration. maxSpareRestorationAttempts : Maximum attempts for spare restoration. asecontrolMode : Control mode for ASE . aseholdOffTimer : Hold-off timer setting for ASE. disableGmreOpticalFeasibility : Setting for GMRE optical feasibility. autoReversionWithSRGViolation : Auto-reversion setting in case of SRG violation. ui_sncpLegDiversity : User interface representation of SNCP leg diversity. sncpHOT : Hot standby configuration for SNCP. ui_sncpHOT : User interface representation of SNCP hot standby. electricalLayerContribution : Contribution of the electrical layer. otsigProtection : Protection setting for OTSIG (Optical Transport Signal). otsigExccb : Setting for OTSIG EXCCB (External Control Circuit Block). otsigPfClear : Clear setting for OTSIG protection flags. otsigPfSet : Set value for OTSIG protection flags. burstInterval : Interval for burst configurations. burstPeriod : Period for burst configurations. burstThreshold : Threshold for burst configurations. ui_maxRestorationAttempts : User interface representation of maximum restoration attempts. ui_maxSpareRestorationAttempts : User interface representation of maximum spare restoration attempts. sncpLegDiversity : Diversity mode for SNCP legs.
93. GET/data/npr/sbnConnEnds/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason end points

    • Response

      • Changed response : [200]//Response is ason data Additional info: IdClass: Represents the unique identifier for the class type. clSlotNum: Indicates the slot number assigned to the client. currentFrequency: Specifies the current frequency in use, if applicable. endType: Defines the connection endpoint type, such as endA or endB. nodeId: Refers to the unique identifier of the node. nodeUserLabel: Provides a user-friendly label or name for the node. nominalFrequency: Specifies the nominal operating frequency. portLabel: Displays the label of the port in use. resType: Defines the resource type, e.g., main or auxiliary. id: Unique identifier for the entity. key: Represents a unique key for referencing this object. className: Specifies the class name associated with this entity. tSGran: Indicates the granularity of the timeslot. timeSlots: Specifies the timeslots assigned to the connection. trailId: Refers to the unique identifier of the trail associated with this connection.
94. GET/data/npr/threeRs/{ids}/{table2}/{ids2} Retrive details of second entity associated with threeR

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aLocalPortId : Identifier for the local port at the first end connection (A). aMuxPrtLabel : Label for the multiplexer port at the first end connection. aRemotePortId : Identifier for the remote port at the first end connection. aTrPrtLabel : Label for the transport port at the first end connection. asonSncLabel : Label for the associated SNC (Subnetwork Connection) if applicable. belongTrailId : Identifier for the trail to which the connection belongs. confSt : Configuration state of the connection. endToEndOtnTrailId : Identifier for the end-to-end OTN trail. endToEndOtnTrailLabel : Label for the end-to-end OTN trail. nodeId : Identifier for the associated node. npaId : Identifier for the Network Point of Access. npaLabel : Label for the NPA. systemLabel : System-defined label for the connection. id : Unique identifier for the connection resource. key : Key for accessing the connection resource. className : Name of the class associated with the connection. zLocalPortId : Identifier for the local port at the second end connection (Z). zMuxPrtLabel : Label for the multiplexer port at the second end connection. zRemotePortId : Identifier for the remote port at the second end connection. zTrPrtLabel : Label for the transport port at the second end connection. usageIndicator : Indicates the usage status of the connection. profileId : Identifier for the associated profile. otuStruct : Structure of the OTU (Optical Transport Unit) associated with the connection. otsigAsonRegenDynamic : Indicates the dynamic regeneration setting for OTSIG ASON. aMuxNeLabel : Label for the multiplexer network element at the first end connection. zMuxNeLabel : Label for the multiplexer network element at the second end connection.
95. GET/data/npr/teLinks/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason telink

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aSite : To add the head site. srgComment : SRG Comment. id : Represents the unique AsonControlPlane ID key : SharedRiskGroup/id className: Name of the class for physical connection. srgProbability : Represents the probability of risk which can be SrgProb_high, SrgProb_low, SrgProb_medium, SrgProb_undefined,SrgProb_veryHigh,SrgProb_veryLow. srgType : Represents risk type which can be SrgType_cable, SrgType_conduit, SrgType_node, SrgType_other, SrgType_rightOfWay, SrgType_phyConn. guiLabel : Represents name of the SRG to be created. zSite :To add the tail site.
96. GET/data/npr/sharedRiskGroups/{ids}/{table2}/{ids2} Retrive details of second entity associated with shared risk groups

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aSite : To add the head site. srgComment : SRG Comment. id : Represents the unique ID key : SharedRiskGroup/id +srgProbability : Represents the probability of risk which can be SrgProb_high, SrgProb_low, SrgProb_medium, SrgProb_undefined,SrgProb_veryHigh,SrgProb_veryLow. srgType : Represents risk type which can be SrgType_cable, SrgType_conduit, SrgType_node, SrgType_other, SrgType_rightOfWay, SrgType_phyConn. guiLabel : Represents name of the SRG to be created. zSite :To add the tail site.
97. GET/data/npr/asonControlPlanes/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason control planes

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. masterNeId : Identifier for the master network element. associatedNodeId : Identifier for the associated node. alarmStatus : Status of alarms associated with the connection. alrAligned : Indicates if alignment for the alarm is set. alrAlignment : Status of alarm alignment. asonCtrPlaneType : Type of ASON control plane used. assignSt : Current assignment state of the control plane. automaticRestoration : Status of automatic restoration settings. consistSt : Consistency status of the control plane. id : Unique identifier for the control plane resource. key : Key for accessing the control plane resource. priority : Assigned priority level for the control plane. className : Name of the class associated with the control plane. controlPlaneType : Type of control plane (e.g., ASON). emsFactoryAddress : Address of the EMS factory (if applicable). fastPhotonicRestoration : Status of fast photonic restoration settings. installedVersion : Version of the installed control plane. ipAddress : IP address associated with the control plane. migrationState : State of migration for the control plane. nativeName : Native name representation for the control plane. npaId : Identifier for the Network Point of Access (if applicable). reachable : Status indicating the reachability of the control plane. scModificationDate : Date of last modification for the control plane. scModifiedByCP : Indicates if the control plane was modified by a control plane. guiLabel : User-friendly label for display purposes. version : Version of the control plane. syncStatus : Status of synchronization for the control plane. softRevertiveSncpModeL0 : Soft revertive SNCP mode for layer 0. softRevertiveSncpModeL1 : Soft revertive SNCP mode for layer 1. ospfAreaId : Area Id associated to each CP node. cpNodeId : Colocated node address of GMPLS node which is unique. notifyIpAddress : IP Address used to send RSVP notiications which summarizes all alarm info to one address. subNodeList : List of network-wide unique data plane node ids . softRevSncpTimeoutL0 : Timeout setting for soft revertive SNCP for layer 0. softRevSncpTimeoutL1 : Timeout setting for soft revertive SNCP for layer 1.
98. GET/data/npr/colorProfiles/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason color profiles

    • Response

      • Changed response : [200]//Response is ason data Additional info: IdClass : class id of colorProfile, can be retrieved as IdClass from /data/npr/colorProfiles?guiLabel={userLabel}. id : Unique identifier of response. key : Unique colorProfile key, can be retrieved as key from /data/npr/colorProfiles?guiLabel={userLabel}. className : ClassName of a colorProfile, can be retrieved as className from /data/npr/colorProfiles?guiLabel={userLabel}. colorString : colorString of a colorProfile, can be retrieved as colorString from /data/npr/colorProfiles?guiLabel={userLabel} . colors : colors of a colorProfile, can be retrieved as colors from /data/npr/colorProfiles?guiLabel={userLabel} . comment1 : User comment 1 added for colorProfile, can be retrieved as comment1 from /data/npr/colorProfiles?guiLabel={userLabel}. owner : owner for colorProfile, can be retrieved as owner from /data/npr/colorProfiles?guiLabel={userLabel}. guiLabel : GUI Label of a colorProfile, can be retrieved as guiLabel from /data/npr/colorProfiles?guiLabel={userLabel}.
99. GET/data/asonNBI/npas/{ids}/{table2}/{ids2} Retrive details of second entity associated with NPA

    • Response

      • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of LinkAson. alarmSyntesis: Status indicating active reportable critical alarms. asonCtrPlaneType: Type of control plane for Ason (OCS and PHN). cTAccessStatus: Status indicating CT access is enabled. comment1: User-defined string (max 24 characters). comment2: User-defined string (max 24 characters). communicationState: Current communication state. ethPresent: Indicates if Ethernet is present. hierarchySubnet: Hierarchy subnet. isMultiNEs: Indicates if multiple NE instances exist. localization: Localization information. masterNeId: ID of the master network element. latitude: Latitude of the site. longitude: Longitude of the site. altitude: Altitude of the site. mibAlignmentState: MIB alignment state. neAlignment: Network element alignment status. neSubType: Subtype of the network element. key: Identifier for the resource. loopbackIp: Loopback IP address. secondaryAddress: Secondary address. className: Name of the class for physical connection. otnConfDownldSt: OTN configuration download status. parentId: ID of the parent resource. parentLabel: Label for the parent resource. position: 3D position coordinates. sdhPresent: Indicates if SDH is present. supervisionState: Current supervision state. guiLabel: Name of the LinkAson for GUI display. version: Software version. wdmPresent: Indicates if WDM is present. confDownldSt: Configuration download status. nadString: Default unknown value. productName: Product name. reachable: Indicates if the resource is reachable. shortProductName: Short name for the product. siteName: Name of the site. nodeType: Type of node. emlNeType: Type of network element. comment3: Additional user-defined comment. associationPresent: Indicates if association is present. neSubRelease: Sub-release version of the network element. associatedPtnNeId: ID of associated PTN network element. comments: General comments. actualRelease: Actual software release version. auditStatus: Audit status. configNeStatus: Configuration status of the network element. newCommunicationState: New communication state. newSupervisionState: New supervision state. alignmentState: Current alignment state. creationDate: Timestamp of resource creation. modifiedDate: Timestamp of last modification. nodeModifiedDate: Timestamp of the node last modification. createdBy: User who created the resource. modifiedBy: User who last modified the resource. latestNote: Most recent note. scheduledForGri: GRI scheduling status. systemAbnormalState: Indicates if the system is in an abnormal state. systemMode: Current mode of the system.
100. GET/data/asonNBI/linkAsons/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason links

     • Response

       • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. phyConnType : Type of physical connection (e.g., WDM). a2PortLabel : Label for the port at the second end connection (A2). aNodeId : Identifier for the node at the first end connection (A). aPortLabel : Label for the port at the first end connection. alarmStatus : Status of alarms associated with the connection. allPathCost : Total cost associated with all paths. asonAdmState : Administrative state of the connection. asonAutoRestoration : Status of automatic restoration settings. asonWTR : Wait-to-Restore time setting. category : Category of the connection (e.g., terminal tunnel). colorProfileId : Identifier for the color profile used. colorProfileName : Name of the color profile used. colorString : String representation of the color profile. id : Unique identifier for the connection resource. key : Key for accessing the connection resource. className : Name of the class associated with the connection. defTime : Default time setting for the connection. implSt : Implementation state of the connection. infrastructure : Type of infrastructure used (e.g., LINK). latency : Latency associated with the connection. linkType : Type of link (e.g., NNI). npaId : Identifier for the Network Point of Access. otnMapper : Identifier for the OTN mapper. otuSignalType : Type of OTU signal (e.g., OTSIG Tunnel). srgPresent : Status indicating presence of SRG. teLinkId : Identifier for the TE link. teLinkName : Name of the TE link. threerResource : Resource indication related to 3R. tunnelTrailId : Identifier for the tunnel trail. guiLabel : User-friendly label for display purposes. wrkSt : Working state of the connection. z2PortLabel : Label for the port at the second end connection (Z2). zNodeId : Identifier for the node at the second end connection (Z). zPortLabel : Label for the port at the second end connection (Z). frequencyNumber : Frequency setting associated with the connection. flexGridSupport : Status of flex grid support for the connection. band : Band identification for the connection. interShelf : Status of inter-shelf connection. tcmDefectRaisingTime : Time setting for raising TCM defects. sharedLink : Status of shared link settings. otnLatency : OTN latency associated with the connection. remoteNpaId : Identifier for the remote NPA (if applicable). remoteNpaUserLabel : User-defined label for the remote NPA.
101. GET/data/asonNBI/trails/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason trails

     • Response

       • Changed response : [200]//Response is ason data Additional info: The response contains the response status and HTTP URL where the data can be accessed. Idclass: Represents the class ID of AsonControlPlane. a2EndClSlotNum : Indicates the slot number for the second end connection (A2). a2EndPortId : Identifier for the port at the second end connection. a2EndPortLabel : Label for the port at the second end connection. a2EndTS : Time slot identifier for the second end connection. a2EndTSGran : Granularity level of the time slot for the second end connection. aEndClSlotNum : Slot number for the first end connection (A). aEndPortId : Identifier for the port at the first end connection. aEndPortLabel : Label for the port at the first end connection. confSoftRevSncpMode : Configuration for the soft revertive SNCP mode. confSoftRevSncpTimeout : Timeout setting for the soft revertive SNCP. usedSoftRevSncpMode : Actual used soft revertive SNCP mode. usedSoftRevSncpTimeout : Timeout setting for the used soft revertive SNCP. backupRoute : Indicates whether a backup route is available. aEndTS : Time slot identifier for the first end connection. aEndTSGran : Granularity level of the time slot for the first end connection. aWdmFrequency : Frequency setting for WDM (Wavelength Division Multiplexing). alarmStatus : Status of alarms associated with the connection. asapName : Name of the ASAP (Any Service Access Point). asonProtection : Type of protection applied to the connection. backupSt : Status of the backup route. clientDependency : Indicates dependencies related to client ports. confSt : Configuration state of the connection. defaultPriority : Default priority level assigned to the connection. defaultRerouting : Default rerouting mode for the connection. defaultReversionMode : Default mode for reversion. defaultSetupPriority : Default setup priority for the connection. disjointedSt : Status indicating whether the paths are disjointed. endToEndOtnTrailId : Identifier for the end-to-end OTN trail. endToEndOtnTrailLabel : Label for the end-to-end OTN trail. excludeAnyColorId : Identifier for excluded color profiles. excludeAnyColorName : Name of the excluded color profile. excludeAnyColorString : String representation of the excluded color profile. gmreLabel : Label for GMRE (Generalized Multi-Rate Ethernet) service. includeAnyColorId : Identifier for included color profiles. includeAnyColorName : Name of the included color profile. includeAnyColorString : String representation of the included color profile. maxLatency : Maximum latency allowed for the connection. pathAlarmMoveMaxAttempt : Maximum attempts for moving path alarms. pathAlarmMoveHoldOffTime : Hold-off time for moving path alarms. nativeName : Native name representation for the connection. nodeId : Identifier for the associated node. npaId : Identifier for the NPA (Network Point of Access). npaLabel : Label for the NPA. operationalState : Current operational state of the connection. priority : Assigned priority level for the connection. protType : Protection type for the connection. protectionGroup : Identifier for the protection group. rerouting : Rerouting mode in effect. reversionBlockedSt : Status indicating whether reversion is blocked. reversionMode : Mode for reversion. reversionSt : Status of reversion readiness. routingSt : Current state of routing. sbnConnShape : Connection shape type. serviceState : Current state of the service. setupPriority : Priority level for setting up the connection. sncId : Identifier for the subnetwork connection. sncType : Type of the subnetwork connection. sncSwitchSt : Status of SNCP switch. tSlotGranularity : Granularity of the time slot. testMode : Current mode of testing for SNCP. consistSt : Consistency status of the connection. id : Unique identifier for the trail. key : Key for accessing the trail resource. className : Name of the class associated with the connection. trailWrkSt : Working state of the trail. transportNtw : Type of transport network. tunnelType : Type of tunnel associated with the connection. guiLabel : User-friendly label for display purposes. waitForServerRestoration : Indicates whether to wait for server restoration. wdmTrailLayer : Layer information for WDM trail. z2EndClSlotNum : Slot number for the second end connection (Z2). z2EndPortId : Identifier for the port at the second end connection (Z2). z2EndPortLabel : Label for the port at the second end connection (Z2). z2EndTS : Time slot identifier for the second end connection (Z2). z2EndTSGran : Granularity level of the time slot for the second end connection (Z2). zEndClSlotNum : Slot number for the end connection (Z). zEndPortId : Identifier for the port at the end connection (Z). zEndPortLabel : Label for the port at the end connection (Z). zEndTS : Time slot identifier for the end connection (Z). zEndTSGran : Granularity level of the time slot for the end connection (Z). nadString : Default value for unknown associations. diversityMode : Mode of diversity for connections. groupName : Name of the group associated with the connection. maxRestorationAttempts : Maximum attempts for restoration. maxSpareRestorationAttempts : Maximum attempts for spare restoration. asecontrolMode : Control mode for ASE . aseholdOffTimer : Hold-off timer setting for ASE. disableGmreOpticalFeasibility : Setting for GMRE optical feasibility. autoReversionWithSRGViolation : Auto-reversion setting in case of SRG violation. ui_sncpLegDiversity : User interface representation of SNCP leg diversity. sncpHOT : Hot standby configuration for SNCP. ui_sncpHOT : User interface representation of SNCP hot standby. electricalLayerContribution : Contribution of the electrical layer. otsigProtection : Protection setting for OTSIG (Optical Transport Signal). otsigExccb : Setting for OTSIG EXCCB (External Control Circuit Block). otsigPfClear : Clear setting for OTSIG protection flags. otsigPfSet : Set value for OTSIG protection flags. burstInterval : Interval for burst configurations. burstPeriod : Period for burst configurations. burstThreshold : Threshold for burst configurations. ui_maxRestorationAttempts : User interface representation of maximum restoration attempts. ui_maxSpareRestorationAttempts : User interface representation of maximum spare restoration attempts. sncpLegDiversity : Diversity mode for SNCP legs.
102. GET/data/asonNBI/sbnConnEnds/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason end points

     • Response

       • Changed response : [200]//Response is ason data Additional info: IdClass: Represents the unique identifier for the class type. clSlotNum: Indicates the slot number assigned to the client. currentFrequency: Specifies the current frequency in use, if applicable. endType: Defines the connection endpoint type, such as endA or endB. nodeId: Refers to the unique identifier of the node. nodeUserLabel: Provides a user-friendly label or name for the node. nominalFrequency: Specifies the nominal operating frequency. portLabel: Displays the label of the port in use. resType: Defines the resource type, e.g., main or auxiliary. id: Unique identifier for the entity. key: Represents a unique key for referencing this object. className: Specifies the class name associated with this entity. tSGran: Indicates the granularity of the timeslot. timeSlots: Specifies the timeslots assigned to the connection. trailId: Refers to the unique identifier of the trail associated with this connection.
103. GET/data/asonNBI/threeRs/{ids}/{table2}/{ids2} Retrive details of second entity associated with threeR

     • Response

       • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aLocalPortId : Identifier for the local port at the first end connection (A). aMuxPrtLabel : Label for the multiplexer port at the first end connection. aRemotePortId : Identifier for the remote port at the first end connection. aTrPrtLabel : Label for the transport port at the first end connection. asonSncLabel : Label for the associated SNC (Subnetwork Connection) if applicable. belongTrailId : Identifier for the trail to which the connection belongs. confSt : Configuration state of the connection. endToEndOtnTrailId : Identifier for the end-to-end OTN trail. endToEndOtnTrailLabel : Label for the end-to-end OTN trail. nodeId : Identifier for the associated node. npaId : Identifier for the Network Point of Access. npaLabel : Label for the NPA. systemLabel : System-defined label for the connection. id : Unique identifier for the connection resource. key : Key for accessing the connection resource. className : Name of the class associated with the connection. zLocalPortId : Identifier for the local port at the second end connection (Z). zMuxPrtLabel : Label for the multiplexer port at the second end connection. zRemotePortId : Identifier for the remote port at the second end connection. zTrPrtLabel : Label for the transport port at the second end connection. usageIndicator : Indicates the usage status of the connection. profileId : Identifier for the associated profile. otuStruct : Structure of the OTU (Optical Transport Unit) associated with the connection. otsigAsonRegenDynamic : Indicates the dynamic regeneration setting for OTSIG ASON. aMuxNeLabel : Label for the multiplexer network element at the first end connection. zMuxNeLabel : Label for the multiplexer network element at the second end connection.
104. GET/data/asonNBI/teLinks/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason telink

     • Response

       • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aSite : To add the head site. srgComment : SRG Comment. id : Represents the unique AsonControlPlane ID key : SharedRiskGroup/id className: Name of the class for physical connection. srgProbability : Represents the probability of risk which can be SrgProb_high, SrgProb_low, SrgProb_medium, SrgProb_undefined,SrgProb_veryHigh,SrgProb_veryLow. srgType : Represents risk type which can be SrgType_cable, SrgType_conduit, SrgType_node, SrgType_other, SrgType_rightOfWay, SrgType_phyConn. guiLabel : Represents name of the SRG to be created. zSite :To add the tail site.
105. GET/data/asonNBI/sharedRiskGroups/{ids}/{table2}/{ids2} Retrive details of second entity associated with shared risk groups

     • Response

       • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. aSite : To add the head site. srgComment : SRG Comment. id : Represents the unique ID key : SharedRiskGroup/id +srgProbability : Represents the probability of risk which can be SrgProb_high, SrgProb_low, SrgProb_medium, SrgProb_undefined,SrgProb_veryHigh,SrgProb_veryLow. srgType : Represents risk type which can be SrgType_cable, SrgType_conduit, SrgType_node, SrgType_other, SrgType_rightOfWay, SrgType_phyConn. guiLabel : Represents name of the SRG to be created. zSite :To add the tail site.
106. GET/data/asonNBI/asonControlPlanes/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason control planes

     • Response

       • Changed response : [200]//Response is ason data Additional info: Idclass: Represents the class ID of AsonControlPlane. masterNeId : Identifier for the master network element. associatedNodeId : Identifier for the associated node. alarmStatus : Status of alarms associated with the connection. alrAligned : Indicates if alignment for the alarm is set. alrAlignment : Status of alarm alignment. asonCtrPlaneType : Type of ASON control plane used. assignSt : Current assignment state of the control plane. automaticRestoration : Status of automatic restoration settings. consistSt : Consistency status of the control plane. id : Unique identifier for the control plane resource. key : Key for accessing the control plane resource. priority : Assigned priority level for the control plane. className : Name of the class associated with the control plane. controlPlaneType : Type of control plane (e.g., ASON). emsFactoryAddress : Address of the EMS factory (if applicable). fastPhotonicRestoration : Status of fast photonic restoration settings. installedVersion : Version of the installed control plane. ipAddress : IP address associated with the control plane. migrationState : State of migration for the control plane. nativeName : Native name representation for the control plane. npaId : Identifier for the Network Point of Access (if applicable). reachable : Status indicating the reachability of the control plane. scModificationDate : Date of last modification for the control plane. scModifiedByCP : Indicates if the control plane was modified by a control plane. guiLabel : User-friendly label for display purposes. version : Version of the control plane. syncStatus : Status of synchronization for the control plane. softRevertiveSncpModeL0 : Soft revertive SNCP mode for layer 0. softRevertiveSncpModeL1 : Soft revertive SNCP mode for layer 1. ospfAreaId : Area Id associated to each CP node. cpNodeId : Colocated node address of GMPLS node which is unique. notifyIpAddress : IP Address used to send RSVP notiications which summarizes all alarm info to one address. subNodeList : List of network-wide unique data plane node ids . softRevSncpTimeoutL0 : Timeout setting for soft revertive SNCP for layer 0. softRevSncpTimeoutL1 : Timeout setting for soft revertive SNCP for layer 1.
107. GET/data/asonNBI/colorProfiles/{ids}/{table2}/{ids2} Retrive details of second entity associated with ason color profiles

     • Response

       • Changed response : [200]//Response is ason data Additional info: IdClass : class id of colorProfile, can be retrieved as IdClass from /data/npr/colorProfiles?guiLabel={userLabel}. id : Unique identifier of response. key : Unique colorProfile key, can be retrieved as key from /data/npr/colorProfiles?guiLabel={userLabel}. className : ClassName of a colorProfile, can be retrieved as className from /data/npr/colorProfiles?guiLabel={userLabel}. colorString : colorString of a colorProfile, can be retrieved as colorString from /data/npr/colorProfiles?guiLabel={userLabel} . colors : colors of a colorProfile, can be retrieved as colors from /data/npr/colorProfiles?guiLabel={userLabel} . comment1 : User comment 1 added for colorProfile, can be retrieved as comment1 from /data/npr/colorProfiles?guiLabel={userLabel}. owner : owner for colorProfile, can be retrieved as owner from /data/npr/colorProfiles?guiLabel={userLabel}. guiLabel : GUI Label of a colorProfile, can be retrieved as guiLabel from /data/npr/colorProfiles?guiLabel={userLabel}.
108. GET/data/npr/npas/{ids}/{table2} This API is used to retrieve the entities associated to the particular NPAs

     • Response

       • Changed response : [200]//Currently the response will be a list of the associated entity passed as a prameter in 'table2' [nodes, asonControlPlanes, teLinks] Sample considering table2 as teLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
109. GET/data/npr/teLinks/{ids}/{table2} This API is used to retrieve the entities associated to the particular TeLinks

     • Response

       • Changed response : [200]//Currently the response is a list of SRGs with all the attriutes
         • New body: 'application/json'
         • Deleted body: '*/*'
110. GET/data/asonNBI/npas/{ids}/{table2} This API is used to retrieve the entities associated to the particular NPAs

     • Response

       • Changed response : [200]//Currently the response will be a list of the associated entity passed as a prameter in 'table2' [nodes, asonControlPlanes, teLinks] Sample considering table2 as teLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
111. GET/data/asonNBI/teLinks/{ids}/{table2} This API is used to retrieve the entities associated to the particular TeLinks

     • Response

       • Changed response : [200]//Currently the response is a list of SRGs with all the attriutes
         • New body: 'application/json'
         • Deleted body: '*/*'
112. GET/data/npr/node/name Retrieves the NPR node name for the given NPR node id

     • Response

       • 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.
113. 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.
114. GET/data/npr/nes/{ids} This API is used to retrieve the specific NE object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
115. GET/data/npr/nodes/{ids} This API is used to retrieve the specific Node attributes based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
116. GET/data/npr/ne/{ids} This API is used to retrieve the specific NE object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
117. GET/data/npr/node/{ids} This API is used to retrieve the specific Node attributes based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
118. GET/data/npr/Node/{ids} This API is used to retrieve the specific Node object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
119. GET/data/npr/Ne/{ids} This API is used to retrieve the specific NE details based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
120. GET/data/npr/npas/{ids} Retrieves NPAs for the specified IDs

     • Response

       • Changed response : [200]//Response is list of NPAs
         • New body: 'application/json'
         • Deleted body: '*/*'
121. GET/data/npr/linkAsons/{ids} Retrieves ASON links for specified IDs

     • Response

       • Changed response : [200]//List of LinkAson
         • New body: 'application/json'
         • Deleted body: '*/*'
122. GET/data/npr/sbnConnEnds/{ids} Retrieves SBN Connection Ends for the specified IDs

     • Response

       • Changed response : [200]//Response is list of SBN Conn Ends
         • New body: 'application/json'
         • Deleted body: '*/*'
123. GET/data/npr/alarms/{ids} This API will get the specific alarms by IDs

     • Response

       • Changed response : [200]//Response is list of alarms filtered by the IDs passed as path-variable in the URL
         • New body: 'application/json'
         • Deleted body: '*/*'
124. GET/data/npr/threeRs/{ids} Retrieves ThreeRs for the specified IDs

     • Response

       • Changed response : [200]//Response is list of ThreeRs
         • New body: 'application/json'
         • Deleted body: '*/*'
125. GET/data/npr/teLinks/{ids} Retrieves TeLinks for the specified IDs

     • Response

       • Changed response : [200]//Response is TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
126. GET/data/npr/sharedRiskGroups/{ids} Retrieves Shared Risk Groups (SRGs) for the specified IDs

     • Response

       • Changed response : [200]//List of Shared Risk groups (SRGs)
         • New body: 'application/json'
         • Deleted body: '*/*'
127. GET/data/npr/asonControlPlanes/{ids} Retrieves specific ASON Control Planes by IDs

     • Response

       • Changed response : [200]//Response is list ASON controlplanes filtered based on the IDs passed
         • New body: 'application/json'
         • Deleted body: '*/*'
128. GET/data/npr/colorProfiles/{ids} Retrieves color profiles for the specified IDs

     • Response

       • Changed response : [200]//Response is ASON data Additional info: Successfully retrieved the colorProfiles ids. Idclass: Represents the class ID of AsonControlPlane. id : Represents the unique AsonControlPlane ID key : ColorProfile/id className: Name of the class for physical connection. colorString : if colorprofileName is Nocolor then colorString value will be 0000.0000.0000.0000.0000.0000.0000 colors : Specifies the color value associated with the ColorProfile. comment1: User-defined string (max 24 characters). guiLabel: Name of the colorprofileName.
129. GET/data/npr/physicalConns/{ids} This API is used to retrieve specific physical connection object details based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. ObjectId : Object id of the physical connection. EventType : Event type of the physical connection. ClassType : Class type of the physical connection. IdClass : Class id of the physical connection, can be retrieved as IdClass from /data/npr/physicalConns?guiLabel={userLabel} sharedRiskGroups : Shared risk groups of the physical connection. a2PortLabel : Port Label of the physical connection. aNodeId : aEnd node unique identifier. aPortLabel : aEnd port label. aTozFiberLength : a to z fiber length. aTozFiberType : a to z fiber type. aTozSpanLoss : a to z span loss of C band connection. aTozSpanLossL : a to z span loss of L band connection. aTozCommSpanLoss : a to z comm span loss. zToaCommSpanLoss : z to a comm span loss. alarmStatus : AlarmStatus of the node. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] allPathCost : Represents the cost of the physical connection. asapId : Represents the unique identifier of asap. asapName : default ASAP if the ASAP is not added. asonAdmState : Represents connection is in lock state or unlocked state. Possible values [notApplicable, locked, unlocked, unknown, shuttingDown, softShuttingDown, sync ] asonAutoRestoration : Possible values [ ExtOperSt_notMeaningful, ExtOperSt_disabled, ExtOperSt_enabled, ExtOperSt_partiallyEnabled ] asonWTR : Represent wait to restore and default value is 60. clientSignalType : Represents signalType of physical connection. Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] clientTechnology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] colorProfileId : colour profile Id of the physical connection. commissionedStatus : Represents commissioned status.Possible values [ CommissionedStatus_commissioned,CommissionedStatus_notApplicable,CommissionedStatus_notCommissioned ] flexGridSupport : Indicates flexgrid supported or not for physical connection. Possible values [ FlexGridSupport_undefined,FlexGridSupport_yes,FlexGridSupport_no,FlexGridSupport_notApplicable ] aseLongLinkStatus : Possible values [ AseLongLinkSupported_NA,AseLongLinkSupported_yes,AseLongLinkSupported_no,AseLongLinkSupported_Lband_yes,AseLongLinkSupported_C_L_band_yes ] id : unique identifier of physical connection. key : PhysicalConn/1 className : Name of class for physical connection. currentFrequency : Represents RX frequency of physical connection. defTime : Represents creation time of physical connection. direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] implSt : Implementation state of the physical connection.Possible values [ defined,implemented,deimplemented,partiallyImplemented ] interShelf : Type of the physical connection. Possible values [ normal,interShelf ] spanType : Possible values [ SpanType_dualFiber,SpanType_singleFiber,SpanType_notApplicable ] gridType : Grid type of the physical connection. Possible values [ standard,gHz125,notApplicable ] connecAdminState : Possible values [ ConnecinService,ConnecnotApplicable,ConnecnotInService,Connecmaintenance ] lastCalculatedSpanLossDate : Indicates date of last calculated spanloss. latency : Represents the latency value on the physical connection. linkType : Represents the type of the physical connection. Possible values [ rm_internal,drop,uni_n, i_nni, e_nni, split, fa_unterm, fa_term, intra_node,transitional ] nadString : Represents access domain associated. Default is : unknown operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otdrScanStatus : Possible values [ ScanStatus_notMeaningful,ScanStatus_Scheduled,ScanStatus_InProgress,ScanStatus_Success,ScanStatus_Failure,ScanStatus_PartiallyFailed,ScanStatus_Misfired,ScanStatus_Stopped,ScanStatus_Other ] otdrSupported : Represents OTDR is supported or not.Possible values [ Boolean_false, Boolean_true] otdrDfSupported : Possible values [ Boolean_false, Boolean_true] otdrExtAssocSupported : Possible values [ Boolean_false, Boolean_true] otnMapper : Represents OTN Network Connection ID otuSignalType : Represents the signal type of the port for which physical connection is involved. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] overlaySupport : Represents overlay is supported or not for physical connection.Possible values [ ExtBoolean_false,ExtBoolean_true ] pm15m : This attribute is deprecated and no longer used. It will always be enabled by default. pm24h : This attribute is deprecated and no longer used. It will always be enabled by default. serviceState : Service state of the physical connection. Possible values [ ServiceState_notInService,ServiceState_inService ] shape : Shape of the physical connection. Possible values [ Shape_simple,Shape_fourEnded,Shape_fourEndedSingleFiber ] sltePresent : Indicates repeater is associated or not.Possible values [ Boolean_false, Boolean_true] srgPresent : Indicates shared risk group [srg] present or not. Possible values [ ObjectPresent_notPresent,ObjectPresent_present ] thrdPartyNtwDescription : Indicates third party network description if given of physical connection. thrdPartyNtwName : Indicates third party network name if given of physical connection txFrequency : Indicates transmission frequency of physical connection ultraLongSpan : Indicates span. Possible values [ Boolean_false, Boolean_true] updatedTime : Indicates updated time. guiLabel : name of the physical connection. wdmConnectionType : Represents the Connection type supported.Possible values [ WdmPortType_ots,WdmPortType_ops0,WdmPortType_otsReg ] wdmLinkType : Represents link type. Possible values [ Wdmotn,Wdmlegacy16x6,Wdmiw16x6,WdmpssOne,WdmiwpssOne,Wdmwavelite,Wdmopenconfig ] wdmProtConnType : Represents protection type.Possible values [ WdmProtType_notMeaningful,WdmProtType_y_cable,WdmProtType_e_sncp ] wrkSt : Represents the working state of the physical connection.Possible values [ WorkingState_failToImplement,WorkingState_normal,WorkingState_configuring,WorkingState_removing,WorkingState_failToConfigure,WorkingState_failToUpload,WorkingState_implementing,WorkingState_uploading,WorkingState_deimplementing,WorkingState_failToDeimplement,WorkingState_failToRemove,WorkingState_subscriberNumberUpdating,WorkingState_failToUpdateSubscriberNumber,WorkingState_resetting,WorkingState_failToReset,WorkingState_activatingMsSpRing,WorkingState_failedToActivateMsSpRing,WorkingState_settingLoopback,WorkingState_failToSetLoopback,WorkingState_synchronizingLoopback,WorkingState_failToSynchronizeLoopback,WorkingState_joining,WorkingState_failedToJoin,WorkingState_undoJoining,WorkingState_failedToUndoJoin,WorkingState_splitting,WorkingState_failedToSplit,WorkingState_undoSplitting,WorkingState_failedToUndoSplit,WorkingState_inserting,WorkingState_connecting,WorkingState_failedToConnect,WorkingState_disconnecting,WorkingState_failedToDisconnect,WorkingState_managingTraceId,WorkingState_implNpa,WorkingState_deImplNpa,WorkingState_failedToImplNpa,WorkingState_failedToDeimplNpa,WorkingState_removingFromNpa,WorkingState_enablingAlarms,WorkingState_disablingAlarms,WorkingState_failedToEnableAlarms,WorkingState_failedToDisableAlarms,WorkingState_moving,WorkingState_locking,WorkingState_unlocking,WorkingState_movingPorts,WorkingState_enablingDomains,WorkingState_lockingForEnablingDomains,WorkingState_unlockingForEnablingDomains,WorkingState_lockingForMovingPorts,WorkingState_unlockingForMovingPorts,WorkingState_assigningPorts,WorkingState_failedToAssignPorts,WorkingState_synchronizingOchLayer, WorkingState_removingInternalCables,WorkingState_failedToRemoveIntCables,WorkingState_modifyingLabels,WorkingState_failToModifyLabels,WorkingState_lockedForCardSwap ] z2PortLabel : z2End port label. zNodeId : zEnd node unique identifier. zPortLabel : zEnd port label. zToaFiberLength : z to a fiber length. zToaFiberType : Indicates type of the fiber z to a.Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] zToaSpanLoss : z to a spann loss for C band connection. zToaSpanLossL : z to a spann loss for L band connection. colorProfileName : Represent ColorprofileName and default name is NoColor. colorString : if colorprofileName is Nocolor then colorString value will be 0000.0000.0000.0000.0000.0000.0000 band : Indicates the band supported for card. Possible values [ BandIdentification_cBand,BandIdentification_lBand,BandIdentification_coarseBand,BandIdentification_notMeaningful,BandIdentification_cPlusCoarseBand,BandIdentification_cAndSBand,BandIdentification_cAndLBand ] protection : Represents physical connection is protected or not. Possible values [ Unprotected,protected ] otdrSummary : Possible values [ OTDRSCAN_NOTAPPLICABLE ] olcState : Possible values [ OlcState_InService,OlcState_Maintenance ] npaUserLabel : userlabel of NPA. mostRecentNote : Indicates most recent note on physical connection. fiberAscStatus : Indicates fiber association status.Possible values [ Boolean_false, Boolean_true] isDarkFiberAssociated : Indicates whether dark fiber associated to physical connection.Possible values [ Boolean_false, Boolean_true] clusterLink : Indicates whether its cluster link.Possible values [ ClusterLink_normal,ClusterLink_cluster ] asapStatus : Indicates status of asap.Possible values [ AsapStatus_notset,AsapStatus_enabled ] lowlinkUtilThreshold : Indicates lower threshold of link utilisation. highlinkUtilThreshold : Indicates higher threshold of link utilisation. linkUtilProfileName : Indicates profile name of link utilisation. linkUtilRatio : Indicates ratio of link utilisation. currentlinkUtilRatio : Indicates ratio of current link util. overlaplinkUtilRatio : Indicates ratio of overlap link util. olpAssociatedLink : Indicates links associated to olp. noCommandToNe : Represents whether commands need to be sent to NE or not.Possible values [ Boolean_false, Boolean_true] consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] subseaLink : Represents physical connection is subsea link or not. Possible values [ Boolean_false, Boolean_true] ramanPresent : Represents raman amplifier present or not. modificationTime : Represents modification time of physical connection. modifiedBy : Represents name of the user who has modified physical connection. createdBy : Represents name of the user who has created physical connection. uptimeOpstateMs : Operation state uptime in milli seconds. uptimeUasMs : Indicates uptime. labelName : Represents label added by user on physical connection. discoveredSubseaLink : Indicates PSI-CL physical connection. -------------------------------------------------------------------------------------------------------
130. GET/data/asonNBI/nes/{ids} This API is used to retrieve the specific NE object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
131. GET/data/asonNBI/nodes/{ids} This API is used to retrieve the specific Node attributes based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
132. GET/data/asonNBI/ne/{ids} This API is used to retrieve the specific NE object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
133. GET/data/asonNBI/node/{ids} This API is used to retrieve the specific Node attributes based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
134. GET/data/asonNBI/Node/{ids} This API is used to retrieve the specific Node object details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
135. GET/data/asonNBI/Ne/{ids} This API is used to retrieve the specific NE details based on provided ids

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
136. GET/data/asonNBI/npas/{ids} Retrieves NPAs for the specified IDs

     • Response

       • Changed response : [200]//Response is list of NPAs
         • New body: 'application/json'
         • Deleted body: '*/*'
137. GET/data/asonNBI/sbnConnEnds/{ids} Retrieves SBN Connection Ends for the specified IDs

     • Response

       • Changed response : [200]//Response is list of SBN Conn Ends
         • New body: 'application/json'
         • Deleted body: '*/*'
138. GET/data/asonNBI/alarms/{ids} This API will get the specific alarms by IDs

     • Response

       • Changed response : [200]//Response is list of alarms filtered by the IDs passed as path-variable in the URL
         • New body: 'application/json'
         • Deleted body: '*/*'
139. GET/data/asonNBI/threeRs/{ids} Retrieves ThreeRs for the specified IDs

     • Response

       • Changed response : [200]//Response is list of ThreeRs
         • New body: 'application/json'
         • Deleted body: '*/*'
140. GET/data/asonNBI/teLinks/{ids} Retrieves TeLinks for the specified IDs

     • Response

       • Changed response : [200]//Response is TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
141. GET/data/asonNBI/asonControlPlanes/{ids} Retrieves specific ASON Control Planes by IDs

     • Response

       • Changed response : [200]//Response is list ASON controlplanes filtered based on the IDs passed
         • New body: 'application/json'
         • Deleted body: '*/*'
142. GET/data/asonNBI/colorProfiles/{ids} Retrieves color profiles for the specified IDs

     • Response

       • Changed response : [200]//Response is ASON data Additional info: Successfully retrieved the colorProfiles ids. Idclass: Represents the class ID of AsonControlPlane. id : Represents the unique AsonControlPlane ID key : ColorProfile/id className: Name of the class for physical connection. colorString : if colorprofileName is Nocolor then colorString value will be 0000.0000.0000.0000.0000.0000.0000 colors : Specifies the color value associated with the ColorProfile. comment1: User-defined string (max 24 characters). guiLabel: Name of the colorprofileName.
143. GET/data/npr/nes This is used to retrieve all the NE level details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
144. GET/data/npr/nodes This is used to retrieve all the Node level details

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
145. GET/data/npr/ne This API retrieves all the NEs

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
146. GET/data/npr/node This is used to retrieve all the Nodes

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
147. GET/data/npr/linkAsons This API retrieves all the ASON links

     • Response

       • Changed response : [200]//Response is list of ASON links
         • New body: 'application/json'
         • Deleted body: '*/*'
148. GET/data/npr/sbnConnEnds This API retervies all the avialable sbnConnEnds

     • Response

       • Changed response : [200]//Response is list of SBN Conn Ends
         • New body: 'application/json'
         • Deleted body: '*/*'
149. GET/data/npr/alarms This is used to retrieve all the alarms.

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. alarmDate : Indicates the date on which alram was raised corrObjId : Correlated Object ID corrObjSubType : Indicates Sub Type of Correlated Object corrObjType : Indicates Object Type of Correlated Object objLabel : User Label of Correlated Object primary : ExtBoolean_false("FALSE"), ExtBoolean_true("TRUE"), ExtBoolean_notApplicable("NOT_APPLICABLE") id : Represents the unique Alarm ID serviceAffecting : ExtBoolean_false("FALSE"), ExtBoolean_true("TRUE"), ExtBoolean_notApplicable("NOT_APPLICABLE") severity : PerceivedSeverity_indeterminate, PerceivedSeverity_critical, PerceivedSeverity_major, PerceivedSeverity_minor,PerceivedSeverity_warning, PerceivedSeverity_cleared guiLabel : Indicates the User Label of Alarm --------------------------------------------------------------------------------------------------
150. GET/data/npr/teLinks This API retrieves all the TeLinks

     • Response

       • Changed response : [200]//Response is list of TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
151. GET/data/npr/TeLinks The API retrieves all the TeLinks

     • Response

       • Changed response : [200]//Response is list of TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
152. GET/data/npr/reversionGroups This API retrieves all the available reversion groups

     • Response

       • Changed response : [200]//Response is list of reversion groups
         • New body: 'application/json'
         • Deleted body: '*/*'
153. GET/data/npr/AsonPotentialLink This API retrieves all the ASON potential links

     • Response

       • Changed response : [200]//Response is list of ASON potential links
         • New body: 'application/json'
         • Deleted body: '*/*'
154. GET/data/npr/asonControlPlanes This API retrieves all the available ASON ControlPlanes

     • Response

       • Changed response : [200]//Response is list of ASON controlplanes
         • New body: 'application/json'
         • Deleted body: '*/*'
155. GET/data/npr/PhysicalConns This API is used to retrieve Physical Connections

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. ObjectId : Object id of the physical connection. EventType : Event type of the physical connection. ClassType : Class type of the physical connection. IdClass : Class id of the physical connection, can be retrieved as IdClass from /data/npr/physicalConns?guiLabel={userLabel} sharedRiskGroups : Shared risk groups of the physical connection. a2PortLabel : Port Label of the physical connection. aNodeId : aEnd node unique identifier. aPortLabel : aEnd port label. aTozFiberLength : a to z fiber length. aTozFiberType : a to z fiber type. aTozSpanLoss : a to z span loss of C band connection. aTozSpanLossL : a to z span loss of L band connection. aTozCommSpanLoss : a to z comm span loss. zToaCommSpanLoss : z to a comm span loss. alarmStatus : AlarmStatus of the node. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] allPathCost : Represents the cost of the physical connection. asapId : Represents the unique identifier of asap. asapName : default ASAP if the ASAP is not added. asonAdmState : Represents connection is in lock state or unlocked state. Possible values [notApplicable, locked, unlocked, unknown, shuttingDown, softShuttingDown, sync ] asonAutoRestoration : Possible values [ ExtOperSt_notMeaningful, ExtOperSt_disabled, ExtOperSt_enabled, ExtOperSt_partiallyEnabled ] asonWTR : Represent wait to restore and default value is 60. clientSignalType : Represents signalType of physical connection. Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] clientTechnology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] colorProfileId : colour profile Id of the physical connection. commissionedStatus : Represents commissioned status.Possible values [ CommissionedStatus_commissioned,CommissionedStatus_notApplicable,CommissionedStatus_notCommissioned ] flexGridSupport : Indicates flexgrid supported or not for physical connection. Possible values [ FlexGridSupport_undefined,FlexGridSupport_yes,FlexGridSupport_no,FlexGridSupport_notApplicable ] aseLongLinkStatus : Possible values [ AseLongLinkSupported_NA,AseLongLinkSupported_yes,AseLongLinkSupported_no,AseLongLinkSupported_Lband_yes,AseLongLinkSupported_C_L_band_yes ] id : unique identifier of physical connection. key : PhysicalConn/1 className : Name of class for physical connection. currentFrequency : Represents RX frequency of physical connection. defTime : Represents creation time of physical connection. direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] implSt : Implementation state of the physical connection.Possible values [ defined,implemented,deimplemented,partiallyImplemented ] interShelf : Type of the physical connection. Possible values [ normal,interShelf ] spanType : Possible values [ SpanType_dualFiber,SpanType_singleFiber,SpanType_notApplicable ] gridType : Grid type of the physical connection. Possible values [ standard,gHz125,notApplicable ] connecAdminState : Possible values [ ConnecinService,ConnecnotApplicable,ConnecnotInService,Connecmaintenance ] lastCalculatedSpanLossDate : Indicates date of last calculated spanloss. latency : Represents the latency value on the physical connection. linkType : Represents the type of the physical connection. Possible values [ rm_internal,drop,uni_n, i_nni, e_nni, split, fa_unterm, fa_term, intra_node,transitional ] nadString : Represents access domain associated. Default is : unknown operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otdrScanStatus : Possible values [ ScanStatus_notMeaningful,ScanStatus_Scheduled,ScanStatus_InProgress,ScanStatus_Success,ScanStatus_Failure,ScanStatus_PartiallyFailed,ScanStatus_Misfired,ScanStatus_Stopped,ScanStatus_Other ] otdrSupported : Represents OTDR is supported or not.Possible values [ Boolean_false, Boolean_true] otdrDfSupported : Possible values [ Boolean_false, Boolean_true] otdrExtAssocSupported : Possible values [ Boolean_false, Boolean_true] otnMapper : Represents OTN Network Connection ID otuSignalType : Represents the signal type of the port for which physical connection is involved. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] overlaySupport : Represents overlay is supported or not for physical connection.Possible values [ ExtBoolean_false,ExtBoolean_true ] pm15m : This attribute is deprecated and no longer used. It will always be enabled by default. pm24h : This attribute is deprecated and no longer used. It will always be enabled by default. serviceState : Service state of the physical connection. Possible values [ ServiceState_notInService,ServiceState_inService ] shape : Shape of the physical connection. Possible values [ Shape_simple,Shape_fourEnded,Shape_fourEndedSingleFiber ] sltePresent : Indicates repeater is associated or not.Possible values [ Boolean_false, Boolean_true] srgPresent : Indicates shared risk group [srg] present or not. Possible values [ ObjectPresent_notPresent,ObjectPresent_present ] thrdPartyNtwDescription : Indicates third party network description if given of physical connection. thrdPartyNtwName : Indicates third party network name if given of physical connection txFrequency : Indicates transmission frequency of physical connection ultraLongSpan : Indicates span. Possible values [ Boolean_false, Boolean_true] updatedTime : Indicates updated time. guiLabel : name of the physical connection. wdmConnectionType : Represents the Connection type supported.Possible values [ WdmPortType_ots,WdmPortType_ops0,WdmPortType_otsReg ] wdmLinkType : Represents link type. Possible values [ Wdmotn,Wdmlegacy16x6,Wdmiw16x6,WdmpssOne,WdmiwpssOne,Wdmwavelite,Wdmopenconfig ] wdmProtConnType : Represents protection type.Possible values [ WdmProtType_notMeaningful,WdmProtType_y_cable,WdmProtType_e_sncp ] wrkSt : Represents the working state of the physical connection.Possible values [ WorkingState_failToImplement,WorkingState_normal,WorkingState_configuring,WorkingState_removing,WorkingState_failToConfigure,WorkingState_failToUpload,WorkingState_implementing,WorkingState_uploading,WorkingState_deimplementing,WorkingState_failToDeimplement,WorkingState_failToRemove,WorkingState_subscriberNumberUpdating,WorkingState_failToUpdateSubscriberNumber,WorkingState_resetting,WorkingState_failToReset,WorkingState_activatingMsSpRing,WorkingState_failedToActivateMsSpRing,WorkingState_settingLoopback,WorkingState_failToSetLoopback,WorkingState_synchronizingLoopback,WorkingState_failToSynchronizeLoopback,WorkingState_joining,WorkingState_failedToJoin,WorkingState_undoJoining,WorkingState_failedToUndoJoin,WorkingState_splitting,WorkingState_failedToSplit,WorkingState_undoSplitting,WorkingState_failedToUndoSplit,WorkingState_inserting,WorkingState_connecting,WorkingState_failedToConnect,WorkingState_disconnecting,WorkingState_failedToDisconnect,WorkingState_managingTraceId,WorkingState_implNpa,WorkingState_deImplNpa,WorkingState_failedToImplNpa,WorkingState_failedToDeimplNpa,WorkingState_removingFromNpa,WorkingState_enablingAlarms,WorkingState_disablingAlarms,WorkingState_failedToEnableAlarms,WorkingState_failedToDisableAlarms,WorkingState_moving,WorkingState_locking,WorkingState_unlocking,WorkingState_movingPorts,WorkingState_enablingDomains,WorkingState_lockingForEnablingDomains,WorkingState_unlockingForEnablingDomains,WorkingState_lockingForMovingPorts,WorkingState_unlockingForMovingPorts,WorkingState_assigningPorts,WorkingState_failedToAssignPorts,WorkingState_synchronizingOchLayer, WorkingState_removingInternalCables,WorkingState_failedToRemoveIntCables,WorkingState_modifyingLabels,WorkingState_failToModifyLabels,WorkingState_lockedForCardSwap ] z2PortLabel : z2End port label. zNodeId : zEnd node unique identifier. zPortLabel : zEnd port label. zToaFiberLength : z to a fiber length. zToaFiberType : Indicates type of the fiber z to a.Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] zToaSpanLoss : z to a spann loss for C band connection. zToaSpanLossL : z to a spann loss for L band connection. colorProfileName : Represent ColorprofileName and default name is NoColor. colorString : if colorprofileName is Nocolor then colorString value will be 0000.0000.0000.0000.0000.0000.0000 band : Indicates the band supported for card. Possible values [ BandIdentification_cBand,BandIdentification_lBand,BandIdentification_coarseBand,BandIdentification_notMeaningful,BandIdentification_cPlusCoarseBand,BandIdentification_cAndSBand,BandIdentification_cAndLBand ] protection : Represents physical connection is protected or not. Possible values [ Unprotected,protected ] otdrSummary : Possible values [ OTDRSCAN_NOTAPPLICABLE ] olcState : Possible values [ OlcState_InService,OlcState_Maintenance ] npaUserLabel : userlabel of NPA. mostRecentNote : Indicates most recent note on physical connection. fiberAscStatus : Indicates fiber association status.Possible values [ Boolean_false, Boolean_true] isDarkFiberAssociated : Indicates whether dark fiber associated to physical connection.Possible values [ Boolean_false, Boolean_true] clusterLink : Indicates whether its cluster link.Possible values [ ClusterLink_normal,ClusterLink_cluster ] asapStatus : Indicates status of asap.Possible values [ AsapStatus_notset,AsapStatus_enabled ] lowlinkUtilThreshold : Indicates lower threshold of link utilisation. highlinkUtilThreshold : Indicates higher threshold of link utilisation. linkUtilProfileName : Indicates profile name of link utilisation. linkUtilRatio : Indicates ratio of link utilisation. currentlinkUtilRatio : Indicates ratio of current link util. overlaplinkUtilRatio : Indicates ratio of overlap link util. olpAssociatedLink : Indicates links associated to olp. noCommandToNe : Represents whether commands need to be sent to NE or not.Possible values [ Boolean_false, Boolean_true] consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] subseaLink : Represents physical connection is subsea link or not. Possible values [ Boolean_false, Boolean_true] ramanPresent : Represents raman amplifier present or not. modificationTime : Represents modification time of physical connection. modifiedBy : Represents name of the user who has modified physical connection. createdBy : Represents name of the user who has created physical connection. uptimeOpstateMs : Operation state uptime in milli seconds. uptimeUasMs : Indicates uptime. labelName : Represents label added by user on physical connection. discoveredSubseaLink : Indicates PSI-CL physical connection. -------------------------------------------------------------------------------------------------------
156. GET/data/npr/wdmPorts This is used to retrieve all the ports.

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the port, can be retrieved as IdClass from /data/npr/ports?guiLabel={userLabel} accessPortRole : AccessPortRole_notMeaningful alarmStatus : AlarmStatus of the port. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] boardType : Represents board type of the port. cardType : Represents card type. clonePortPresent : Represents clone port present or not.Possible values [ Boolean_false, Boolean_true] compModule : Represents computational module. consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] currentFrequency : Represents RX frequency of port. designatedPortMode : WdmTransMode_notMeaningful direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] displayLabel : Display label of the port. encoding : Possible values [ Encoding_notMeaningful,Encoding_nrz,Encoding_psbt,Encoding_dpsk,Encoding_pdpsk,Encoding_pdmbpsk,Encoding_pdmqpsk,Encoding_qam8,Encoding_qam16,Encoding_spqpsk,Encoding_pbsk,Encoding_qam16250g,Encoding_qam64,Encoding_qpskabs,Encoding_coherent ] ethInterfaceRate : Ethernet interface rate.Possible values [ EthInterfaceRate_ethFE,EthInterfaceRate_eth1GE,EthInterfaceRate_eth10GE,EthInterfaceRate_notMeaningful,EthInterfaceRate_eth40GE,EthInterfaceRate_eth100GE ] ethInterfaceType : Ethernet interface type.Possible values [ EthInterType_notApplicable,EthInterType_eth10BaseTFD,EthInterType_eth10BaseTHFD,EthInterType_eth100BaseTXFD,EthInterType_eth100BaseTXHD,EthInterType_eth100BaseFXFD,EthInterType_eth1000BaseSXFD,EthInterType_eth1000BaseLXFD,EthInterType_eth1000BaseTFD,EthInterType_eth1000BaseXFD,EthInterType_eth1000BaseCXFD,EthInterType_eth10GBaseLR,EthInterType_eth10GbaseER,EthInterType_eth10GBaseSR,EthInterType_eth10GBaseR ] fdnMapper : NC_n=*EML_101_SNA/NE_n=*1/PTPn=*SFD-41-1-9410/:PORT fecType : Possible values [ FecType_notMeaningful,FecType_nofec,FecType_sfec,FecType_efec,FecType_ufec,FecType_efec2,FecType_afec,FecType_sdfec,FecType_sdfec_g2,FecType_fec802_3bjFE,FecType_sdfec_acc ] frequency : Frequency of the port. internalEmlAid : Internal eml aid. involvedIn3R : Indicates port involved in 3R or not.Possible values [ Boolean_false, Boolean_true] involvedOnInternalCable : Indicates port involved in internal connection or not.Possible values [ Boolean_false, Boolean_true] involvedOnPhyConn : Indicates port involved in physical connection or not.Possible values [ Boolean_false, Boolean_true] neId : Unique Identifier of the network element [NE]. neLabel : Userlabel of the network element [NE]. networkInterfaceType : Network interface type.Possible values [ NetworkInterfaceType_notMeaningful,NetworkInterfaceType_uni,NetworkInterfaceType_nni ] operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otuSignalType : Represents the signal type of the port. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] physicalPortType : Represents physical port type.Possible values [ PortType_stm1,PortType_stm4,PortType_stm16,PortType_c4,PortType_c3,PortType_c12,PortType_c2,PortType_stm64,PortType_stm0,PortType_c345Mb,PortType_c3C12,PortType_c4Conf,PortType_c3Conf,PortType_c4C12Conf,PortType_c3C12Conf,PortType_c4conc4,PortType_c4conc16,PortType_c4conc64,PortType_ec1,PortType_oc3,PortType_oc12,PortType_oc48,PortType_oc192,PortType_ds3,PortType_sts1,PortType_sts3c,PortType_sts12c,PortType_sts48c,PortType_sts192c,PortType_c12HDSL,PortType_ethFast_rateAdapt,PortType_eth100Mb_transp,PortType_eth1Gb_rateAdapt,PortType_eth1Gb_transp,PortType_fddi,PortType_escon,PortType_digitalVideo,PortType_fiberChannel,PortType_isaPrea,PortType_isaPr,PortType_ethFeb6,PortType_ethFast_rateAdaptLCAS,PortType_eth1Gb_rateAdaptLCAS,PortType_isaPreaLCAS,PortType_ethFast_rateAdaptLCAS_GMII,PortType_eth10Gb_rateAdaptLCAS,PortType_digitalVideoBroadcasting,PortType_ethFast_rateAdaptEnabledLCAS,PortType_ethEvpl_rateAdapt,PortType_eth10Gb_MultiService,PortType_eth1GbGfpTransp,PortType_notMeaningful,PortType_fiberChannelGfpTransp,PortType_ethernet,PortType_eth10Gb_ES64,PortType_oc1,PortType_oc768,PortType_stm256,PortType_ethStm16TrunkPR,PortType_ethStm64TrunkPR,PortType_c11 ] portBitRate : Port bit rate. id : Unique identifier of the port. key : AllPortsUI/2165 className : Name of class for physical connection:AllPortsUI sdiRate : Possible values [ SdiRate_notApplicable,SdiRate_nominal,SdiRate_subrate ] technology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] uplink : Represents is card uplink.Possible values [ Boolean_false, Boolean_true] uploadSt : Indicates upload status.Possible values [ normal,uploading,notFound,wrong ] usedDir : Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] usedOnOtn : Represents port is used in OTN connection.Possible values [ Boolean_false, Boolean_true] guiLabel : Userlabel of the port. wdmClientSignalType : Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] wdmInterfaceType : Possible values [ WdmInterfaceType_blackAndWhite,WdmInterfaceType_coloredDense,WdmInterfaceType_coloredCoarse ] wdmPhysicalPortRate : Represents physical port rate. wdmPortType : Possible values [ WdmPortType_ops0,WdmPortType_ots,WdmPortType_otsReg ] wdmTransmissionMode : Possible values [ WdmTransMode_notMeaningful,WdmTransMode_crossRegen,WdmTransMode_addDrop,WdmTransMode_regen,WdmTransMode_addOnly,WdmTransMode_dropAndContinue,WdmTransMode_dropOnly,WdmTransMode_thru ] width : Represents width. ----------------------------------------------------------------------------------------------------
157. GET/data/npr/Port This API is used to retrieve all the ports

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the port, can be retrieved as IdClass from /data/npr/ports?guiLabel={userLabel} accessPortRole : AccessPortRole_notMeaningful alarmStatus : AlarmStatus of the port. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] boardType : Represents board type of the port. cardType : Represents card type. clonePortPresent : Represents clone port present or not.Possible values [ Boolean_false, Boolean_true] compModule : Represents computational module. consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] currentFrequency : Represents RX frequency of port. designatedPortMode : WdmTransMode_notMeaningful direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] displayLabel : Display label of the port. encoding : Possible values [ Encoding_notMeaningful,Encoding_nrz,Encoding_psbt,Encoding_dpsk,Encoding_pdpsk,Encoding_pdmbpsk,Encoding_pdmqpsk,Encoding_qam8,Encoding_qam16,Encoding_spqpsk,Encoding_pbsk,Encoding_qam16250g,Encoding_qam64,Encoding_qpskabs,Encoding_coherent ] ethInterfaceRate : Ethernet interface rate.Possible values [ EthInterfaceRate_ethFE,EthInterfaceRate_eth1GE,EthInterfaceRate_eth10GE,EthInterfaceRate_notMeaningful,EthInterfaceRate_eth40GE,EthInterfaceRate_eth100GE ] ethInterfaceType : Ethernet interface type.Possible values [ EthInterType_notApplicable,EthInterType_eth10BaseTFD,EthInterType_eth10BaseTHFD,EthInterType_eth100BaseTXFD,EthInterType_eth100BaseTXHD,EthInterType_eth100BaseFXFD,EthInterType_eth1000BaseSXFD,EthInterType_eth1000BaseLXFD,EthInterType_eth1000BaseTFD,EthInterType_eth1000BaseXFD,EthInterType_eth1000BaseCXFD,EthInterType_eth10GBaseLR,EthInterType_eth10GbaseER,EthInterType_eth10GBaseSR,EthInterType_eth10GBaseR ] fdnMapper : NC_n=*EML_101_SNA/NE_n=*1/PTPn=*SFD-41-1-9410/:PORT fecType : Possible values [ FecType_notMeaningful,FecType_nofec,FecType_sfec,FecType_efec,FecType_ufec,FecType_efec2,FecType_afec,FecType_sdfec,FecType_sdfec_g2,FecType_fec802_3bjFE,FecType_sdfec_acc ] frequency : Frequency of the port. internalEmlAid : Internal eml aid. involvedIn3R : Indicates port involved in 3R or not.Possible values [ Boolean_false, Boolean_true] involvedOnInternalCable : Indicates port involved in internal connection or not.Possible values [ Boolean_false, Boolean_true] involvedOnPhyConn : Indicates port involved in physical connection or not.Possible values [ Boolean_false, Boolean_true] neId : Unique Identifier of the network element [NE]. neLabel : Userlabel of the network element [NE]. networkInterfaceType : Network interface type.Possible values [ NetworkInterfaceType_notMeaningful,NetworkInterfaceType_uni,NetworkInterfaceType_nni ] operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otuSignalType : Represents the signal type of the port. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] physicalPortType : Represents physical port type.Possible values [ PortType_stm1,PortType_stm4,PortType_stm16,PortType_c4,PortType_c3,PortType_c12,PortType_c2,PortType_stm64,PortType_stm0,PortType_c345Mb,PortType_c3C12,PortType_c4Conf,PortType_c3Conf,PortType_c4C12Conf,PortType_c3C12Conf,PortType_c4conc4,PortType_c4conc16,PortType_c4conc64,PortType_ec1,PortType_oc3,PortType_oc12,PortType_oc48,PortType_oc192,PortType_ds3,PortType_sts1,PortType_sts3c,PortType_sts12c,PortType_sts48c,PortType_sts192c,PortType_c12HDSL,PortType_ethFast_rateAdapt,PortType_eth100Mb_transp,PortType_eth1Gb_rateAdapt,PortType_eth1Gb_transp,PortType_fddi,PortType_escon,PortType_digitalVideo,PortType_fiberChannel,PortType_isaPrea,PortType_isaPr,PortType_ethFeb6,PortType_ethFast_rateAdaptLCAS,PortType_eth1Gb_rateAdaptLCAS,PortType_isaPreaLCAS,PortType_ethFast_rateAdaptLCAS_GMII,PortType_eth10Gb_rateAdaptLCAS,PortType_digitalVideoBroadcasting,PortType_ethFast_rateAdaptEnabledLCAS,PortType_ethEvpl_rateAdapt,PortType_eth10Gb_MultiService,PortType_eth1GbGfpTransp,PortType_notMeaningful,PortType_fiberChannelGfpTransp,PortType_ethernet,PortType_eth10Gb_ES64,PortType_oc1,PortType_oc768,PortType_stm256,PortType_ethStm16TrunkPR,PortType_ethStm64TrunkPR,PortType_c11 ] portBitRate : Port bit rate. id : Unique identifier of the port. key : AllPortsUI/2165 className : Name of class for physical connection:AllPortsUI sdiRate : Possible values [ SdiRate_notApplicable,SdiRate_nominal,SdiRate_subrate ] technology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] uplink : Represents is card uplink.Possible values [ Boolean_false, Boolean_true] uploadSt : Indicates upload status.Possible values [ normal,uploading,notFound,wrong ] usedDir : Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] usedOnOtn : Represents port is used in OTN connection.Possible values [ Boolean_false, Boolean_true] guiLabel : Userlabel of the port. wdmClientSignalType : Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] wdmInterfaceType : Possible values [ WdmInterfaceType_blackAndWhite,WdmInterfaceType_coloredDense,WdmInterfaceType_coloredCoarse ] wdmPhysicalPortRate : Represents physical port rate. wdmPortType : Possible values [ WdmPortType_ops0,WdmPortType_ots,WdmPortType_otsReg ] wdmTransmissionMode : Possible values [ WdmTransMode_notMeaningful,WdmTransMode_crossRegen,WdmTransMode_addDrop,WdmTransMode_regen,WdmTransMode_addOnly,WdmTransMode_dropAndContinue,WdmTransMode_dropOnly,WdmTransMode_thru ] width : Represents width. ----------------------------------------------------------------------------------------------------
158. GET/data/npr/asonPotentialLinks This API retrieves all the ASON potential links

     • Response

       • Changed response : [200]//Response is list of ASON potential links
         • New body: 'application/json'
         • Deleted body: '*/*'
159. GET/data/npr/FiberChar This is used to retrieve all the FiberCharacteristics

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Class id of the fiber characteristics, can be retrieved as IdClass from /data/npr/FiberChar?id={id} bandStr : Represents band of the connection. baselineSpanLoss : Represents base line span loss. calcSpanLoss : Indicates calucated span loss. commSpanLoss : comm span loss value. connectId : Unique indentifier of the connection. egressPowerOut : Indicates egress power out. fiberLength : Indicates fiber length. fiberLengthSource : Indicates fiber length of source. fiberType : Indicates type of the fiber. Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] fromLabel : Represents 'from' end port label. gainStr : Represents gain. id : Unique identifier of fiber characteristics. key : FiberChar/96 className : Name of the class : FiberChar ingGainStr : Indicates in gain. ingMaxGainStr : Indicates maximum in gain. ingMinGainStr : Indicates minimum in gain. ingressPowerIn : Indicates ingress power in. maxGainStr : Indicates maximum gain. maxSpanLoss : Indicates maximum span loss. minGainStr : Indicates minimum gain. minSpanLoss : Indicates minimum span loss. portId : Unique identifier of the port. ramanGainStr : Indicates raman amplifier gain. spanLoss : Indicates span loss. targetGainStr : Indicates target gain. toLabel : Represents 'to' end port label. otdrSpanLossStr : Represents otdr span loss. otdrSpanLossDate : Represents otdr span loss occurred date. fiberLatency : Represents fiber latency. ------------------------------------------------------------------------------------------------------
160. GET/data/npr/Node This is used to retrieve all the Node level details.

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed IdClass : Identifier for the class of the NE. alarmSyntesis : Alarm synthesis status. Possible Values are: cleared, activeReportableIndeterminate, activeReportableWarning, activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending, notApplicable. asonCtrPlaneType : Type of ASON control plane. Possible Values are: notApplicable, sdh, ocs, phn, ocsAndPhn. cTAccessStatus : CT access status. Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comment1 : Additional comment field. comment2 : Additional comment field. communicationState : Current communication state. Possible values are: available, partiallyUnavailable, unavailable, notProvided. ethPresent : Indicates if Ethernet is supported. hierarchySubnet : Identifier for the hierarchy subnet. isMultiNEs : Indicates if multiple NEs are present. localization : Localization information for NE. mibAlignmentState : MIB alignment state. neAlignment : Alignment status of the NE. neSubType : Subtype of the NE. id : Unique identifier of the NE. key : FDN (Fully Distinguished Name) or unique path reference for the NE. loopbackIp : Loopback IP address of the NE. secondaryAddress : Secondary IP address of the NE. className : Class name of the NE. otnConfDownldSt : OTN configuration download status. parentId : Identifier for the parent NE. parentLabel : Label for the parent NE. position : Physical or logical position of the NE. sdhPresent : Indicates if SDH is supported. supervisionState : Current supervision state. guiLabel : GUI label for the NE. version : Current version of the NE. wdmPresent : Indicates if WDM is supported. confDownldSt : Configuration download status. Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. nadString : NAD string. productName : Product name of the NE. reachable : Indicates if NE is reachable. shortProductName : Short product name of the NE. siteName : Site name associated with the NE. nodeType : Type of the node. emlNeType : Type of EML NE. comment3 : Additional comment field. associationPresent : Indicates if association is present. neSubRelease : Sub-release version of the NE. associatedPtnNeId : Identifier for associated PTN NE. comments : Additional comments. actualRelease : Actual release version of the NE. auditStatus : Audit status. configNeStatus : Configuration status of the NE. newCommunicationState : Updated communication state. newSupervisionState : Updated supervision state. alignmentState : Current alignment state. creationDate : Date of creation. modifiedDate : Date of last modification. nodeModifiedDate : Date of last modification for the node. createdBy : Identifier of the creator. modifiedBy : Identifier of the last modifier. latestNote : Most recent note added. scheduledForGri : Scheduled GRI information. systemAbnormalState : Indicates if any abnormal system state is present. systemMode : Current system mode. ------------------------------------------------
161. GET/data/npr/Ne This is used to retrieve all the NE level details.

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass: Identifier for the class of the Ne. accessModule: Access module status. Possible Values are :none,fe,ge, gx. alarmStatus: Current status of any alarms.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmSyntesis: Alarm synthesis status.Possible Values are : cleared, activeReportableIndeterminate,activeReportableWarning,activeReportableMinor, activeReportableMajor, activeReportableCritical, activePending,notApplicable. alarmsEnabled: Indicates if alarms are enabled. alarmsEnabledLP: Indicates if alarms are enabled for LP. alignAct: Current alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alignActPend: Pending alignment action.Possible values are :audit,download,notApplicable,internalConsistency,lock. alrAligned: Indicates if alarms are aligned. alrAlignment: Status of alarm alignment.Possible Values are : normal,failed,inProgress,notApplicable. asonCtrPlaneType: Type of ASON control plane.Possible Values are : notApplicable,sdh,ocs, phn,ocsAndPhn. assignSt: Current assignment state.Possible values are: AssignmentState_free, AssignmentState_assigned, AssignmentState_observed, AssignmentState_failToAssign, AssignmentState_failToObserve, AssignmentState_notApplicable. associatedNode: Identifier for the associated node. associatedNodeId: Identifier for the associated node ID. autoAlarmSyncro: Indicates if automatic alarm synchronization is enabled.Possible values are: EnablingState_enabled, EnablingState_disabled. availableCapNum: Number of available capacity. cTAccessStatus: CT access status.Possible values are: ctConnEnab, ctConnDisab, ctNotConEnab, ctNotConDisab, notProvided, partiallyGranted. comments: Additional comments. communicationState: Current communication state.Possible values are: available, partiallyUnavailable, unavailable, notProvided. confDownldSt: Configuration download status.Possible values are: enabled, disabled, enabling, disabling, failToEnable, failToDisable. confMismatchObjsCount: Count of configuration mismatch objects. confType: Type of configuration.Possible values are: ConfType_notMeaningful, ConfType_cnf1641sx, ConfType_cnf1641smC, ConfType_cnf1641sm, ConfType_cnf1651smC, ConfType_cnf1651smNull, ConfType_cnf1651smFull, ConfType_cnf1661smCNull, ConfType_cnf1661smCFull, ConfType_cnf1664sm, ConfType_cnf1631fox, ConfType_cnf1654sl, ConfType_cnf1664sl, ConfType_cnf9600luM, ConfType_cnf9600luH, ConfType_cnf1641smT, ConfType_cnf1664sx, ConfType_cnf1660sm, ConfType_cnf1686lt, ConfType_cnf1686lr, ConfType_cnf1686or, ConfType_cnf1640wm_lt, ConfType_cnf1640wm_lr, ConfType_cnfuhrc, ConfType_cnfuhr, ConfType_cnfuhmc, ConfType_cnfuhm, ConfType_cnf1666_55sr, ConfType_cnfOps, ConfType_cnf1678mccNoLo, ConfType_cnf1678mccLo, ConfType_troadm, ConfType_roadm, ConfType_cnf1643am_stm1, ConfType_tss5_siu, ConfType_tss5_eiu, ConfType_tss5_tiu, ConfType_pss1830. consistPhase: Current consistency phase.Possible values are: ConsistPhase_allLayersProcessed, ConsistPhase_someLayerSkipped, ConsistPhase_processingNe, ConsistPhase_processingSdhPort, ConsistPhase_processingMsTp, ConsistPhase_processingMsProt4F, ConsistPhase_processingMsProt2F, ConsistPhase_processingHoCtp, ConsistPhase_pmTpUnderHoCtp, ConsistPhase_processingPdhPort, ConsistPhase_processingNap, ConsistPhase_pmTpUnderNap, ConsistPhase_processingAu4RTM, ConsistPhase_processingAu4SQT, ConsistPhase_processingHoCointo, ConsistPhase_processingCap, ConsistPhase_pmTpUnderCap, ConsistPhase_processingLoCtp, ConsistPhase_pmTpUnderLoCtp, ConsistPhase_processingLoCointo, ConsistPhase_processingWdmPort, ConsistPhase_processingWdmClientPort, ConsistPhase_processingWdmMstp, ConsistPhase_processingWdmCtp, ConsistPhase_processingWdmClientCtp, ConsistPhase_processingWdmTtp, ConsistPhase_tcmOnHoCtp, ConsistPhase_tcmOnLoCtp, ConsistPhase_tctOnNap, ConsistPhase_tctOnCap, ConsistPhase_tctOnHoCtp, ConsistPhase_tctOnLoCtp, ConsistPhase_pmTpUnderTcmOnHoCtp, ConsistPhase_pmTpUnderTcmOnLoCtp, ConsistPhase_pmTpUnderTctOnNap, ConsistPhase_pmTpUnderTctOnCap, ConsistPhase_pmTpUnderTctOnHoCtp, ConsistPhase_pmTpUnderTctOnLoCtp, ConsistPhase_processingXdslPort, ConsistPhase_processingWdmOchCointo, ConsistPhase_processingWdmClientCointo, ConsistPhase_processingMsProtLin, ConsistPhase_pmTpUnderWdmClientCtp, ConsistPhase_processingSnc, ConsistPhase_processingSnppLink, ConsistPhase_processingControlPlane, ConsistPhase_processingWdmOtuCtp, ConsistPhase_processingWdmOtuCap, ConsistPhase_processingWdmOdu3Ctp, ConsistPhase_processingWdmOdu2Ctp, ConsistPhase_processingWdmOdu1Ctp, ConsistPhase_processingWdmOdu3Cap, ConsistPhase_processingWdmOdu2Cap, ConsistPhase_processingWdmOdu1Cap, ConsistPhase_processingWdmOtuCointo, ConsistPhase_processingWdmOdu3Cointo, ConsistPhase_processingWdmOdu2Cointo, ConsistPhase_processingWdmOdu1Cointo, ConsistPhase_processingWdmOmsCtp, ConsistPhase_processingWdmOmsCointo, ConsistPhase_processingWdmClientTtp, ConsistPhase_tcmOnOdu3Ctp, ConsistPhase_tcmOnOdu2Ctp, ConsistPhase_tcmOnOdu1Ctp, ConsistPhase_tcmOnOdu3Cap, ConsistPhase_tcmOnOdu2Cap, ConsistPhase_tcmOnOdu1Cap, ConsistPhase_processingWdmOdu0Ctp, ConsistPhase_processingWdmOdu0Cap, ConsistPhase_processingWdmOdu0Cointo, ConsistPhase_tcmOnOdu0Ctp, ConsistPhase_tcmOnOdu0Cap, ConsistPhase_processingWdmOdu4Ctp, ConsistPhase_processingWdmOdu4Cap, ConsistPhase_processingWdmOdu4Cointo, ConsistPhase_tcmOnOdu4Ctp, ConsistPhase_tcmOnOdu4Cap. consistSt: Consistency status.Possible values are: normal, notFound, ghost, notValid, unknown, checking, notMeaningful, notChecked, misaligned, notAligned, failedToAlign, consistencyMismatch, aligning, normalAudit, notApplicable. controlPlaneStatus: Status of the control plane.Possible values are: ControlPlaneStatus_notPresent, ControlPlaneStatus_notManaged, ControlPlaneStatus_reachable, ControlPlaneStatus_notReachable. creationDate: Date of creation. neCreationDate: NE creation date in milliseconds since epoch. modifiedDate: Date of last modification. neModifiedDate: NE modified date. dbModByCT: Indicates if modified by CT. emlDomId: Identifier for EML domain. neNativeName: Native name of the NE. emlNeId: Identifier for EML NE. emlNeType: Type of EML NE. ethSupported: Indicates if Ethernet is supported. failToAlignObjsCount: Count of objects that failed to align. fdnMapper: FDN mapper information. fdnMapperNum: Number of FDN mappers. ipAddress: IP address of the NE. isPrimaryNE: Indicates if this is a primary NE. mainNTPAddress: Main NTP address. managedInterfaces: Managed interfaces information.Possible values are: MngInterface_notMeaningful, MngInterface_q3, MngInterface_snmp, MngInterface_q3AndSnmp, MngInterface_xos, MngInterface_xosAndSnmp. managerList: List of managers. masterShelfType: Type of the master shelf. mibAlignmentState: MIB alignment state.Possible values are: Mibaligned, Mibmisaligned, MibnotProvided, MibaligningUp, MibaligningDown, MibinConfig, Mibauditing, MibpartiallyAligned, Mibtransient. nadString: Identifier for network address descriptor. namingMask: Naming mask. neAlignment: Status of NE alignment.Possible values are: normal, failed, inProgress, unknown. neCommProb: Current communication problem status.Possible values are: none, neUnreachable, recovering. neFamily: Family type of the NE. id: Unique identifier for the NE. key: Reference key for tracking. className: Class designation of the NE. neNotEmlAligned: Status of alignment for non-EML.Possible values are: aligned, misaligned, auditing, waitForAudit, failed. neSubType: Subtype of the NE.Possible values are: repeater, notRepeater, notMeaningful, dge, filterlessDge, branchUnit. neType: Type of the NE. notAlignObjsCount: Count of objects not aligned. ntpEnabled: Indicates if NTP is enabled. quarantineState: Current quarantine state.Possible values are: QuarantineState_down, QuarantineState_up. interfaceMode: Interface mode.Possible values are: noSuchObject, 1, 2. ntpReachabilityStatus: NTP reachability status. otnConfDownldSt: OTN configuration download status.Possible values are: enabled, disabled, partiallyDisabled, notMeaningful. partnerNEGroupId: Identifier for partner NE group. partnerNEIP: IP address of the partner NE. partnerNEId: Identifier for partner NE. pdhSupported: Indicates if PDH is supported. pmMisalignment: Indicates if PM misalignment is present. primLogin: Primary login information. primaryOperationalState: Current operational state of the primary NE. productName: Name of the product. radioSupported: Indicates if radio is supported. reachable: Indicates if the NE is reachable. resetSt: Current reset state.Possible values are: notReset, reset, resetting. sdhSupported: Indicates if SDH is supported. secondaryAddress: Secondary address. secondaryOpState: Secondary operational state. securComm: Secure communication status. shortProductName: Short name of the product. siteName: Name of the site. snmpVersion: SNMP version. snmpv3AuthMethod: SNMPv3 authentication method. snmpv3PrivMethod: SNMPv3 privacy method. snmpv3SecLevel: SNMPv3 security level. snmpv3UsmUser: SNMPv3 USM user. snmpTrapNotification: SNMP trap notification. sonetSupported: Indicates if SONET is supported. spareNTPAddress: Spare NTP address. ssh2PublicKeyFile: SSH public key file. ssh2User: SSH user. supervisionState: Current supervision state.Possible values are: declared, activating, supervised, deactivating, notProvided, partiallySupervised, transient. supportedConnectId: Supported connection identifier. tid: Identifier for transaction. traffAffectNotAlignCount: Count of traffic affecting non-aligned objects. tsdImVersion: Version of TSD IM NE. uploadSt: Current upload status.Possible values are: normal, uploading, notFound, wrong. guiLabel: Label for graphical user interface representation. version: Version of the NE software. wdmManagement: Management type for WDM.Possible values are: wdmAppl, sdhAppl, wdmAndSdhAppl. wdmSupported: Indicates if WDM is supported. wrkSt: Current working state. controlPlaneDomId: Identifier for control plane domain. loopbackIp: Loopback IP address. details5: Additional details. syncProtocol: Synchronization protocol type.Possible values are: default, ftp, snmp. lastControlOper: Last control operation. lastControlOperSt: Status of the last control operation. operationPercentage: Percentage of operation. isuSt: ISU state. sysType: System type. rlsidActive: Active RLS ID. rlsidCommited: Committed RLS ID. rlsidWorking: Working RLS ID. downloadAlarm: Download alarm status. timeZone: Time zone information. activeIpAddress: Active IP address. scheduledForGri: Scheduled GRI status.Possible values are: scheduled, partiallyScheduled, unscheduled. systemMode: System mode type. nodeType: Type of the node. objectIdentifier: Object identifier. lastChangeTime: Last change time. ntpSyncStatus: NTP sync status.Possible values are: notMeaningful, freeRunning, holdover, NTPSync, NTPSyncRedundant. secondaryIpAddress: Secondary IP address. autoState: Auto state. floor: Floor information. latitude: Latitude coordinate. longitude: Longitude coordinate. timeZoneMismatch: Time zone mismatch information. powerConsumption: Power consumption value. powerConsumptionLevel: Power consumption level.Possible values are: default, HIGH, MEDIUM, LOW. powerAdminState: Power administrative state.Possible values are: PowerDISABLED, PowerENABLED, PowerDEFAULT. isGNE: Indicates if this is a GNE. emissionFactor: Emission factor. fixedCurrent: Fixed current value. fixedVoltage: Fixed voltage value. actualRelease: Actual release version. model: Model name. createdBy: User who created the NE. modifiedBy: User who last modified the NE. configNeStatus: Configuration NE status.Possible values are: Installed, RemoveFromService. energyEfficiency: Energy efficiency metrics. healthCheckPercentage: Percentage for health check. healthCheckStatus: Status of health check.Possible values are: HealthCheckStatus_UNKNOWN, HealthCheckStatus_HEALTHY, HealthCheckStatus_UNHEALTHY, HealthCheckStatus_DEGRADED. cardDirection: Direction of the card.Possible values are: CardnotMeaningful, Cardtransmitter, Cardreceiver. newCommunicationState: New communication state.Possible values are: UNKNOWN, UP, DOWN, PARTIAL, NA. newSupervisionState: New supervision state. alignmentState: Current alignment state.Possible values are: UNKNOWN, MISALIGNED, READY_TO_ALIGN, ALIGNING_UP, ALIGNED, PARTIAL (applicable only for Node), NA, QUARANTINED. lastSupervisionTime: Last supervision time. lastAlignmentTime: Last alignment time. granularCommStates: List of granular communication states. alignmentQuarantineState: Current alignment quarantine state. otnObjectName: Name of the OTN object. objectId: Unique object identifier. implementingClassName: Implementing class name. objectClass: Class of the object. objectIdClass: Class of the object ID. ----------------------------------------
162. GET/data/npr/assocSltes This is used to retrieve all the associated repeaters.

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. IdClass : Identifier for the class of the associated repeaters. connectId : Unique indentifier of the connection. direction : Direction of the port.Possible values are: Direction_bidirectional,Direction_sink,Direction_source,Direction_notMeaningful and Direction_unidirectional. id : Unique identifier of the AssocSlte. key : Reference key for tracking. Possible value is AssocSlte/2 className : Class designation of the NE. nodeId : Unique identifier of the Transmitter/Receiver node. nodeType : Type of Transmitter/Receiver node. prtUserLabel : User label of the prot which involved in the connection.n slteUserLabel : UserLabel of Associated Repeater. --------------------------------------------------------------------------------------------------
163. GET/data/npr/ne/name Retrieves the NPR NE name of the given NPR NE id

     • Response

       • 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.
164. 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.
165. GET/data/npr/linkAsons/{linkId}/trafficMapL0 The API is used to retrieve the list of client ASON SNCs

     • Response

       • Changed response : [200]//List of SncInLink
         • New body: 'application/json'
         • Deleted body: 'text/xml'
         • Deleted body: 'application/json;charset=UTF-8'
166. GET/data/npr/linkAsons/{linkId}/trafficMapL1 The API is used to retrieve the list of client ASON SNCs

     • Response

       • Changed response : [200]//List of SncInLink
         • New body: 'application/json'
         • Deleted body: 'text/xml'
         • Deleted body: 'application/json;charset=UTF-8'
167. GET/data/npr/linkAsons/{linkAsonId}/sharedRiskGroups The API is used to retrieve the SRGs of an ASON link

     • Response

       • Changed response : [200]//List of SRGs
         • Deleted body: 'text/xml'
168. GET/data/asonNBI/linkAsons/{linkAsonId}/sharedRiskGroups The API is used to retrieve the SRGs of an ASON link

     • Response

       • Changed response : [200]//List of SRGs
         • Deleted body: 'text/xml'
169. GET/data/npr/linkAsons/{linkAsonId}/serverSharedRiskGroups This API is used to retrieve the server-side SRGs of an ASON link

     • Response

       • Changed response : [200]//List of server side SRG
         • Deleted body: 'text/xml'
170. GET/data/asonNBI/linkAsons/{linkAsonId}/serverSharedRiskGroups This API is used to retrieve the server-side SRGs of an ASON link

     • Response

       • Changed response : [200]//List of server side SRG
         • Deleted body: 'text/xml'
171. GET/data/npr/linkAsons/{linkAsonId}/serverPhysicalConns This API retrieves the server-side physical connections of an ASON link

     • Response

       • Changed response : [200]//List of PhysicalConn
         • Deleted body: 'text/xml'
172. GET/data/npr/linkAsons/pie This API is used to get the pie chart for ASON links administration state

     • Response

       • Changed response : [200]// Additional info: The response contains the response status and pie chart details which contains count of links Admin State in locked, unlocked, notApplicable and unknown State. | seeAlso :: /data/npr/linkAsons
173. GET/data/npr/linkAsons/asonLinkAdmState/{admState} Retrieves ASON links with the specified administrative state

     • Response

       • Changed response : [200]//List of LinkAson
         • Deleted body: 'text/xml'
174. GET/data/npr/colorProfiles/{colorProfileId}/elem Retrieve elementary details of Color Profiles

     • Parameters

       • DeleteAcceptin header

     • Response

       • Changed response : [200]//List of ColorProfile
175. GET/data/npr/colorProfiles/{colorProfileId}/asonLinkColProf Retrieves ASON links associated to a colorprofile by colorprofileId

     • Parameters

       • DeleteAcceptin header

     • Response

       • Changed response : [200]//List of ASON links
176. GET/data/npr/colorProfiles/{colorProfileId}/teLinkColProf Retrieve Telinks associated to color profile

     • Parameters

       • DeleteAcceptin header

     • Response

       • Changed response : [200]//List of TeLinks
177. GET/data/npr/colorProfiles/{colorProfileId}/asonSncColProf Retrieves ASON SNCs associated to colorprofile

     • Parameters

       • DeleteAcceptin header

     • Response

       • Changed response : [200]//List of ASON SNCs
178. GET/data/common/userchannel/

     • Response

       • Changed response : [200]//Obtained userchannel successfully
         • New body: 'application/json'
         • Deleted body: 'application/text'
179. GET/data/common/server/timezone Get server timezone for requested user

     • Response

       • Changed response : [200]//Retrieved server timezone successfully
180. GET/data/ason/telink/name Retrieves the ASON telink name for the given ASON telink id

     • Response

       • 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.
181. GET/data/ason/telink/id Retrieves the ASON telink id of the given ason te`link name

     • Response

       • 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.
182. GET/data/ason/srg/name Retrieves the srg name of the given srg id.

     • Response

       • 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.
183. 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.
184. GET/data/ason/snc/name Retrieves the ASON SNC name for the given ASON SNC id.

     • Response

       • 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.
185. 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.
186. GET/data/ason/phyconn/name Retrieves the phyconn name of the given phyconn id.

     • Response

       • 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.
187. GET/data/ason/phyconn/id Retrieves the phyconn id of the given phyconn name.

     • Response

       • 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.
188. GET/data/ason/npa/name Retrieves the ASON NPA name for the given ASON NPA id.

     • Response

       • 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.
189. 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.
190. GET/data/ason/link/name Retrieves the ASON link name of the given ASON link id.

     • Response

       • 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.
191. 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.
192. GET/asap/asaplist24x/{groupId}/{neId}/{portname}/{category}

     • Response

       • New response : [500]//Internal server error
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> string)

193. GET/asap/asaplist/{groupId}/{neId}/{portname}/{categories}

     • Response

       • New response : [500]//Internal server error
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> string)

194. GET/asap/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories}

     • Response

       • New response : [500]//Internal server error
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> string)

195. GET/asap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}

     • Response

       • New response : [500]//Internal server error
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> string)

196. GET/data/otn/otdrscaninfo/physicalconn/{physConnId} Retrieve scan information for a specific connection.

     • Response

       • New response : [404]//Connection not found
       • New response : [400]//Invalid connection ID provided
       • New response : [500]//Internal server error
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> no schema)

197. GET/data/otn/ports/{id}/loopback Loopbacks are tests that users can initiate to evaluate a circuit or isolate a failure.

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Loopbacks tests and created succesfully at different points in the transmission path

         • Schema

           Changed body: '*/*'
198. POST/data/otn/ports/{id}/loopback Loopbacks are tests that users can initiate to evaluate a circuit or isolate a failure.

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Loopbacks tests and created succesfully at different points in the transmission path

         • Schema

           Changed body: '*/*'
199. PUT/swim/jobs/delete Delete software management Job(s)

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the input data is incorrect
       • Changed response : [200]//Returns the status of the delete operation
200. PUT/ptpclock/{neGroupId}/{neId}/{cardName}/{portId}

     • 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
201. PUT/data/otn/resume/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Resumed job successfully
202. PUT/data/otn/schedule/resume/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Resumed job successfully
203. PUT/data/otn/pause/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Paused the job successfully
204. PUT/data/otn/schedule/pause/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Paused the job successfully
205. GET/otn/schedule/otdr/joblist/{jobHandleId} Retrieve OTDR scan schedule details by jobId.

     • Response

       • New response : [404]//OTDR schedule details not found.
       • New response : [400]//Invalid ID supplied.
       • New response : [500]//Internal server error.
       • Changed response : [200]//Successfully retrieved OTDR scan schedule details.
206. PUT/otn/schedule/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rescheduled the scan job successfully
207. DELETE/otn/schedule/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted the scan job successfully
208. GET/data/otn/otdr/joblist/{jobHandleId} Retrieve OTDR scan schedule details by jobId.

     • Response

       • New response : [404]//OTDR schedule details not found.
       • New response : [400]//Invalid ID supplied.
       • New response : [500]//Internal server error.
       • Changed response : [200]//Successfully retrieved OTDR scan schedule details.
209. PUT/data/otn/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rescheduled the scan job successfully
210. DELETE/data/otn/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted the scan job successfully
211. GET/data/otn/schedule/otdr/joblist/{jobHandleId} Retrieve OTDR scan schedule details by jobId.

     • Response

       • New response : [404]//OTDR schedule details not found.
       • New response : [400]//Invalid ID supplied.
       • New response : [500]//Internal server error.
       • Changed response : [200]//Successfully retrieved OTDR scan schedule details.
212. PUT/data/otn/schedule/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rescheduled the scan job successfully
213. DELETE/data/otn/schedule/otdr/joblist/{jobHandleId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted the scan job successfully
214. PUT/data/otn/otdr/darkfiber/joblist/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rescheduled the OTDR scan job successfully
215. PUT/data/otn/schedule/otdr/darkfiber/joblist/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rescheduled the OTDR scan job successfully
216. PUT/data/otn/modify/linkUtilProfile

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified threshold value of a link utilization profile successfully
217. GET/data/otn/linkUtilProfile

     • Response

       • Changed response : [200]//LinkUtilization Profiles retrieved successfully
218. PUT/data/otn/linkUtilProfile

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified threshold value of a link utilization profile successfully
219. PUT/data/otn/linkUtilProfile/{profileId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified threshold value of a link utilization profile successfully
220. POST/tcaProfiles

     • Request

       • Schema

         Changed body: 'application/json'
221. POST/tcaProfiles/{tcaId}

     • Request

       • Schema

         Changed body: 'application/json'
222. GET/data/otn/otdr/file Download specified OTDR SOR files by file name

     • Response

       • New response : [404]//SOR files not found
       • New response : [500]//Internal server error
       • New response : [400]//Invalid connection SOR file provided
       • Changed response : [200]//Successfully Downloaded the SOR files
223. POST/data/otn/otdr/file

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Downloaded the list of SOR files successfully
224. GET/data/otn/schedule/otdr/file Download specified OTDR SOR files by file name

     • Response

       • New response : [404]//SOR files not found
       • New response : [500]//Internal server error
       • New response : [400]//Invalid connection SOR file provided
       • Changed response : [200]//Successfully Downloaded the SOR files
225. POST/data/otn/schedule/otdr/file

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Downloaded the list of SOR files successfully
226. POST/data/otn/otdr/darkfiber

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Scheduled OTDR dark fiber scan at specified interval successfully
227. POST/data/otn/schedule/otdr/darkfiber

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Scheduled OTDR dark fiber scan at specified interval successfully
228. POST/otn/schedule/otdr

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully scheduled OTDR scan at specified interval
229. POST/data/otn/otdr

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully scheduled OTDR scan at specified interval
230. POST/data/otn/schedule/otdr

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully scheduled OTDR scan at specified interval
231. POST/otn/NBI/Connection/ModifyLabel/{connId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified user label successfully

         • Schema

           Changed body: '*/*'
232. POST/eqm/tl1Request/processTL1Request

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect or incorrect command is sent.
       • Changed response : [200]//Returns the response data for the operation performed.
233. POST/eqm/tl1Request/processTL1Request/{groupId}/{neId}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect or incorrect command is sent.
       • Changed response : [200]//Returns the response data for the operation performed.
234. POST/eqm/setNeParam/neLevel/{groupId}/{neId}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Succesfully updated the NE level attribute
235. POST/eqm/setNeParam/neLevel/powerAdminState

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Sets the powerAdminState to enable/disable as per the request.
236. POST/eqm/cliRequest/processCLIRequest/{groupId}/{neId}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Returns the response data for the command executed.
237. POST/data/plat/userprofile/deletegroup This is used to Delete Group

     • Response

       • Changed response : [200]//Deleted the existing group successfully.
238. POST/data/plat/userprofile/creategroup This is used to Create ACD as a Group

     • Response

       • Changed response : [200]//Created a new group successfully.
239. POST/data/plat/usermgt/updateuser This is used to Update already created User

     • Response

       • Changed response : [200]//Updated user successfully.
240. POST/data/plat/usermgt/createuser Used to Create a new User for wavesuite application

     • Response

       • Changed response : [200]//Created a new user successfully.
241. POST/data/plat/usermgt/changepassword This is used to Change password

     • Response

       • New response : [400]//Password change failed, previous password cannot be used
       • Changed response : [200]//Password changed successfully.
242. GET/data/plat/br/jobs/{jobId} This is used to retrieve Single Backup info

     • Response

       • Changed response : [200]//Backup list retrieved successfully

         • Schema

           Changed body: '*/*'
243. GET/data/plat/br/backups/{jobId} This is used to retrieve specific backup info with id

     • Response

       • Changed response : [200]//Retrieved the restore list successfully.

         • Schema

           Changed body: '*/*'
244. POST/data/plat/br/backups/{jobId} This is used to Restore the specific backup using id

     • Response

       • New response : [400]//Restore failed. Check if HA replication is off, or if restore process is already in progress.
       • Changed response : [200]//Restored successfully.
245. DELETE/data/plat/br/backups/{jobId} This is used to Delete particular backup data

     • Response

       • Changed response : [200]//Deleted specified restored data successfully.
246. POST/data/otn/trail/{connectionIds}/linkUtilization

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Updated link utilization profile successfully
247. POST/data/otn/connection/{connectIds}/asap

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection created successfully

         • Schema

           Changed body: 'application/json'
248. POST/data/otn/otdrscan/setprofile

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//OTDR profile on NE is set
249. POST/data/otn/otdrscan/rebaseline/physicalconn/{phyLinkId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rebaseline for a port is done for a given physical connection successfully
250. POST/data/otn/otdrscan/rebaseline/darkfiber/{dfId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rebaseline at port level for a given dark fiber is done successfully
251. POST/data/otn/otdrscan/physicallink/disassociation

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Removed OTDR ports from physical connection end points successfully
252. POST/data/otn/otdrscan/physicallink/association Associate an physical connection externally with otdr ports

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Associated physical connection with OTDR ports successfully
253. GET/data/otn/darkfiber/{id} Retrieve detailed dark fiber connection information by id.

     • Response

       • New response : [404]//Connection not found
       • New response : [400]//Invalid connection ID provided
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved dark fiber details
254. POST/data/otn/darkfiber/{id}

     • Parameters

       • Deprecatedspooldatain query//spool data of a and z ends (Deprecated - no longer used).

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified dark fiber connection successfully
255. GET/data/otn/darkfibers/{id} Retrieve detailed dark fiber connection information by id.

     • Response

       • New response : [404]//Connection not found
       • New response : [400]//Invalid connection ID provided
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved dark fiber details
256. POST/data/otn/darkfibers/{id}

     • Parameters

       • Deprecatedspooldatain query//spool data of a and z ends (Deprecated - no longer used).

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified dark fiber connection successfully
257. POST/data/otn/darkfiber/disassociate/phylinks

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Dissociated physical connections successfully
258. GET/data/otn/darkfiber Retrieve detailed information about dark fiber connections.

     • Parameters

       • Add dcmpresent in query//dcmpresent indicates whether DCM enable or not for DarkFiber connection '/data/otn/darkfiber' or '/data/otn/darkfibers' REST API
       • Add ramanReady in query//ramanReady indicates whether raman readiness on the connection '/data/otn/darkfiber' or '/data/otn/darkfibers' REST API

     • Response

       • New response : [404]//Dark fiber connection not found
       • New response : [500]//Internal server error
       • New response : [400]//Invalid input
       • Changed response : [200]//Successfully retrieved dark fiber connection details
259. POST/data/otn/darkfiber

     • Parameters

       • Add dcmpresent in query//Indicates whether DCM is present

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Created dark fiber successfully
260. DELETE/data/otn/darkfiber

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted dark fiber successfully
261. POST/data/otn/crossConnects/delete

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Cross connection deleted successfully

         • Schema

           Changed body: 'application/json'
262. POST/data/otn/connections/{id}/tcm/modifyTCM

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//TCM attributes modified successfully

         • Schema

           Changed body: 'application/json'
263. POST/data/otn/connections/{id}/tcm/deleteTCM

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//TCM deleted successfully

         • Schema

           Changed body: 'application/json'
264. POST/data/otn/connections/{id}/tcm/createTCM

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//TCM created successfully

         • Schema

           Changed body: 'application/json'
265. POST/data/otn/connections/{id}/service

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Service state of a connection changed successfully

         • Schema

           Changed body: 'application/json'
266. POST/data/otn/connections/{id}/restore

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Restored Inconsistent connections

         • Schema

           Changed body: 'application/json'
267. POST/data/otn/connections/{id}/manage

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Managed the SNCP protected connection to do operation successfully

         • Schema

           Changed body: 'application/json'
268. POST/data/otn/connections/{id}/delete

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection deleted successfully

         • Schema

           Changed body: 'application/json'
269. POST/data/otn/connections/{id}/cancel

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection deleted successfully

         • Schema

           Changed body: 'application/json'
270. POST/data/otn/connections/{id}/autoreattachclients

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Reassociated clients from the infrastructure connection

         • Schema

           Changed body: 'application/json'
271. POST/data/otn/connections/{id}/autodetachclients

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Disassociated clients from the infrastructure connection

         • Schema

           Changed body: 'application/json'
272. POST/data/otn/connections/{id}/autoaddprotection

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Added protection to control plane connection successfully

         • Schema

           Changed body: 'application/json'
273. POST/data/otn/connections/{id}/asap

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Enable or disable alarm reporting done

         • Schema

           Changed body: 'application/json'
274. POST/data/otn/connections/{id}/action

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection moved Implemented or Allocated or Commissioned or complete step successfully

         • Schema

           Changed body: 'application/json'
275. POST/data/otn/connections/{id}/acknowledge

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Acknowledge Inconsistent connections

         • Schema

           Changed body: 'application/json'
276. POST/data/otn/connections/{id}/abort

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection aborted successfully

         • Schema

           Changed body: 'application/json'
277. POST/data/otn/connections/nim

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//NIM is enabled or disabled for reporting defects

         • Schema

           Changed body: 'application/json'
278. POST/data/otn/connections/loopback/release

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Loopback is released successfully

         • Schema

           Changed body: 'application/json'
279. POST/data/otn/connections/internallinks

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Created internal links successfully
280. 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: '*/*'
281. 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

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection rename done

         • Schema

           Changed body: '*/*'
282. POST/data/otn/connection/modifyConnParameters/{connIdORconnName}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//User modified connection parameters are set successfully

         • Schema

           Changed body: '*/*'
283. POST/data/otn/Connection/{id}/convertCurrentToNominal

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Converted current route to nominal route successfully

         • Schema

           Changed body: 'application/json'
284. POST/data/otn/Connection/bulkpm

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//PM modified successfully

         • Schema

           Changed body: 'application/json'
285. GET/data/npr/trails Retrieves all the available SNCs

     • Response

       • Changed response : [200]//List of SNCs
         • New body: 'application/json'
         • Deleted body: '*/*'
286. GET/data/npr/threeRs This API retrieves all the ThreeRs

     • Response

       • Changed response : [200]//List of ThreeRs
         • New body: 'application/json'
         • Deleted body: '*/*'
287. POST/data/npr/threeRs/{threerId}

     • Parameters

       • threerId in path
288. POST/data/npr/threeRNodes/{threerId}

     • Parameters

       • threerId in path
289. POST/data/otn/threeRs/{threerId}

     • Parameters

       • threerId in path
290. GET/data/npr/sharedRiskGroups This API retrieves all the SharedRiskGroups/SRGs

     • Response

       • Changed response : [200]//List of Shared Risk groups (SRGs)
         • New body: 'application/json'
         • Deleted body: '*/*'
291. GET/data/npr/physicalConns This API retrieves all Physical Connections

     • Response

       • Changed response : [200]//The response contains the response status and HTTP URL where the data can be accessed. ObjectId : Object id of the physical connection. EventType : Event type of the physical connection. ClassType : Class type of the physical connection. IdClass : Class id of the physical connection, can be retrieved as IdClass from /data/npr/physicalConns?guiLabel={userLabel} sharedRiskGroups : Shared risk groups of the physical connection. a2PortLabel : Port Label of the physical connection. aNodeId : aEnd node unique identifier. aPortLabel : aEnd port label. aTozFiberLength : a to z fiber length. aTozFiberType : a to z fiber type. aTozSpanLoss : a to z span loss of C band connection. aTozSpanLossL : a to z span loss of L band connection. aTozCommSpanLoss : a to z comm span loss. zToaCommSpanLoss : z to a comm span loss. alarmStatus : AlarmStatus of the node. possible values [ cleared,activeReportableIndeterminate,activeReportableWarning ,activeReportableMinor,activeReportableMajor, activeReportableCritical] allPathCost : Represents the cost of the physical connection. asapId : Represents the unique identifier of asap. asapName : default ASAP if the ASAP is not added. asonAdmState : Represents connection is in lock state or unlocked state. Possible values [notApplicable, locked, unlocked, unknown, shuttingDown, softShuttingDown, sync ] asonAutoRestoration : Possible values [ ExtOperSt_notMeaningful, ExtOperSt_disabled, ExtOperSt_enabled, ExtOperSt_partiallyEnabled ] asonWTR : Represent wait to restore and default value is 60. clientSignalType : Represents signalType of physical connection. Possible values [ ClientSignalType_notMeaningful,ClientSignalType_notProvisioned,ClientSignalType_oc_3,ClientSignalType_oc_12,ClientSignalType_oc_48,ClientSignalType_oc_192,ClientSignalType_oc_768,ClientSignalType_otu1,ClientSignalType_otu2,ClientSignalType_otu3,ClientSignalType_otu4,ClientSignalType_odu1,ClientSignalType_odu2,ClientSignalType_odu3,ClientSignalType_odu4,ClientSignalType_fe,ClientSignalType_eth1GbE,ClientSignalType_eth10GbE,ClientSignalType_eth10GbEW,ClientSignalType_eth100GbE,ClientSignalType_ethE1,ClientSignalType_stm_1,ClientSignalType_stm_4,ClientSignalType_stm_16,ClientSignalType_stm_64,ClientSignalType_stm_256,ClientSignalType_fc100,ClientSignalType_fc200,ClientSignalType_fc400,ClientSignalType_fc800, ClientSignalType_fc1200,ClientSignalType_cbr2G5,ClientSignalType_cbr10G,ClientSignalType_cbr40G,ClientSignalType_gfce,ClientSignalType_dvbasi,ClientSignalType_shdsi,ClientSignalType_hdsi,ClientSignalType_fc,ClientSignalType_ficon,ClientSignalType_fc10,ClientSignalType_dv_sdi,ClientSignalType_dv_asi,ClientSignalType_hdtv,ClientSignalType_escon,ClientSignalType_dv6000,ClientSignalType_eth40GbE,ClientSignalType_sdi_3g,ClientSignalType_otu2e,ClientSignalType_otu3e2,ClientSignalType_otu2_11049,ClientSignalType_otu2_11096,ClientSignalType_eth10GbE_11049,ClientSignalType_eth10GbE_11096,ClientSignalType_eth10GbE_GFPF,ClientSignalType_eth10GbE_GFPP,ClientSignalType_eth10Gbe_BMP,ClientSignalType_otu4x2,ClientSignalType_odu4x2,ClientSignalType_cbr10G3,ClientSignalType_ddr,ClientSignalType_fc1600,ClientSignalType_otu1f,ClientSignalType_eth40GbeMLD,ClientSignalType_otl4_4,ClientSignalType_sdsdi,ClientSignalType_encOtu2,ClientSignalType_encOtu2e,ClientSignalType_encOtu3,ClientSignalType_eth100GbE_LanEth,ClientSignalType_otu4_half,ClientSignalType_otu2eEth,ClientSignalType_otu4_halfx5,ClientSignalType_otu2e_WanEth,ClientSignalType_otu4_WanEth,ClientSignalType_fe_LanEth,ClientSignalType_eth1GbE_LanEth,ClientSignalType_eth10GbE_LanEth,ClientSignalType_cprirate1,ClientSignalType_cprirate2,ClientSignalType_cprirate3,ClientSignalType_cprirate4,ClientSignalType_cprirate5,ClientSignalType_cprirate6,ClientSignalType_cprirate7,ClientSignalType_obsairate1,ClientSignalType_obsairate2,ClientSignalType_obsairate4,ClientSignalType_obsairate8,ClientSignalType_eth1GbEconv,ClientSignalType_eth10Mb,ClientSignalType_eth100Mb,ClientSignalType_oc3stm1,ClientSignalType_oc12stm4,ClientSignalType_oc48stm16,ClientSignalType_dvbvideo,ClientSignalType_ficon1g,ClientSignalType_ficon2g,ClientSignalType_ficon4g,ClientSignalType_fc2g,ClientSignalType_fc4g,ClientSignalType_fc8g,ClientSignalType_fc16g,ClientSignalType_fc16gNoIsl,ClientSignalType_fc32g,ClientSignalType_hdSdiNtsc,ClientSignalType_sdiNtsc_3g,ClientSignalType_otuc2,ClientSignalType_fc3200,ClientSignalType_otsi,ClientSignalType_otu2eNimEth,ClientSignalType_eth25GbE,ClientSignalType_cprirate8,ClientSignalType_cprirate10,ClientSignalType_otu4x2_WanEth,ClientSignalType_eth25GbE_LanEth,ClientSignalType_eth40GbE_LanEth,ClientSignalType_encOtu4,ClientSignalType_eth400GbE,ClientSignalType_eth100GbE_LanCbr, ClientSignalType_enc100GbE_LanCbr,ClientSignalType_enc10GbE_Lan, ClientSignalType_encfc16g,ClientSignalType_enc100GbE_Lan, ClientSignalType_enc40GbE_Lan, ClientSignalType_encfc8g,ClientSignalType_encOc192,ClientSignalType_encStm64, ClientSignalType_enc10Gbe_NoPm,ClientSignalType_encfc16gNoIsl,ClientSignalType_eth10Gbe_NoPm,ClientSignalType_sdi_3g_nominal,ClientSignalType_sdi_3g_subrate,ClientSignalType_hdsdi_nominal,ClientSignalType_hdsdi_subrate, ClientSignalType_eleth1GbE_LanEth, ClientSignalType_och, ClientSignalType_encfc32g ] clientTechnology : Possible values [ Technology_notMeaningful,Technology_sonet,Technology_wdm,Technology_sdh,Technology_eth,Technology_radio,Technology_pdh,Technology_atm ] colorProfileId : colour profile Id of the physical connection. commissionedStatus : Represents commissioned status.Possible values [ CommissionedStatus_commissioned,CommissionedStatus_notApplicable,CommissionedStatus_notCommissioned ] flexGridSupport : Indicates flexgrid supported or not for physical connection. Possible values [ FlexGridSupport_undefined,FlexGridSupport_yes,FlexGridSupport_no,FlexGridSupport_notApplicable ] aseLongLinkStatus : Possible values [ AseLongLinkSupported_NA,AseLongLinkSupported_yes,AseLongLinkSupported_no,AseLongLinkSupported_Lband_yes,AseLongLinkSupported_C_L_band_yes ] id : unique identifier of physical connection. key : PhysicalConn/1 className : Name of class for physical connection. currentFrequency : Represents RX frequency of physical connection. defTime : Represents creation time of physical connection. direction : Direction of physical connection.Possible values [ bidirectional,sink,source,notMeaningful,unidirectional ] implSt : Implementation state of the physical connection.Possible values [ defined,implemented,deimplemented,partiallyImplemented ] interShelf : Type of the physical connection. Possible values [ normal,interShelf ] spanType : Possible values [ SpanType_dualFiber,SpanType_singleFiber,SpanType_notApplicable ] gridType : Grid type of the physical connection. Possible values [ standard,gHz125,notApplicable ] connecAdminState : Possible values [ ConnecinService,ConnecnotApplicable,ConnecnotInService,Connecmaintenance ] lastCalculatedSpanLossDate : Indicates date of last calculated spanloss. latency : Represents the latency value on the physical connection. linkType : Represents the type of the physical connection. Possible values [ rm_internal,drop,uni_n, i_nni, e_nni, split, fa_unterm, fa_term, intra_node,transitional ] nadString : Represents access domain associated. Default is : unknown operationalState : Represents the operational state. Possible values [ OperationalState_enabled,OperationalState_disabled,OperationalState_notMeaningful,OperationalState_degraded ] otdrScanStatus : Possible values [ ScanStatus_notMeaningful,ScanStatus_Scheduled,ScanStatus_InProgress,ScanStatus_Success,ScanStatus_Failure,ScanStatus_PartiallyFailed,ScanStatus_Misfired,ScanStatus_Stopped,ScanStatus_Other ] otdrSupported : Represents OTDR is supported or not.Possible values [ Boolean_false, Boolean_true] otdrDfSupported : Possible values [ Boolean_false, Boolean_true] otdrExtAssocSupported : Possible values [ Boolean_false, Boolean_true] otnMapper : Represents OTN Network Connection ID otuSignalType : Represents the signal type of the port for which physical connection is involved. Possible values [ OtuSignalType_otu1,OtuSignalType_otu2,OtuSignalType_otu3,OtuSignalType_otu4,OtuSignalType_otu2e,OtuSignalType_otu3e2,OtuSignalType_notMeaningful, OtuSignalType_otu0,OtuSignalType_otu4x2,OtuSignalType_otu4_half,OtuSignalType_otu4_halfx5,OtuSignalType_otsigTunnel,OtuSignalType_otuc2,OtuSignalType_otsi,OtuSignalType_otuflex,OtuSignalType_otutc1,OtuSignalType_otutc4 ] overlaySupport : Represents overlay is supported or not for physical connection.Possible values [ ExtBoolean_false,ExtBoolean_true ] pm15m : This attribute is deprecated and no longer used. It will always be enabled by default. pm24h : This attribute is deprecated and no longer used. It will always be enabled by default. serviceState : Service state of the physical connection. Possible values [ ServiceState_notInService,ServiceState_inService ] shape : Shape of the physical connection. Possible values [ Shape_simple,Shape_fourEnded,Shape_fourEndedSingleFiber ] sltePresent : Indicates repeater is associated or not.Possible values [ Boolean_false, Boolean_true] srgPresent : Indicates shared risk group [srg] present or not. Possible values [ ObjectPresent_notPresent,ObjectPresent_present ] thrdPartyNtwDescription : Indicates third party network description if given of physical connection. thrdPartyNtwName : Indicates third party network name if given of physical connection txFrequency : Indicates transmission frequency of physical connection ultraLongSpan : Indicates span. Possible values [ Boolean_false, Boolean_true] updatedTime : Indicates updated time. guiLabel : name of the physical connection. wdmConnectionType : Represents the Connection type supported.Possible values [ WdmPortType_ots,WdmPortType_ops0,WdmPortType_otsReg ] wdmLinkType : Represents link type. Possible values [ Wdmotn,Wdmlegacy16x6,Wdmiw16x6,WdmpssOne,WdmiwpssOne,Wdmwavelite,Wdmopenconfig ] wdmProtConnType : Represents protection type.Possible values [ WdmProtType_notMeaningful,WdmProtType_y_cable,WdmProtType_e_sncp ] wrkSt : Represents the working state of the physical connection.Possible values [ WorkingState_failToImplement,WorkingState_normal,WorkingState_configuring,WorkingState_removing,WorkingState_failToConfigure,WorkingState_failToUpload,WorkingState_implementing,WorkingState_uploading,WorkingState_deimplementing,WorkingState_failToDeimplement,WorkingState_failToRemove,WorkingState_subscriberNumberUpdating,WorkingState_failToUpdateSubscriberNumber,WorkingState_resetting,WorkingState_failToReset,WorkingState_activatingMsSpRing,WorkingState_failedToActivateMsSpRing,WorkingState_settingLoopback,WorkingState_failToSetLoopback,WorkingState_synchronizingLoopback,WorkingState_failToSynchronizeLoopback,WorkingState_joining,WorkingState_failedToJoin,WorkingState_undoJoining,WorkingState_failedToUndoJoin,WorkingState_splitting,WorkingState_failedToSplit,WorkingState_undoSplitting,WorkingState_failedToUndoSplit,WorkingState_inserting,WorkingState_connecting,WorkingState_failedToConnect,WorkingState_disconnecting,WorkingState_failedToDisconnect,WorkingState_managingTraceId,WorkingState_implNpa,WorkingState_deImplNpa,WorkingState_failedToImplNpa,WorkingState_failedToDeimplNpa,WorkingState_removingFromNpa,WorkingState_enablingAlarms,WorkingState_disablingAlarms,WorkingState_failedToEnableAlarms,WorkingState_failedToDisableAlarms,WorkingState_moving,WorkingState_locking,WorkingState_unlocking,WorkingState_movingPorts,WorkingState_enablingDomains,WorkingState_lockingForEnablingDomains,WorkingState_unlockingForEnablingDomains,WorkingState_lockingForMovingPorts,WorkingState_unlockingForMovingPorts,WorkingState_assigningPorts,WorkingState_failedToAssignPorts,WorkingState_synchronizingOchLayer, WorkingState_removingInternalCables,WorkingState_failedToRemoveIntCables,WorkingState_modifyingLabels,WorkingState_failToModifyLabels,WorkingState_lockedForCardSwap ] z2PortLabel : z2End port label. zNodeId : zEnd node unique identifier. zPortLabel : zEnd port label. zToaFiberLength : z to a fiber length. zToaFiberType : Indicates type of the fiber z to a.Possible values [ FiberType_notConfigured,FiberType_dsf,FiberType_eleaf,FiberType_ls,FiberType_ssmf,FiberType_twc,FiberType_twp,FiberType_twrs,FiberType_smpf,FiberType_mixed,FiberType_lx1830ssmf,FiberType_lx1830g654,FiberType_g652B,FiberType_g654E,FiberType_g652D,FiberType_g657,FiberType_dcf ] zToaSpanLoss : z to a spann loss for C band connection. zToaSpanLossL : z to a spann loss for L band connection. colorProfileName : Represent ColorprofileName and default name is NoColor. colorString : if colorprofileName is Nocolor then colorString value will be 0000.0000.0000.0000.0000.0000.0000 band : Indicates the band supported for card. Possible values [ BandIdentification_cBand,BandIdentification_lBand,BandIdentification_coarseBand,BandIdentification_notMeaningful,BandIdentification_cPlusCoarseBand,BandIdentification_cAndSBand,BandIdentification_cAndLBand ] protection : Represents physical connection is protected or not. Possible values [ Unprotected,protected ] otdrSummary : Possible values [ OTDRSCAN_NOTAPPLICABLE ] olcState : Possible values [ OlcState_InService,OlcState_Maintenance ] npaUserLabel : userlabel of NPA. mostRecentNote : Indicates most recent note on physical connection. fiberAscStatus : Indicates fiber association status.Possible values [ Boolean_false, Boolean_true] isDarkFiberAssociated : Indicates whether dark fiber associated to physical connection.Possible values [ Boolean_false, Boolean_true] clusterLink : Indicates whether its cluster link.Possible values [ ClusterLink_normal,ClusterLink_cluster ] asapStatus : Indicates status of asap.Possible values [ AsapStatus_notset,AsapStatus_enabled ] lowlinkUtilThreshold : Indicates lower threshold of link utilisation. highlinkUtilThreshold : Indicates higher threshold of link utilisation. linkUtilProfileName : Indicates profile name of link utilisation. linkUtilRatio : Indicates ratio of link utilisation. currentlinkUtilRatio : Indicates ratio of current link util. overlaplinkUtilRatio : Indicates ratio of overlap link util. olpAssociatedLink : Indicates links associated to olp. noCommandToNe : Represents whether commands need to be sent to NE or not.Possible values [ Boolean_false, Boolean_true] consistSt : Possible values [ normal,notFound,ghost,notValid,unknown,checking,notMeaningful,notChecked,misaligned,notAligned,failedToAlign,consistencyMismatch,aligning,normalAudit,notApplicable ] subseaLink : Represents physical connection is subsea link or not. Possible values [ Boolean_false, Boolean_true] ramanPresent : Represents raman amplifier present or not. modificationTime : Represents modification time of physical connection. modifiedBy : Represents name of the user who has modified physical connection. createdBy : Represents name of the user who has created physical connection. uptimeOpstateMs : Operation state uptime in milli seconds. uptimeUasMs : Indicates uptime. labelName : Represents label added by user on physical connection. discoveredSubseaLink : Indicates PSI-CL physical connection. fromOspfAreaIndex : Indicates OSPF Area Index of aEnd Port. fromOspfAreaId : Indicates OSPF Area Identifier of aEnd Port. toOspfAreaIndex : Indicates OSPF Area Index of zEnd Port. toOspfAreaId : Indicates OSPF Area Identifier of zEnd Port. -------------------------------------------------------------------------------------------------------
292. GET/data/npr/npas This API retrieves all the NPAs

     • Response

       • Changed response : [200]//List of NPAs
         • New body: 'application/json'
         • Deleted body: '*/*'
293. GET/data/npr/colorProfiles This API retrieves all the Color Profiles

     • Response

       • Changed response : [200]//List of Color Profiles
         • New body: 'application/json'
         • Deleted body: '*/*'
294. POST/data/npr/asonSwitchs/{cointoIdList}/switchCmd

     • Parameters

       • Add trailId in query//Optional 'trailId' is used to identify the trail when no switch is present and cointoIdList contains only -1.
295. POST/asap/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Sets the ASAP Category data for shelf and card level.
296. POST/asap/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Sets the ASAP category data for card level.
297. POST/asap/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}

     • 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
298. POST/asap/asapSet/portLevel/{groupId}/{neId}/{portname}/{category} This is used to modify the ASAP category Supported at port level of the particular Network Element and port.

     • Response

       • New response : [500]//Internal Server Error
       • 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
299. 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
300. GET/swim/neSwStatus/actions/supported

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Returns the software details on the NE
301. GET/swim/Download/package/{serverName}/{neType}

     • Response

       • New response : [500]//Internal server error.
       • Changed response : [200]//Returns software packages if any
302. GET/data/otn/otdr/{jobDetailsId} Retrieve OTDR scan schedule details using the specified id

     • Response

       • New response : [400]//Invalid id supplied
       • New response : [404]//OTDR scan scheduled details not found
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved OTDR scan details
303. DELETE/data/otn/otdr/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted OTDR scan job successfully
304. GET/data/otn/schedule/otdr/{jobDetailsId} Retrieve OTDR scan schedule details using the specified id

     • Response

       • New response : [400]//Invalid id supplied
       • New response : [404]//OTDR scan scheduled details not found
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved OTDR scan details
305. DELETE/data/otn/schedule/otdr/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted OTDR scan job successfully
306. GET/data/otn/schedule/otdr/scanjob/{jobHandleId} Retrieve physical or dark fiber connection name by jobId.

     • Response

       • New response : [404]//connection name not found
       • New response : [400]//Invalid job id supplied
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved connection name
307. GET/data/otn/schedule/job/name Retrieve OTDR schedule details based on the specified job name.

     • Parameters

       • Add name in query//A distinct and unique identifier for the 'jobName',used to reference a specific OTDR scan details,sourced from 'esmBrowser/jobList/GetJobListJson/all' REST API
       • Deletejobnamein query// 'jobname' is a unique field from 'esmBrowser/jobList/GetJobListJson/all'

     • Response

       • New response : [400]//Invalid job name supplied
       • New response : [500]//Internal server error
       • New response : [404]//OTDR schedule details not found
       • Changed response : [200]//Successfully retrieved OTDR schedule details

         • Schema

           Changed body: '*/*'
308. GET/otn/NBI/topoMgmt/TopologicalLinks/{includeInternalLinks}

     • Response

       • Changed response : [200]//Retrieved all the internal links successfully
309. GET/otn/NBI/Connection/routeTopoData/{connId}

     • Response

       • Changed response : [200]//Retrieved route and topological link details successfully
310. GET/eqm/Equipment/FilteredView/{grpID}/{neID}/{shelf}/{slot}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Retrieves all the equipment details of the Card/Slot tree.

         • Schema incompatible

           Changed body: 'application/json'
311. GET/data/eml/FilteredView/{grpID}/{neID}/{shelf}/{slot}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Retrieves all the equipment details of the Card/Slot tree.

         • Schema incompatible

           Changed body: 'application/json'
312. GET/eqm/Equipment/FilteredView/{grpID}/{neID}/{shelf}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Retrieves all the equipment details of the shelf tree for specific NE.

         • Schema incompatible

           Changed body: 'application/json'
313. GET/data/eml/FilteredView/{grpID}/{neID}/{shelf}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Retrieves all the equipment details of the shelf tree for specific NE.

         • Schema incompatible

           Changed body: 'application/json'
314. GET/eqm/Equipment/Alarm/{grpID}/{neID}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Returns the updated data after creating,modifying or deleting the data.

         • Schema incompatible

           Changed body: 'application/json'
315. GET/data/eml/Alarm/{grpID}/{neID}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Returns the updated data after creating,modifying or deleting the data.

         • Schema incompatible

           Changed body: 'application/json'
316. GET/emlnemgr/lldpParams Generate the node-level Link Layer Discovery Protocol(LLDP) report, providing a list of Link Layer Discovery Protocol(LLDP) neighbors

     • Response

       • Changed response : [200]//Retrieved node-level Link Layer Discovery Protocol(LLDP) report successfully
317. GET/data/eml/lldpParams Generate the node-level Link Layer Discovery Protocol(LLDP) report, providing a list of Link Layer Discovery Protocol(LLDP) neighbors

     • Response

       • Changed response : [200]//Retrieved node-level Link Layer Discovery Protocol(LLDP) report successfully
318. GET/data/swim/neList/getManualRefreshNes/ Get list of manual refresh NEs

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Successfully retrieves the list of manual refresh NEs if any
319. GET/data/swim/neInfo Get all NE Lists

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Returns the list of NE details
320. GET/data/swim/getExternalServerInfo/{jobId}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request.If the API parameter schema is not valid format
       • Changed response : [200]//Returns external server information along with protocol and operation status
321. GET/data/swim/firmware/getAllPluggableModules

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Successfully retrieved the list of all the optical modules details
322. GET/data/swim/checkNeInDownloadJob/{neIds}/{neType}/ Fetch the NE list

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Successfully retrieved the NE details for the single or multiple NE
323. GET/data/swim/anaytics/statistics/{jobType} This API returns the statistical JOB data.

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Successfully retrieved all the statistical data based on job type
324. GET/data/swim/anaytics/jobStatus/{jobType}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request
       • Changed response : [200]//Successfully retrieved the particular job status based on job type provided
325. GET/data/swim/analytics/healthStatus This API return the all the NEs aggregated health check

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request
       • Changed response : [200]//Successfully retrieved the list of all the NE health status details
326. GET/data/swim/analytics/healthStatus/download

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request
       • Changed response : [200]//Successfully retrieved the specific NE health check report
327. GET/data/swim/analytics/healthStatus/details/{neId} This API returns the NE health check details for NE specific

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request
       • Changed response : [200]//Successfully retrieved the health check details for specific NE
328. GET/data/swim/NeScheduledHealthCheckData This API returns all the NE health check scheduled details

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request
       • Changed response : [200]//Successfully retrieved the NE health check scheduled and not scheduled details
329. GET/data/plat/jobs This is used to retrieve list of all scheduled Jobs

     • Response

       • Changed response : [200]//Obtained job list successfully

         • Schema

           Changed body: '*/*'
330. GET/data/plat/br/jobs/{jobId}/status This is used to get the Backup Status

     • Response

       • Changed response : [200]//Obtained backup status successfully.
331. GET/data/plat/backupJobs/{jobId} This is used to retrieve Single Backup info

     • Response

       • Changed response : [200]//Backup list retrieved successfully

         • Schema

           Changed body: '*/*'
332. GET/data/plat/br/backups/{jobId}/status This provides the Restore Status of a particular id

     • Response

       • Changed response : [200]//Restore status retrieved successfully
333. GET/data/plat/backups/{jobId} This is used to retrieve specific backup info with id

     • Response

       • Changed response : [200]//Retrieved the restore list successfully.

         • Schema

           Changed body: '*/*'
334. GET/data/plat/backups This is used to Retrieve list of Backups Executed

     • Response

       • Changed response : [200]//Retrieved backup list successfully.

         • Schema

           Changed body: '*/*'
335. GET/data/plat/backups/reload This is used to Reload Backups from local storage or Disk

     • Response

       • Changed response : [200]//Backup reloaded successfully

         • Schema

           Changed body: '*/*'
336. GET/data/otn/otdrscan/physicallink/association/{phyLinkId} Retrieve OTDR port association details by connection ID.

     • Response

       • Changed response : [200]//Retrieved OTDR port details successfully
337. GET/data/otn/otdrscan/otdrCustomprofile/{neId} Retrieve OTDR profile details by ne id from network element.

     • Response

       • New response : [400]//Invalid Ne Id supplied.
       • New response : [404]//OTDR profile details not found.
       • New response : [500]//Internal server error.
       • Changed response : [200]//Successfully retrieved OTDR Profile details.
338. GET/data/otn/otdrCustomprofile/{neId} Retrieve OTDR profile details by ne id from network element.

     • Response

       • New response : [400]//Invalid Ne Id supplied.
       • New response : [404]//OTDR profile details not found.
       • New response : [500]//Internal server error.
       • Changed response : [200]//Successfully retrieved OTDR Profile details.
339. GET/data/otn/diversityGroup/list lists all the diversity groups(wo services grouped together through “DiversityGroup” attribute)

     • Response

       • Changed response : [200]//Diversity group list retrieved successfully
340. GET/data/otn/darkfiber/{id}/darkfiberList Retrieve dark fibers linked to a physical connection by id.

     • Response

       • New response : [404]//Connection not found
       • New response : [400]//Invalid connection ID provided
       • New response : [500]//Internal server error
       • Changed response : [200]//Successfully retrieved dark fibers linked to the specified physical connection
341. GET/data/otn/channelWidths

     • Parameters

       • Add noOfCarrier in query//noOfCarrier is applicable to create either single carrier or dual carrier profile; Default:1; allowable values: 1,2
       • Add profileType in query//profileType can be SYS , SYS-SDP , WSNOC , CEP

     • Response

       • Changed response : [200]//Channel widths retrieved successfully
342. GET/data/otn/Connection/switchData/{connId} To retrieve the protection switch data associated with a specific connection

     • Response

       • Changed response : [200]//Retrieved all protection switch data successfully
343. DELETE/data/otn/delete/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted OTDR scan job successfully
344. DELETE/data/otn/schedule/delete/{jobDetailsId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Deleted OTDR scan job successfully
345. GET/swim/jobs Fetches list of jobs

     • Response

       • New response : [500]//Internal Server Error
       • Changed response : [200]//Successfully retrieved the list of software management job details
346. PUT/swim/jobs Various operation for managing job.

     • Request

       • Schema incompatible

         Changed body: 'application/json'

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Returns the success/failure status for the job operations performed
347. POST/swim/jobs

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Returns the unique job name after successful Job creation
348. POST/otn/PathSyncScheduler To create a scheduled path sync job

     • Request

       • Schema

         Changed body: 'application/json'
349. POST/eqm/otdr/modifyOtdrParams/{ptpName}

     • Response

       • New response : [500]//Internal Server Error
       • New response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Sets the OTDR params.
350. POST/data/otn/node/rearrangeGhost

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Rearranged the connection successfully
351. POST/data/otn/modifySRGAffectedClients/{connectId}

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Retrieved affected clients successfully

         • Schema

           Changed body: 'application/json'
352. POST/data/otn/lineModeProfiles/{profileId}/baudRateList

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Retrieve baud rates for base profile id successfully

         • Schema

           Changed body: 'application/json'
353. 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.

     • Request

       • Schema incompatible

         Changed body: 'application/json'
354. POST/data/otn/labelAssign Assign a label to the business object(s).

     • Request

       • Schema incompatible

         Changed body: 'application/json'
355. POST/data/otn/createNewLabel Create New Label

     • Request

       • Schema incompatible

         Changed body: 'application/json'
356. POST/data/otn/connections/setLatency

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Latency on connections and its clients are set
357. POST/data/otn/connections/retrieveLatency Retrieves latencyMeasurement data by a list of service/infrastructure connection ID's or connection name's list (or both) as a JSON object. Returns latencyprotection, latencyworking, latencytimestamp and latencyComputationMethod (DM/DLC) values for the given list of connections | Note:: connection inputs can be retrived from the REST call '/data/otn/connections'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Retrieved latency measurement data successfully
358. POST/data/otn/connections/retrieveJobTask

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Retrieved jobs or tasks associated with connection successfully
359. POST/data/otn/connections/measurements/{measurementType} Returns the service test results for a set of connection id(s) or connection name(s) or both. Service testing include bit rate error testing which simulates message data using either Pseudo Random Binary Sequence (PRBS) or Idle Test Signal depending on the configuration. When supported by the configuration, in addition to monitoring bit error rate, additional PM counters are also monitored during the bit rate error testing. When supported by the configuration latency measurements are performed after bit rate error testing. Note: connection inputs can be retrieved from the REST call ‘/data/otn/connections’.

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Service tests for a connection is done

         • Schema

           Changed body: 'application/json'
360. POST/data/otn/connections/getLatency

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Retrieved latency on multiple connections
361. POST/data/otn/connections/computeLatency

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Latency value is measured
362. POST/data/otn/Connection/pluggableModule

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Pluggable module type retieved successfully

         • Schema

           Changed body: 'application/json'
363. GET/otn/NBI/physicalPorts/{nprNeId} To get all the physical ports for given nprNeId

     • Response

       • Changed response : [200]//Retrieved all physical ports successfully

         • Schema

           Changed body: 'application/json'
364. GET/otn/NBI/containingTps/{nprNeId}/{ctpNativeName} to get all the associated CTPs for given nprNeId,ctpNativeName

     • Response

       • Changed response : [200]//CTP's retrieved successfully

         • Schema

           Changed body: 'application/json'
365. GET/otn/NBI/containedPotentialTPs/{nprComponentId}/{ptpName} To get all contained potential TPs for specified nprComponentId and ptpName

     • Response

       • Changed response : [200]//Potential TPs retrieved successfully

         • Schema

           Changed body: 'application/json'
366. GET/otn/NBI/allPortsPerNode/{nprNodeID}

     • Response

       • Changed response : [200]//PTPs/FTPs retrieved successfully
367. GET/otn/NBI/allCTPsPerNode/{nprNodeID}

     • Response

       • Changed response : [200]//CTPs per node retrieved successfully
368. GET/otn/NBI/Connection/FixedXcData/{neId}

     • Response

       • Changed response : [200]//Fixed xc data retrieved successfully
369. GET/data/otn/wavekeyPairs To retrieve wave key Pairs for a particular frequency

     • Response

       • Changed response : [200]//Wave key pairs retrieved successfully
370. GET/data/otn/tpAvailable Retrieves available frequency required for service creation for given neId and port names

     • Response

       • Changed response : [200]//Retrieved frequency for service creation successfully
371. GET/data/otn/connection/timeSlots To get the available timeslots on unterminated port for a channelized connection

     • Parameters

       • Add ptpRate in query//ptpRate can be retrieved as 'ptpRate' from '/data/otn/connection/connectionTP?rate={rate}&nodeName={name}' where rate is the connectionTP ptpRate is the ptp rate

     • Response

       • Changed response : [200]//Timeslots retrieved successfully
372. GET/data/otn/psEvents To retrieve protection switch events for a sepcified connection

     • Response

       • Changed response : [200]//Protection switch events have been successfully retrieved.

         • Schema

           Changed body: 'application/json'
373. GET/data/otn/nodes/{nprNodeId}/crossConnects Retrieves managed plane cross-connections with an active cross-connection state for the specified node

     • Response

       • Changed response : [200]//Retrieved managed plane cross connections with active state successfully

         • Schema

           Changed body: 'application/json'
374. GET/data/otn/nodes/{nprNodeId}/allCrossConnects Retrieves all cross connects for specified node

     • Response

       • Changed response : [200]//Cross connects retrieved successfully

         • Schema

           Changed body: 'application/json'
375. GET/data/otn/node/

     • Response

       • Changed response : [200]//List of nodes are retrieved successfully
376. GET/data/otn/connection/node/

     • Response

       • Changed response : [200]//List of nodes are retrieved successfully
377. GET/data/otn/nes/{nprNeId}/fixedCrossConnects Retrieves all fixed cross connects for specified network element

     • Response

       • Changed response : [200]//Fixed cross connections retrieved successfully

         • Schema

           Changed body: 'application/json'
378. GET/data/otn/ne/{neId}/rate/{portRate}/port/{portName}/portParameters Retrieves all port attributes for a specified combination of portName, neId and layerRate

     • Response

       • Changed response : [200]//Port attributes retrieved successfully
379. GET/data/otn/crossConnects/{sncId}/getTimeslots Retrieve the timeslots associated with a cross-connect

     • Response

       • Changed response : [200]//Timeslots of a cross connect retrieved successfully

         • Schema

           Changed body: 'application/json'
380. GET/data/otn/crossConnects/{id} Retrieve the details of a specified cross-connect

     • Response

       • Changed response : [200]//cross connect details retrieved successfully

         • Schema

           Changed body: 'application/json'
381. GET/data/otn/crossConnects/uncorrelated Retrieves all uncorrelated cross-connections along with detailed information describing each cross-connect.

     • Response

       • Changed response : [200]//Uncorrelated cross connection retrieved successfully

         • Schema

           Changed body: 'application/json'
382. GET/data/otn/connections/{id}/wlt/{dir}/ldPorts To get port details of all LD ports for given physical connection and direction

     • Response

       • Changed response : [200]//LD ports details retrieved successfully
383. GET/data/otn/connections/{id}/tcm/showTCMTP/{source} Retrieves all details of the TCM (Tandem Connection Monitoring) TP using the particular connection ID.

     • Response

       • Changed response : [200]//TCM details retrieved successfully

         • Schema

           Changed body: 'application/json'
384. GET/data/otn/connections/{id}/tcm/createTCMInfo

     • Response

       • Changed response : [200]//TCM list retrieved successfully

         • Schema

           Changed body: 'application/json'
385. GET/data/otn/connections/{id}/switchStatus Initiate synchronization of the protection switch status for a given Managed Plane Connection

     • Response

       • Changed response : [200]//Synchronized initiated successfully
386. GET/data/otn/connections/{id}/structure Retrieves the Structure details for given connectionIdRetrieves all the timeslots for the connection with information about which timeslot is occupied by its clients or available and also information about each of its clientsconnectionName, protectionType, protectionRole , Rate etc)

     • Response

       • Changed response : [200]//Connection and struture details retrieved successfully

         • Schema

           Changed body: '*/*'
387. GET/data/otn/connections/{id}/primary to get primary connection details specified by connection ID

     • Response

       • Changed response : [200]//Primary connection retrieved successfully

         • Schema

           Changed body: 'application/json'
388. GET/data/otn/connections/{id}/ports Retrieves all ports involved in an infra or a service connection

     • Response

       • Changed response : [200]//Ports retrieved successfully
389. GET/data/otn/connections/{id}/endPoints/physicalPorts to get All End Points Details of a given connectionId

     • Response

       • Changed response : [200]//End points retrieved successfully

         • Schema

           Changed body: '*/*'
390. GET/data/otn/connections/physical/{nprId}/ports Retrieves all ports involved in a physical connection

     • Response

       • Changed response : [200]//Ports retrieved successfully
391. GET/data/otn/connections/mismatch/{mismatchType} Lists all the connections when there is a particular mismatch type for certain attributes between the connections stored in the system and the values provisioned in the network.

     • Response

       • Changed response : [200]//MismatchType connections retrieved successfully

         • Schema

           Changed body: 'application/json'
392. GET/data/otn/connections/loopbackConnections Returns a list of loopback associated with all connections.

     • Response

       • Changed response : [200]//Loopback connections retrieved successfully

         • Schema

           Changed body: 'application/json'
393. GET/data/otn/connection/loopbackConnection Returns a list of loopback associated with all connections.

     • Response

       • Changed response : [200]//Loopback connections retrieved successfully

         • Schema

           Changed body: 'application/json'
394. GET/data/otn/connectionTP

     • Response

       • Changed response : [200]//Endpoints ports of a connection is retrieved successfully

         • Schema

           Changed body: 'application/json'
395. GET/data/otn/connection/connectionTP

     • Response

       • Changed response : [200]//Endpoints ports of a connection is retrieved successfully

         • Schema

           Changed body: 'application/json'
396. GET/data/otn/connection/{id}/textRoute Retrieves the connection route information, including the path the connection takes through the network for the given connection

     • Parameters

       • Add ochRoute in query//ochRoute defines whether the connection is an OCH connection or not and allowableValues='true, false'

     • Response

       • Changed response : [200]//Connection route retrieved successfully

         • Schema

           Changed body: '*/*'
397. GET/data/otn/connection/{id}/server To get server connection details for the specified connection.

     • Response

       • Changed response : [200]//Server details retrieved successfully

         • Schema

           Changed body: 'application/json'
398. GET/data/otn/connections/{id}/servers To get server connection details for the specified connection.

     • Response

       • Changed response : [200]//Server details retrieved successfully

         • Schema

           Changed body: 'application/json'
399. GET/data/otn/connection/{id}/fullRoute Retrieves the complete route down to the OTS layer for the given connection ID.

     • Response

       • Changed response : [200]//AZ and ZA route retrieved successfully

         • Schema incompatible

           Changed body: '*/*'

           Changed property type: status (string -> object)

400. GET/data/otn/connections/{id}/clientHierarchy Retrieves the client hierarchy details for a given connection

     • Response

       • Changed response : [200]//Client hierarchy details retrieved successfully

         • Schema

           Changed body: 'application/json'
401. GET/data/otn/connection/{id}/client To get client connection details for the specified connection.

     • Response

       • Changed response : [200]//Client details retrieved successfully

         • Schema

           Changed body: 'application/json'
402. GET/data/otn/connection/{connectionId}/serverHierarchy To get server Hierarchy details for the given connection

     • Response

       • Changed response : [200]//Server hierarchy details retrieved successfully

         • Schema

           Changed body: 'application/json'
403. GET/data/otn/connection/usedPorts Retrieves all the ports that are currently 'in use' on a particular Network Element

     • Response

       • Changed response : [200]//In used connection been retrieved successfully

         • Schema

           Changed body: '*/*'
404. GET/data/otn/connection/trail/{id} To get the infrastructure connection details for the specified connection.

     • Response

       • Changed response : [200]//Infrastucture connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
405. GET/data/otn/trails/{id} To get the infrastructure connection details for the specified connection.

     • Response

       • Changed response : [200]//Infrastucture connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
406. GET/data/otn/connection/trail Retrieves a list of all infrastructure and logical connection details.

     • Parameters

       • Add payloadRate in query//'payloadRate' it indicates the payloadRate applicable for the OTSig tunnel and can be retrieved as 'payloadRate' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add fecType in query//'fecType' it indicates the fecType applicable for the OTSig tunnel and can be retrieved as 'fecType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add phaseEncoding in query//'phaseEncoding' it indicates the phaseEncoding applicable for the OTSig tunnel and can be retrieved as 'phaseEncoding' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add clOtuType in query//'clOtuType' it indicates the clOtuType applicable for the OTSig tunnel and can be retrieved as 'clOtuType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add txShape in query//'txShape' it indicates the txShape applicable for the OTSig tunnel and can be retrieved as 'txShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add additionalConfiguration in query//'additionalConfiguration' it indicates the additionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'additionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaProfileId in query//'zaProfileId' it indicates the zaProfileId applicable for the OTSig tunnel and can be retrieved as 'zaProfileId' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaTxShape in query//'zaTxShape' it indicates the zaTxShape applicable for the OTSig tunnel and can be retrieved as 'zaTxShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaAdditionalConfiguration in query//'zaAdditionalConfiguration' it indicates the zaAdditionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'zaAdditionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add customerName in query//'customerName' refers to the name of the customer that is assigned to the connection and can be retrieved as 'customerName' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add linkUtilRatio in query//'linkUtilRatio' refers to the Link Utilization Ratio applicable for trail and can be retrieved as 'linkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the linkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add currentlinkUtilRatio in query//'currentlinkUtilRatio' refers to the Current Link Utilization Ratio applicable for trail and can be retrieved as 'currentlinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the currentlinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add overlaplinkUtilRatio in query//'overlaplinkUtilRatio' refers to the Overlap Link Utilization Ratio applicable for trail and can be retrieved as 'overlaplinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the overlaplinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.

     • Response

       • Changed response : [200]//Infrastructure connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
407. GET/data/otn/connections/trails Retrieves a list of all infrastructure and logical connection details.

     • Parameters

       • Add payloadRate in query//'payloadRate' it indicates the payloadRate applicable for the OTSig tunnel and can be retrieved as 'payloadRate' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add fecType in query//'fecType' it indicates the fecType applicable for the OTSig tunnel and can be retrieved as 'fecType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add phaseEncoding in query//'phaseEncoding' it indicates the phaseEncoding applicable for the OTSig tunnel and can be retrieved as 'phaseEncoding' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add clOtuType in query//'clOtuType' it indicates the clOtuType applicable for the OTSig tunnel and can be retrieved as 'clOtuType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add txShape in query//'txShape' it indicates the txShape applicable for the OTSig tunnel and can be retrieved as 'txShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add additionalConfiguration in query//'additionalConfiguration' it indicates the additionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'additionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaProfileId in query//'zaProfileId' it indicates the zaProfileId applicable for the OTSig tunnel and can be retrieved as 'zaProfileId' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaTxShape in query//'zaTxShape' it indicates the zaTxShape applicable for the OTSig tunnel and can be retrieved as 'zaTxShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaAdditionalConfiguration in query//'zaAdditionalConfiguration' it indicates the zaAdditionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'zaAdditionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add customerName in query//'customerName' refers to the name of the customer that is assigned to the connection and can be retrieved as 'customerName' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add linkUtilRatio in query//'linkUtilRatio' refers to the Link Utilization Ratio applicable for trail and can be retrieved as 'linkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the linkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add currentlinkUtilRatio in query//'currentlinkUtilRatio' refers to the Current Link Utilization Ratio applicable for trail and can be retrieved as 'currentlinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the currentlinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add overlaplinkUtilRatio in query//'overlaplinkUtilRatio' refers to the Overlap Link Utilization Ratio applicable for trail and can be retrieved as 'overlaplinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the overlaplinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.

     • Response

       • Changed response : [200]//Infrastructure connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
408. GET/data/otn/trails Retrieves a list of all infrastructure and logical connection details.

     • Parameters

       • Add payloadRate in query//'payloadRate' it indicates the payloadRate applicable for the OTSig tunnel and can be retrieved as 'payloadRate' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add fecType in query//'fecType' it indicates the fecType applicable for the OTSig tunnel and can be retrieved as 'fecType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add phaseEncoding in query//'phaseEncoding' it indicates the phaseEncoding applicable for the OTSig tunnel and can be retrieved as 'phaseEncoding' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add clOtuType in query//'clOtuType' it indicates the clOtuType applicable for the OTSig tunnel and can be retrieved as 'clOtuType' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add txShape in query//'txShape' it indicates the txShape applicable for the OTSig tunnel and can be retrieved as 'txShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add additionalConfiguration in query//'additionalConfiguration' it indicates the additionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'additionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaProfileId in query//'zaProfileId' it indicates the zaProfileId applicable for the OTSig tunnel and can be retrieved as 'zaProfileId' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaTxShape in query//'zaTxShape' it indicates the zaTxShape applicable for the OTSig tunnel and can be retrieved as 'zaTxShape' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add zaAdditionalConfiguration in query//'zaAdditionalConfiguration' it indicates the zaAdditionalConfiguration applicable for the OTSig tunnel and can be retrieved as 'zaAdditionalConfiguration' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add customerName in query//'customerName' refers to the name of the customer that is assigned to the connection and can be retrieved as 'customerName' from /data/otn/connections/networkConnections?guiLabel={name} where name is the connection name, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add linkUtilRatio in query//'linkUtilRatio' refers to the Link Utilization Ratio applicable for trail and can be retrieved as 'linkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the linkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add currentlinkUtilRatio in query//'currentlinkUtilRatio' refers to the Current Link Utilization Ratio applicable for trail and can be retrieved as 'currentlinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the currentlinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.
       • Add overlaplinkUtilRatio in query//'overlaplinkUtilRatio' refers to the Overlap Link Utilization Ratio applicable for trail and can be retrieved as 'overlaplinkUtilRatio' from /data/otn/connections/networkConnections?guiLabel={name} where name is the overlaplinkUtilRatio ranges between 0 to 100, or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name.

     • Response

       • Changed response : [200]//Infrastructure connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
409. GET/data/otn/connection/path/{id} Get List of all service connection present in the system. this is bulk API and retuns all services if no filter is specified

     • Response

       • Changed response : [200]//Service connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
410. GET/data/otn/connection/path

     • Parameters

       • Add importedFromPT in query//'importedFromPT' can be retrieved as 'importedFromPT' from 'data/otn/connections/networkConnections?guiLabel={name}' REST call where name is the connection name or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name
       • Add planName in query//'planName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add designName in query//'designName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add designBranchName in query//'designBranchName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add publishedComment in query//'publishedComment' can be retrieved from column 'published message' on 'Deploy -> WS-P Designs' page in UI
       • Add designId in query//'designId' can be retrieved from 'Deploy -> WS-P Designs -> Info' page in UI
       • Add customerName in query//'customerName' can be retrieved as 'customerName' from 'data/otn/connections/networkConnections?guiLabel={name}' REST call where name is the connection name or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name
       • Add fiberSensing in query//'fiberSensing' can be retrieved as 'fiberSensing' from 'data/otn/trails' ReST call

     • Response

       • Changed response : [200]//Service connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
411. GET/data/otn/connections/paths

     • Parameters

       • Add importedFromPT in query//'importedFromPT' can be retrieved as 'importedFromPT' from 'data/otn/connections/networkConnections?guiLabel={name}' REST call where name is the connection name or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name
       • Add planName in query//'planName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add designName in query//'designName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add designBranchName in query//'designBranchName' can be retrieved from 'Deploy -> WS-P Designs' page in UI
       • Add publishedComment in query//'publishedComment' can be retrieved from column 'published message' on 'Deploy -> WS-P Designs' page in UI
       • Add designId in query//'designId' can be retrieved from 'Deploy -> WS-P Designs -> Info' page in UI
       • Add customerName in query//'customerName' can be retrieved as 'customerName' from 'data/otn/connections/networkConnections?guiLabel={name}' REST call where name is the connection name or can be fetched from bulk API rest call '/data/otn/connections' without filter for connection name
       • Add fiberSensing in query//'fiberSensing' can be retrieved as 'fiberSensing' from 'data/otn/trails' ReST call

     • Response

       • Changed response : [200]//Service connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
412. GET/data/otn/connection/networkConnection/{id} to retrieve Network connection for given connection Id

     • Response

       • Changed response : [200]//Network connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
413. GET/data/otn/connections/{id} to retrieve Network connection for given connection Id

     • Response

       • Changed response : [200]//Network connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
414. GET/data/otn/connections

     • Parameters

       • Add guiLabel in query// Not implemented yet. guiLabel is the name of specific connection. This can be user input or can be fetched from bulk API '/data/otn/connections' as guiLabel'
       • Add planName in query//For Connection created via Flow Through Provisioning to fetch all connections having same PlanName
       • Add designName in query//For Connection created via Flow Through Provisioning to fetch all connections having same Design Name
       • Add designBranchName in query//For Connection created via Flow Through Provisioning to fetch all connections having same Design Branch Name
       • Add publishedComment in query//For Connection created via Flow Through Provisioning to fetch all connections having same Published Reason

     • Response

       • Changed response : [200]//Network connection details retrieved successfully

         • Schema

           Changed body: 'application/json'
415. GET/data/otn/connection/lldp/nename/{neName}/port/{portName}

     • Response

       • Changed response : [200]//LLDP parameter retrieved successfully

         • Schema

           Changed body: 'application/json'
416. GET/data/otn/connections/affectedConnections To get list of connections on a card or port which are affected by an alarm on the port.

     • Response

       • Changed response : [200]//Retrieved connection list affected by alarm successfully

         • Schema

           Changed body: '*/*'
417. GET/data/otn/clientPorts Retrieves client port details based on some condition. Along with 'PortAssigned' parameter, need to input one of the parameter either 'nodeName / neName' or 'nodeId'

     • Response

       • Changed response : [200]//Retrieved client port details successfully
418. GET/data/otn/Connection/{connId}/lldpParameter

     • Response

       • Changed response : [200]//LLDP parameter retrieved successfully
419. GET/data/otn/3RPorts

     • Response

       • Changed response : [200]//3R ports information on NE is retrieved successfully

         • Schema

           Changed body: 'application/json'
420. POST/data/otn/customer/modifyCustomerNew

     • Request

       • Schema

         Changed body: 'application/json'
421. POST/data/otn/customer/modifyCustomer

     • Request

       • Schema

         Changed body: 'application/json'
422. POST/data/otn/customer/deleteCustomerNew

     • Request

       • Schema

         Changed body: 'application/json'
423. POST/data/otn/customer/deleteCustomer

     • Request

       • Schema

         Changed body: 'application/json'
424. GET/otn/NBI/Connection/{invariantId}/timeslots/available to retrieve the available timeslots for a specified invariantId

     • Response

       • Changed response : [200]//Retrieved timeslots successfully

         • Schema

           Changed body: 'application/json'
425. GET/data/restnbi/connection/{id}/routeSwitchData

     • Response

       • Changed response : [200]//Retrieved route and switch data successfully

         • Schema

           Changed body: '*/*'
426. GET/data/otn/ports/{id}/wlt/{dir}/{band}

     • Response

       • Changed response : [200]//Physical ports power details retrieved successfully

         • Schema

           Changed body: '*/*'
427. GET/data/otn/diversityGroup/listservices list all the services in a diversity group

     • Response

       • Changed response : [200]//Retrieved services in diversitygroup successfully

         • Schema

           Changed body: 'application/json'
428. GET/data/otn/diversityGroup/compareservices compare two services in the diversity group and verify if they hold the same diversity rule

     • Response

       • Changed response : [200]//Retrieved compared services successfully

         • Schema

           Changed body: 'application/json'
429. GET/data/otn/connections/{id}/wlt/{dir}

     • Parameters

       • direction in query change into not required

     • Response

       • Changed response : [200]//Power details retrieved successfully

         • Schema

           Changed body: '*/*'
430. POST/data/otn/Connection

     • Request

       • Schema

         Changed body: 'application/json'
431. GET/data/otn/Connection/{id} To retrieve connection details for given connection ID for modify connection operation

     • Response

       • Changed response : [200]//Retrieved connection details successfully

         • Schema

           Changed body: 'application/json;charset=UTF-8'
432. POST/data/otn/Connection/{id}

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Modified the connection created successfully

         • Schema

           Changed body: 'application/json'
433. POST/data/otn/Connection/UsingTemplate

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//Connection created successfully

         • Schema

           Changed body: 'application/json'
434. POST/data/otn/Connection/Params

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • New response : [400]//Bad request
       • New response : [500]//Internal server error
       • Changed response : [200]//TX params retrieved successfully

         • Schema

           Changed body: 'application/json'
435. POST/data/otn/connection/{id}/wlt2/service/power/{direction} Retrieves power data for service/working path of a specific connection in specific direction

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • Changed response : [200]//Retrieved power data successfully

         • Schema

           Changed body: '*/*'
436. GET/data/otn/connection/{id}/wlt2/protected/power/{direction} Deprecated: Please use POST: /connection/{id}/wlt2/protected/power/{direction} to fetch power with Wlt2_Response layout data.

     • Response

       • Changed response : [200]//Power data for protected connection retrieved successfully

         • Schema

           Changed body: '*/*'
437. GET/data/otn/connection/{id}/wlt2/power

     • Response

       • Changed response : [200]//Power data for both AZ and ZA retrieved successfully

         • Schema

           Changed body: '*/*'
438. GET/data/otn/connection/{id}/wlt2/layout Retrieves the layout for the bidirectional connection given the connection ID seeAlso::/data/otn/connections

     • Response

       • Changed response : [200]//Retrieved layout for bidirectional connection successfully

         • Schema

           Changed body: '*/*'