Api Change Log

Application Versions⇑

Changes between 25.6.0 to 25.12.0

What's New⇑

1. GET/api/scheduledTasks Get list of all scheduled tasks
2. PUT/api/scheduledTasks Update an existing scheduled task
3. POST/api/scheduledTasks Create new scheduled task
4. GET/api/scheduledTasks/{id} Get a scheduled task by ID
5. PUT/api/scheduledTasks/{id} Update an existing scheduled task
6. DELETE/api/scheduledTasks/{id} Delete a scheduled task
7. PUT/api/scheduledTasks/{id}/deactivate Deactivate a scheduled task
8. PUT/api/scheduledTasks/{id}/activate Activate a scheduled task
9. PUT/api/designs/{designId}/updateSiteBulkEdit Update site bulk edit
10. PUT/api/designs/{designId}/trails/wtocmUsageBulk Update WTOCM usage on a list of OMS trail
11. PUT/api/designs/{designId}/swapLinesProtection Swap Lines Protection
12. PUT/api/designs/{designId}/sites/opaque Update Site opaque networking
13. PUT/api/designs/{designId}/site/{siteId}/l2pack/{l2packId} Update L2 Pack
14. PUT/api/designs/{designId}/segments/updateBulkEditSegments Update Bulk Edit Segments
15. PUT/api/designs/{designId}/otottrail Update OT OT trail
16. POST/api/designs/{designId}/otottrail Create OT OT trail
17. DELETE/api/designs/{designId}/otottrail Delete multiple OT-OT Trails
18. GET/api/designs/{designId}/opsConnections/{opsConnectionId} OPSConnection by Id
19. PUT/api/designs/{designId}/opsConnections/{opsConnectionId} Update OPSConnection
20. DELETE/api/designs/{designId}/opsConnections/{opsConnectionId} Delete opsConnection
21. PUT/api/designs/{designId}/node/{nodeId}/editmshconnections Edit Node MSH Connections By NodeId
22. PUT/api/designs/{designId}/node/{nodeId}/adBlocks/freeze Configure freeze state of add drop blocks for a given node
23. PUT/api/designs/{designId}/nes Update NEs
24. PUT/api/designs/{designId}/erules/updateOtCharacteristics Update OSNRMIN for given design
25. PUT/api/designs/{designId}/erules/updateOaCharacteristics Update OA Characteristics for given design
26. PUT/api/designs/{designId}/asellType ASE Line Loading.
27. GET/api/customPlrSpec Get Custom PLR report data
28. PUT/api/customPlrSpec Modify Custom PLR report
29. POST/api/customPlrSpec Create Custom PLR report
30. DELETE/api/customPlrSpec Delete Custom PLR report
31. POST/api/routing/designs/{designId}/computeOpsRouteConnections Compute OPSx5 connections.
32. POST/api/routing/designs/{designId}/applyEditRoute Completes the route edit process.
33. POST/api/report/{designId}/downloadDeltaBoqFile Downloads the generated delta BOQ
34. POST/api/report/viewCustomPLRForm Get custom PLR viewer form data for a CSV file
35. POST/api/report/v2/generateDeltaBOQ Export BOQ report
36. POST/api/report/downloadCplrAsXls Downloads the generated Custom PLR as excel from Viewer panel
37. POST/api/report/designs/{designId}/viewCustomPLRForm Get custom PLR viewer form data for a design
38. POST/api/ppt Generate CLI files
39. POST/api/ppt/uploadCommissioningFile Upload Commissioning File
40. POST/api/designs/{designId}/validateSiteBulkEdit Validate site bulk edit
41. DELETE/api/designs/{designId}/systems Delete Multiple Systems
42. POST/api/designs/{designId}/systems/systemPowerTuning OMS Power Tuning of Multiple Selected Systems.
43. POST/api/designs/{designId}/systems/systemPowerTuning/{systemId} OMS Power Tuning of a System.
44. POST/api/designs/{designId}/site/{siteId}/modifyL2SyncNetwork Modify L2 Sync Network
45. POST/api/designs/{designId}/site/{siteId}/l2pack Create L2 Pack
46. POST/api/designs/{designId}/segments/validateBulkEditSegments Validate Bulk Edit Segments
47. GET/api/designs/{designId}/opsConnections Retrieve OPSConnections
48. POST/api/designs/{designId}/opsConnections Create OpsConnection
49. POST/api/designs/{designId}/nes/{neId}/matrixInstance Create potential Matrix Id in a Network Element
50. POST/api/designs/{designId}/ne/{neId}/regenerator Create regenerator
51. POST/api/designs/{designId}/ne/{neId}/regenOptions Retrieving the regenerator option values for manual creation
52. POST/api/designs/{designId}/freeze Configure freeze state for all entities in the design
53. POST/api/designs/{designId}/demands/routeTakeOver Route take over
54. POST/api/designs/{designId}/bundle/share Share equipment bundle
55. POST/api/designs/{designId}/bundle/import Import equipment bundle
56. GET/api/designs/{designId}/allConfigurableFeatures Retrieving List of All Configurable Features
57. POST/api/designs/{designId}/allConfigurableFeatures Enabling/Disabling Configurable Features
58. PATCH/api/designs/{designId}/demands/bulk Bulk Patch Demands
59. GET/api/viewDemandFormData Downloads the generated PLR From Viewer
60. GET/api/templates/{templateId}/paramList Retrieve template param as list based on template id
61. GET/api/scheduledTasks/gettime Get current server time
62. GET/api/scheduledTasks/getDtos Get list of all scheduled task dto
63. GET/api/scheduledTasks/actions Get list of all scheduled actions
64. GET/api/report/viewCustomPLR Get All Filtered Response From Viewer CPLR Spec Report
65. GET/api/report/viewCustomPLRFromFilePath Get custom PLR viewer form data for a CSV file path
66. GET/api/report/downloadPlrFromViewer Downloads the generated PLR From Viewer
67. GET/api/report/designs/{designId}/downloadCplrAsXls Downloads the generated CPLR Spec Report as excel
68. GET/api/report/designs/{designId}/downloadCplrAsCsv Downloads the generated CPLR Spec Report as CSV
69. GET/api/report/customPlrDiagramResponse Get Diagram Response From Viewer Custom PLR Spec Report
70. GET/api/ppt/{fileName} Get Generated CLI files
71. GET/api/ppt/log/{fileName} Get Generated CLI files
72. GET/api/ppt/isPPTRunning Is PPT Process running
73. GET/api/ppt/entityList Retrieve list of systems, ne's and cluster ne's from the commissioning file
74. GET/api/ppt/customizedNEsList Retrieve list of non cluster ne's from the commissioning file
75. GET/api/licenseInfo Standalone License Information
76. GET/api/getAllTrailsList Get All Trails with design id
77. GET/api/designs/{designId}/{inputEntity}/{inputEntityId}/getPageNumber/{pageSize} Retrieves the page number using entity ID
78. GET/api/designs/{designId}/site/{siteId}/getL2SyncNetwork Get L2 Sync Network
79. GET/api/designs/{designId}/site/{siteId}/getL2PortsForTree Get L2 Pack ports details
80. GET/api/designs/{designId}/reports/networkOptimizationReport Export Network Optimization Report as Excel
81. GET/api/designs/{designId}/node/{nodeId}/mshconnections Retrieve Node MSH Connections
82. GET/api/designs/{designId}/node/{nodeId}/adbTblData Retrieve add drop block data associated to node for table
83. GET/api/designs/{designId}/newOpsConnectionName/{aEndSiteId}/{bEndSiteId} Retrieve New OPSConnection name
84. GET/api/designs/{designId}/l2packs Retrieve L2 Pack Details
85. GET/api/designs/{designId}/erules/{otCharacteristicKey}/OtTypes Retrieving OT types for given E-Rules OT Characteristic key
86. GET/api/designs/{designId}/erules/OtCharacteristicsTable Retrieving information for E-Rules OT Characteristic table for a design
87. GET/api/designs/{designId}/erules/OtCharacteristicsDetails Retrieving information for E-Rules OT Characteristic details for a design
88. GET/api/designs/{designId}/erules/OaCharacteristicsTable Retrieving information for E-Rules OA Characteristic table for a design
89. GET/api/designs/{designId}/erules/OaCharacteristicsDetails Retrieving information for E-Rules OA Characteristic details for a design
90. DELETE/api/designs/{designId}/colorProfiles Delete Multiple Color Profiles by Id
91. GET/api/designs/{designId}/bundle/{bundleId} Retrieve equipment bundle by id
92. GET/api/designs/{designId}/bundle/export Export equipment bundle
93. GET/api/designs/permissionMask/{designId} Retrieve design permission mask based on designId.
94. GET/api/customPlrSpecList Get Custom PLR report list
95. GET/api/customPlrSpecById/{id} Get Custom PLR data by id
96. DELETE/api/customPlrSpecById/{id} Delete Custom PLR report by id
97. DELETE/api/designs/{designId}/removeDesign Remove design
98. DELETE/api/designs/{designId}/nes/{neId}/matrixInstance/{matrixId} Delete potential Matrix Instance in a Network Element
99. DELETE/api/designs/{designId}/l2pack Delete multiple L2 Packs
100. DELETE/api/designs/{designId}/demands/route Delete multiple demand route

What's Deleted⇑

1. POST/api/jobs/designs/{designId}/asellState ASE Line Loading.
2. POST/api/designs/{designId}/preferences/{preferenceId} Create the user preferences
3. GET/api/designs/{designId}/designPreferences Retrieve design Preferences For a Design
4. POST/api/designs/{designId}/designPreferences Create and Save Design Preferences
5. GET/api/reports/ept/comm Exports the commissioning file
6. GET/api/designs/{designId}/preferences Retrieve user preferences for a design
7. GET/api/designs/{designId}/nes/{neId}/shelfNumbers Retrieve the Shelf Number
8. DELETE/api/designs/{designId}/colorProfile/{colorProfileId} Delete Color Profile by Id

What's Deprecated⇑

1. No Changes

What's Changed⇑

1. PUT/api/designs/{designId}/description

   • Response

     • Changed response : [200]//Design description updated successfully
       • Deleted body: 'text/plain'
2. POST/api/designs/{designId}/segments/mesh

   • Parameters

     • Add meshType in query
3. GET/api/designs/{designId}/templates/type/{templateType}

   • Parameters

     • Add designId in path//Design Id designId can be obtained from design name using 'id' field from REST response '/api/allDesign?name={Design_Name}'.
4. GET/api/designs/{designId}/reports/gmpls

   • Parameters

     • reportType in query
5. GET/api/designs/{designId}/reports/commission

   • Parameters

     • reportType in query
6. GET/api/designs/{designId}/node/{nodeId}/block/{blockId}/schematicView/block

   • Response

     • Changed response : [200]//Retrieves the data for node schematic panel inside BlockSchematicPanelData structure

       • Schema incompatible

         Changed body: '*/*'

         Missing property: schematicConnectionSet (object)

         Missing property: nodeId (object)

         Missing property: nodeName (object)

         Missing property: nodeType (object)

         Missing property: schematicPackSet (object)

         Missing property: otSchematicPackSet (object)

         Missing property: portDetailsListWithApn (object)

         Missing property: blockId (object)

         Missing property: blockName (object)

         Missing property: blockTypeCategory (object)

         Missing property: blockType (object)

         Missing property: mshPackGuiId (object)

         Missing property: mlfsbPackGuiId (object)

         Missing property: schematicPanelErrorMessage (object)

         Missing property: schematicPanelErrorCause (object)

         Missing property: edgePackSet (object)

         Missing property: edgeConnectionSet (object)

         Missing property: empty (object)

7. GET/api/designs/{designId}/l0

   • Parameters

     • reportType in query
8. GET/api/designs/{designId}/bundles

   • Parameters

     • Add bundleId in query//Bundle id to exclude
9. POST/api/jobs/designs/{designId}/setWarningSuppression

   • Parameters

     • Add isAllSuppression in query//Suppression all warnings with similar description
10. POST/api/designs/{designId}/convertDesign

    • Parameters

      • Add convertToCpTrail in query
11. GET/api/designs/{designId}/map/sites

    • Parameters

      • Add nonVneSites in query//Optional Parameter. Specifies if the response should include V-NE sites or not
12. GET/api/designs/{designId}/map/otottrails

    • Parameters

      • Add Range in header
13. GET/api/routing/designs/{designId}/getRoutesClassic/{isFirstLayer}

    • Parameters

      • Add routeType in query//Optional Parameter. Specifies the route type. Default is Working. Possible values are Working, Protecting, Both.
14. GET/api/designs/{designId}/demands/availableTrailsForProvisioning

    • Parameters

      • demandType in query
15. GET/api/designs/{designId}/demands/availableDemandForProvisioning

    • Parameters

      • demandType in query
16. DELETE/api/designs/{designId}/sites

    • Response

      • Changed response : [200]//Sites deleted Successfully
        • Deleted body: '*/*'
17. POST/api/designs/{designId}/sites

    • Request

      • Schema incompatible

        Changed body: 'application/json'