Api Change Log

Application Versions⇑

Changes between 24.12 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/commonscheduler/job/reschedule/{jobHandleId} description: reschedule common scheduler job from joblist for specified 'jobHandleId'
6. GET/tca/v1/alarm-profiles Get TCA Profiles
7. POST/tca/v1/alarm-profiles Creates TCA profile for Non Compliant and At Risk thresholds
8. POST/schedule/data/otn/ports/{id}/protectionSwitch Schedule protection switch operation on Protection Group from RD, schedule info specified in 'payload'.
9. POST/schedule/data/otn/ports/{id}/loopback Schedule loopback operation, schedule info specified in 'payload'.
10. POST/schedule/data/otn/connections/{id}/manage Schedule protection switch job, schedule info is specified in 'payload'.
11. POST/schedule/data/otn/connections/{id}/action Schedule change connection state schedule info specified in 'payload'.
12. POST/schedule/data/npr/asonSwitchs/{cointoIdList}/switchCmd Schedule ASON SNC protection switch job, schedule info is specified in 'payload'.
13. POST/pm/tcaProfiles/{tcaId} Modifies TCA Profile
14. DELETE/pm/tcaProfiles/{tcaId} Deletes TCA
15. GET/pm/tcaProfiles Lists all TCA Profiles
16. POST/pm/tcaProfiles Creates TCA profile
17. POST/data/otn/renameLabel Renaming of the label name.
18. POST/data/otn/notes/deleteAllNotes delete a new note
19. POST/data/otn/mIntervals/miAssociation/{maintenanceIntervalId}/bulk Create maintenance interval associations for bulk entities for a maintenance interval id
20. POST/data/otn/mIntervals/miAssociation/delete/bulk delete maintenance interval associations in bulk for list of association ids
21. POST/data/otn/deleteLabel deletion of the label.
22. POST/data/otn/darkfibers/dcm/update/{dfIds} Update DCM flag for one or multiple dfId
23. POST/data/otn/darkfiber/dcm/update/{dfIds} Update DCM flag for one or multiple dfId
24. 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’.
25. POST/data/otn/connection/{id}/wlt2/protected/power/{direction} Retrieves power data for protected path of specific connection in specific direction
26. POST/data/otn/commonscheduler/bulk/schedule Schedule multiple common REST jobs for different connections/objects specified in 'bulkPayload'.
27. POST/data/npr/teLinks/realignLatency Bulk Realign Latency
28. POST/data/eml/NE/GRI/timeStamp Gets Last Modified Time of GRI Files
29. POST/emlnemgr/NE/GRI/timeStamp Gets Last Modified Time of GRI Files
30. POST/data/npr/trails/optimizeCurrentRouteCmd/{trailId} optimizeCurrentRouteCmd
31. POST/data/asonNBI/trails/optimizeCurrentRouteCmd/{trailId} optimizeCurrentRouteCmd
32. GET/tca/v1/alarm-profiles/configuration-params API to fetch TCA configuration parameters for different types of connections.
33. GET/tca/v1/alarm-profile-config/{entityId}/{entityType} Get TCA Config counter for entity id and entity type
34. GET/data/plat/usermgt/password-status/{username} Get password expiration status for a specific user
35. GET/data/otn/mIntervals/progressOfMaintenanceIntervalList Get the progress of maintenance Interval data for each object
36. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/trail/{trailId} Get All Maintenance Interval and Maintenance Interval History Data for the network trail connection
37. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/shelf/{shelfId} Get All Maintenance Interval and Maintenance Interval History Data with respect to shelf
38. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/port/{portId} Get all Maintenance Interval and Maintenance Interval History Data with respect to the port
39. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/phyconn/{phyconnId} Get All Maintenance Interval and Maintenance Interval History Data for the network physical Connection
40. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/path/{pathId} Get All Maintenance Interval and Maintenance Interval History Data for the given network path
41. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/ne/{neId} Get all Maintenance Interval and Maintenance Interval History Data with respect to Network Element
42. GET/data/otn/mIntervals/maintenanceIntervalsAndHistory/card/{cardId} Get All Maintenance Interval and Maintenance Interval History Data with respect to network card
43. GET/data/otn/mIntervals/intervalAssociationDetails/objectType/{objectType} Get All Interval Association Details for the given object type and FDN Number
44. GET/data/otn/mIntervals/cascade/ne/{neId} Get all the cascade connection details for Network Element
45. GET/data/otn/customExpertProfiles To retrieve all the Custom Expert Profiles
46. GET/data/otn/customExpertProfiles/{customExpertProfileId} To retrieve the particular custom profile id
47. GET/data/otn/customExpertProfiles/trails/{iProfileId} Retrieve the list of Tunnels created using the particular custom profile id.
48. GET/data/otn/customExpertProfiles/networkElements/{iProfileId} To retrieve Network Elements details based on the particular Custom Expert Profile Id
49. 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.
50. GET/data/otn/connection/customExpertProfiles/{id} To retrieve the list of custom expert profiles configured in the particular node
51. GET/data/otn/cardLists Get Card List
52. GET/data/eml/getPortPluggableData Gets the pluggable type and subtype for GX NEs
53. GET/data/npr/getPortPluggableData Gets the pluggable type and subtype for GX NEs
54. DELETE/tca/v1/alarm-profiles/{profileIds} Deletes TCA Profiles
55. DELETE/tca/v1/alarm-profiles-association/{type}/{entityIds}/bulk Un-Associate multiple NE, Card and Port from the tca profile
56. DELETE/data/plat/usermgt/deleteuser Used to Delete the User
57. DELETE/data/otn/mIntervals/deleteIntervalAssociationByType/{objectType}/{id} delete Maintenance Interval Association by object type and entity id
58. DELETE/data/otn/mIntervals/deleteIntervalAssociation/{associationId} delete Maintenance Interval Association
59. 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} Reschedule ASON reversion job
3. PUT/data/asonNBI/trails/reversion/joblist/{jobDetailsId}/{jobName} Reschedule ASON reversion job
4. PUT/data/npr/ports/reversion/joblist/{jobDetailsId}/{jobName} Reschedule ASON reversion job
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/pae/paeGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category} Retrieves the Shelf and Card PAE Entity for 1830VWM.
17. GET/network-health/{page}/details get Network Health Details By Page
18. GET/network-health/pushData/{dataFileName} pushDataToPmKafka
19. GET/network-health/overall/index get Network Health
20. GET/network-health/fetchData/{filePath} fetch Nhi Data
21. GET/network-health/code-status get Health Color Codes
22. GET/data/otn/otdrscan/sync/{neId} Get custom profiles from NE for a given ID.
23. GET/data/otn/sync/{neId} Get custom profiles from NE for a given ID.
24. GET/data/npr/ports/{trailId}/switchTab switchTab
25. GET/data/npr/ports/{trailId}/nominalRoute Trails
26. GET/data/npr/ports/{trailId}/nominalRoutecard Trails
27. GET/data/npr/ports/{trailId}/currentRoute Trails
28. GET/data/npr/ports/{trailId}/currentRoutecard Trails
29. GET/data/npr/ports/{trailId}/backupRoute Trails
30. GET/data/npr/ports/{trailId}/configuredBackupRoute Trails
31. GET/data/npr/ports/{trailId}/revBlockedSnc Trails
32. GET/data/npr/ports/{trailId}/pof Trails
33. GET/data/npr/ports/{trailId}/priorities Trails
34. GET/data/npr/ports/{trailId}/asonRoutingFailureInfo Trails
35. GET/data/npr/ports/{trailId}/routingConstraints Trails
36. GET/ason/schedule/{trailId}/nominalRoute Trails
37. GET/ason/schedule/{trailId}/nominalRoutecard Trails
38. GET/ason/schedule/{trailId}/currentRoute Trails
39. GET/ason/schedule/{trailId}/currentRoutecard Trails
40. GET/ason/schedule/{trailId}/backupRoute Trails
41. GET/ason/schedule/{trailId}/configuredBackupRoute Trails
42. GET/ason/schedule/{trailId}/revBlockedSnc Trails
43. GET/ason/schedule/{trailId}/pof Trails
44. GET/ason/schedule/{trailId}/priorities Trails
45. GET/ason/schedule/{trailId}/asonRoutingFailureInfo Trails
46. GET/ason/schedule/{trailId}/routingConstraints Trails
47. GET/data/npr/ports/{trailId}/linkAsonsSnc getLinkInAsonsSnc
48. GET/data/npr/trails/{portId}/invmuxports portInvmuxports
49. GET/ason/schedule/{portId}/invmuxports portInvmuxports
50. GET/data/npr/ports/pie pieAsonSnc
51. GET/data/npr/trails/joblist/{jobHandleId} get ASON reversion data job
52. GET/data/npr/ports/joblist/{jobHandleId} get ASON reversion data job
53. GET/data/npr/trails/isNeVersion14/{trailId} NeVersion
54. GET/data/asonNBI/trails/isNeVersion14/{trailId} NeVersion
55. GET/data/npr/ports/isNeVersion14/{trailId} NeVersion
56. GET/ason/schedule/isNeVersion14/{trailId} NeVersion
57. GET/data/npr/ports/getHistoricalRoutes/{trailOrConnId} Get stored previous routes of ASON SNC
58. GET/ason/schedule/getHistoricalRoutes/{trailOrConnId} Get stored previous routes of ASON SNC
59. GET/data/npr/ports/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes
60. GET/ason/schedule/fetchHistoricalRoutes/{trailId}/{timeZone} Fetch Historical Routes
61. GET/data/npr/ports/alarmed/{probCause} Get Alarmed ASON SNCs
62. GET/ason/schedule/alarmed/{probCause} Get Alarmed ASON SNCs
63. DELETE/data/plat/usermgt/deleteuser/{id} Delete User
64. POST/data/npr/ports modifyTrailAttributes
65. GET/data/network/generateReport Generate Network Report
66. GET/data/otn/generateReport Generate Network Report

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/otn/labelsByObjectId This API is to retrieve all the labels associated with the given business object.
8. POST/data/otn/connection/{id}/wlt2/service/power/{direction} Retrieves power data for service/working path of a specific connection in specific direction
9. 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. 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. ----------------------------------------------------------------------------------------------------
2. GET/swim/transferFile/fileLoc/{emlip}/{emlid}/{emlgroup}/{strB}/{dirFilePath}/{dirFilePath1}/{neLabel}/

   • Response

     • Deleted response : [500]//Internal Server Error
     • Deleted response : [400]//Bad Request
     • Changed response : [200]//OK
3. GET/ptpclock/{neGroupId}/{neId}/{cardName}/{portID}/portstats

   • Response

     • Deleted response : [400]//Bad Request. If the payload data is incorrect
     • Changed 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/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)

9. 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
10. 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
11. 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
12. GET/eqm/snmpTable/wavekey/out Access Log Retrieval from WaveKey out data for the ports.

    • Response

      • Changed response : [500]//Internal Server Error
        • New body: 'application/json'
        • Deleted body: '*/*'
      • Changed response : [400]//Bad Request
        • New body: 'application/json'
        • Deleted body: '*/*'
      • 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

      • Changed response : [200]//Retrieves Wavekey IN data for the given port from the NE.
        • New body: 'application/json'
        • Deleted body: '*/*'
      • Changed response : [500]//Internal Server Error
        • New body: 'application/json'
        • Deleted body: '*/*'
      • Changed response : [400]//Bad Request
        • 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

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

    • Response

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

    • Response

      • Changed response : [500]//Internal Server Error
        • New body: 'application/json'
        • Deleted body: '*/*'
      • Changed response : [200]//Retrieves Per Channel Target Power Offset Ingress Data for the given port from the NE.
        • New body: 'application/json'
        • Deleted body: '*/*'
      • Changed response : [400]//Bad Request
        • 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/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)

24. 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)

25. 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)

26. 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)

27. 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
28. 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
29. 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)

30. 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)

31. 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)

32. 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)

33. 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)

34. 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)

35. 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)

36. 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)

37. 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)

38. 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)

39. 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
40. 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: '*/*'
41. GET/data/plat/userprofile/acds Retrieve all Acd List

    • Response

      • Changed response : [200]//Obtained ACD list successfully.
        • New body: 'application/json'
        • Deleted body: '*/*'
42. 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
43. 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'
44. GET/data/otn/mIntervals/progressOfMaintenanceInterval Get the progress of maintenance Interval

    • Response

      • Changed response : [200]//Returns the progress of maintenance interval. The following states are displayed: Success,Scheduled,In Progress,Completed
        • New body: 'application/json'
        • Deleted body: '*/*'
45. GET/data/otn/mIntervals/maintenanceIntervals Get all the data related to Maintenance Interval Data

    • Response

      • Changed response : [200]//List all the maintenance interval data.The following states are displayed: Success,InProgress,Scheduled
        • New body: 'application/json'
        • Deleted body: '*/*'
46. GET/data/otn/mIntervals/intervalDetails/{id} Get All Maintenance Interval Details for the given interval id

    • Response

      • Changed response : [200]//List all the maintenance interval details. The following states are displayed: Success,Inprogress,Scheduled
        • New body: 'application/json'
        • Deleted body: '*/*'
47. GET/data/otn/mIntervals/intervalAssociationDetails/{intervalId} Get All Interval Association Details for the given interval id

    • Response

      • Changed response : [200]//List all the maintenance interval association details for the given interval identifier.The following states are displayed: Success,InProgress,Scheduled
        • New body: 'application/json'
        • Deleted body: '*/*'
48. GET/data/otn/mIntervals/intervalAssociationDetails/{intervalId}/objectType/{objectType} Get All Interval Association Details for the given interval id and the object type

    • Response

      • Changed response : [200]//List all the maintenance interval association details for the given interval identifier and the object type. The following states are displayed: Success,InProgress,Scheduled
        • New body: 'application/json'
        • Deleted body: '*/*'
49. GET/data/otn/mIntervals/countOfMaintenanceInterval Get all the count of maintenance Interval for each object

    • Response

      • Changed response : [200]//The count of maintenance Interval for each object are retrieved successfully
        • New body: 'application/json'
        • Deleted body: '*/*'
50. 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)

51. 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'
52. 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'
53. 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'
54. 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'
55. 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'
56. 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'
57. 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'
58. 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'
59. 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'
60. 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'
61. 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'
62. 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'
63. 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'
64. 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.
65. GET/data/npr/trails/getHistoricalRoutes/{trailOrConnId}

    • Parameters

      • 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)

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

    • Parameters

      • 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)

67. 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'
68. 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'
69. 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: '*/*'
70. 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: '*/*'
71. 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: '*/*'
72. 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. --------------------------------------------------------------------------------------------------
73. 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. --------------------------------------------------------------------------------------------------
74. 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: '*/*'
75. 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: '*/*'
76. 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)

77. 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)

78. 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. ------------------------------------------------
79. 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. ------------------------------------------------
80. 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 ] ----------------------------------------
81. 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.
82. 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.
83. 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.
84. 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.
85. 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.
86. 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.
87. 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.
88. 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.
89. 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}.
90. 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.
91. 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.
92. 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.
93. 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.
94. 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.
95. 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.
96. 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.
97. 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.
98. 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}.
99. 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: '*/*'
100. 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: '*/*'
101. 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: '*/*'
102. 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: '*/*'
103. 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: '*/*'
104. 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: '*/*'
105. 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: '*/*'
106. 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: '*/*'
107. 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: '*/*'
108. 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. ----------------------------------------
109. 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. ------------------------------------------------
110. 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. ----------------------------------------
111. 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. ------------------------------------------------
112. 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. ------------------------------------------------
113. 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. ----------------------------------------
114. 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: '*/*'
115. GET/data/npr/linkAsons/{ids} Retrieves ASON links for specified IDs

     • Response

       • Changed response : [200]//List of LinkAson
         • New body: 'application/json'
         • Deleted body: '*/*'
116. 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: '*/*'
117. 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: '*/*'
118. 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: '*/*'
119. GET/data/npr/teLinks/{ids} Retrieves TeLinks for the specified IDs

     • Response

       • Changed response : [200]//Response is TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
120. 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: '*/*'
121. 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.
122. 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. -------------------------------------------------------------------------------------------------------
123. 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: '*/*'
124. 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. ----------------------------------------
125. 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. ------------------------------------------------
126. 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. ----------------------------------------
127. 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. ------------------------------------------------
128. 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. ------------------------------------------------
129. 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. ----------------------------------------
130. 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: '*/*'
131. 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: '*/*'
132. 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: '*/*'
133. 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: '*/*'
134. GET/data/asonNBI/teLinks/{ids} Retrieves TeLinks for the specified IDs

     • Response

       • Changed response : [200]//Response is TeLinks
         • New body: 'application/json'
         • Deleted body: '*/*'
135. 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: '*/*'
136. 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.
137. 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. ----------------------------------------
138. 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. ------------------------------------------------
139. 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. ----------------------------------------
140. 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. ------------------------------------------------
141. 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: '*/*'
142. 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: '*/*'
143. 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. -------------------------------------------------------------------------------------------------------
144. 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. ----------------------------------------------------------------------------------------------------
145. 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: '*/*'
146. 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. ------------------------------------------------------------------------------------------------------
147. 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 --------------------------------------------------------------------------------------------------
148. 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. ----------------------------------------------------------------------------------------------------
149. 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. ------------------------------------------------
150. 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. ----------------------------------------
151. 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. --------------------------------------------------------------------------------------------------
152. 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'
153. 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'
154. 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'
155. 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'
156. 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'
157. 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'
158. 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'
159. 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
160. 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'
161. GET/data/npr/colorProfiles/{colorProfileId}/elem Retrieve elementary details of Color Profiles

     • Parameters

       • DeleteAcceptin header

     • Response

       • Changed response : [200]//List of ColorProfile
162. 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
163. GET/data/npr/colorProfiles/{colorProfileId}/teLinkColProf Retrieve Telinks associated to color profile

     • Parameters

       • DeleteAcceptin header

     • Response

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

     • Parameters

       • DeleteAcceptin header

     • Response

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

     • Response

       • Changed response : [200]//Obtained userchannel successfully
         • New body: 'application/json'
         • Deleted body: 'application/text'
166. 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)

167. 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)

168. 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)

169. DELETE/data/otn/mIntervals/deleteInterval/{id}

     • Response

       • Changed response : [200]//success message
         • New body: 'text/plain'
         • Deleted body: '*/*'
170. 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.
171. 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.
172. 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.
173. PUT/data/otn/mIntervals/updateInterval/{id}

     • Request

       • Schema incompatible

         Changed body: 'application/json'

     • Response

       • Changed response : [200]//updated Maintenance interval data

         • Schema

           Changed body: 'application/json'
174. POST/tcaProfiles

     • Request

       • Schema

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

     • Request

       • Schema

         Changed body: 'application/json'
176. 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
177. 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
178. POST/data/plat/userprofile/updategroup This is used to modify group

     • Response

       • Deleted response : [400]//Updated group failed, check the ACD used.
       • Changed response : [200]//OK
179. POST/data/plat/ts/tasks/newtask

     • Response

       • Changed response : [200]//OK
180. POST/data/plat/session/historyLogin

     • Response

       • Changed response : [200]//OK
181. POST/data/plat/br/jobs/{jobId} This is used to Create Backup for a particular backup domain

     • Response

       • Changed response : [200]//OK
182. POST/data/otn/mIntervals/createInterval

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • Changed response : [200]//created Maintenance interval data

         • Schema

           Changed body: 'application/json'
183. 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
184. POST/data/otn/darkfiber/{id}

     • Parameters

       • Deprecatedspooldatain query//spool data of a and z ends (Deprecated - no longer used).
185. 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
186. POST/data/otn/darkfibers/{id}

     • Parameters

       • Deprecatedspooldatain query//spool data of a and z ends (Deprecated - no longer used).
187. 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
188. POST/data/otn/darkfiber

     • Parameters

       • Add dcmpresent in query//Indicates whether DCM is present
189. GET/data/npr/trails Retrieves all the available SNCs

     • Response

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

     • Response

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

     • Parameters

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

     • Parameters

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

     • Parameters

       • threerId in path
194. 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: '*/*'
195. 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. -------------------------------------------------------------------------------------------------------
196. GET/data/npr/npas This API retrieves all the NPAs

     • Response

       • Changed response : [200]//List of NPAs
         • New body: 'application/json'
         • Deleted body: '*/*'
197. 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: '*/*'
198. 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.
199. 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
200. 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
201. 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
202. 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: '*/*'
203. 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
204. 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
205. GET/data/swim/checkNeInDownloadJob/{neIds}/{neType}/ Fetch the NE list

     • Response

       • Changed response : [200]//Successfully retrieved the NE details for the single or multiple NE
206. GET/data/plat/usermgt/users This is used to get all users in the system

     • Response

       • Changed response : [200]//OK

         • Schema incompatible

           Changed body: '*/*'

           Missing property: [n].almapOsprofiles (string)

           Changed property type: [n].userPassword (array -> string)

           Changed property type: [n].listId (integer -> string)

207. GET/data/plat/tasks

     • Response

       • Changed response : [200]//OK
208. GET/data/plat/session/login/presList

     • Response

       • Changed response : [200]//OK
209. 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.
210. 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.
211. 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
212. 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
213. 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
214. GET/asap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}

     • Response

       • Deleted response : [400]//Bad Request. If the payload data or parameter is incorrect
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (array -> string)

       • Changed response : [500]//Internal server error
215. DELETE/data/plat/ts/tasks/deletetask/{id}

     • Response

       • Changed response : [200]//OK
216. POST/otn/PathSyncScheduler To create a scheduled path sync job

     • Request

       • Schema

         Changed body: 'application/json'
217. POST/data/otn/mIntervals/miAssociation create Maintenance Interval Association

     • Request

       • Schema

         Changed body: 'application/json'

     • Response

       • Changed response : [200]//created Maintenance interval association data

         • Schema

           Changed body: 'application/json'
218. POST/data/otn/mIntervals/createIntervalHistory/{intervalId}/objectType/{objectType} create Maintenance Interval History for the given maintenance interval id.

     • Response

       • Changed response : [200]//created Maintenance interval history data

         • Schema incompatible

           Changed body: 'application/json'
219. 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'
220. GET/eqm/ne/getNeOCS/{grpID}/{neID}/{retrieveFunction} Retrieves OCS NE level details and attributes for the Network Element.

     • Response

       • Deleted response : [400]//Bad Request
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error
221. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}

     • Response

       • Deleted response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error

         • Schema incompatible

           Changed body: 'application/json'
222. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}

     • Response

       • Deleted response : [400]//Bad Request. If the payload data or parameter is incorrect
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error

         • Schema incompatible

           Changed body: 'application/json'
223. GET/eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}/{subSlot}

     • Response

       • Deleted response : [400]//Bad Request. If the payload data is incorrect
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error

         • Schema incompatible

           Changed body: 'application/json'
224. GET/eqm/Ports/PortViewWavelite/{grpID}/{neID}/{sysDesc}/{omsPortAid}

     • Response

       • Deleted response : [400]//Bad Request
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error
225. GET/eqm/Ports/PortViewEQMGUI/{grpID}/{neID}/{cardAid}/{omsPortAid}/{signalType}

     • Response

       • Deleted response : [400]//Bad Request
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error
226. GET/eqm/Ports/PortView/{grpID}/{neID}/{cardAid}/{omsPortAid}/{signalType}

     • Response

       • Deleted response : [400]//Bad Request
       • Changed response : [200]//Successful response

         • Schema incompatible

           Changed body: 'application/json'

           Changed property type: (object -> string)

       • Changed response : [500]//Internal server error
227. 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
228. GET/data/otn/psEvents To retrieve protection switch events for a sepcified connection

     • Response

       • Changed response : [200]//Protection switch events have been successfully retrieved.
229. 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'
230. 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'
231. 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'
232. 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: '*/*'
233. 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 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'
234. 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 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'
235. 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 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'
236. GET/data/otn/connection/path

     • Parameters

       • Add fiberSensing in query//'fiberSensing' can be retrieved as 'fiberSensing' from 'data/otn/trails' ReST call
237. GET/data/otn/connections/paths

     • Parameters

       • Add fiberSensing in query//'fiberSensing' can be retrieved as 'fiberSensing' from 'data/otn/trails' ReST call
238. 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'
239. GET/data/otn/connections/{id}/wlt/{dir}

     • Parameters

       • direction in query change into not required
240. POST/data/otn/Connection/{id}

     • Request

       • Schema

         Changed body: 'application/json'