Api Change Log

Application Versions⇑

Changes between 23.12.0 to 24.6.0

What's New⇑

  1. PUT /api/users/activate Activate/Deactivate User
  2. PUT /api/designs/{designId}/updateLineProtection Update Line Protection
  3. PUT /api/designs/{designId}/unpublish Unpublish design revision
  4. PUT /api/designs/{designId}/trails/fullCplusLupgrade upgrade lines to full C plus L
  5. PUT /api/designs/{designId}/trails/cMinusLupgrade upgrade lines to C minus L
  6. PUT /api/designs/{designId}/swapLineProtection/{lpId} Swap Line Protection
  7. PUT /api/designs/{designId}/slots/{slotId} Update Pack
  8. PUT /api/designs/{designId}/slots/{slotId}/ports/{portId} Update Port
  9. GET /api/designs/{designId}/sites/{siteId}/mergeSpans Retrieve merge span validation messages
  10. PUT /api/designs/{designId}/sites/{siteId}/mergeSpans Merge Spans
  11. GET /api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} RouteOverConstraint by Id
  12. PUT /api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} Update RouteOverConstraint
  13. DELETE /api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} Delete RouteOverConstraint
  14. PUT /api/designs/{designId}/publish Publish design revision
  15. PUT /api/designs/{designId}/nodes/{nodeId}/trail/{omsId}/togt Change ILA to GT
  16. PUT /api/designs/{designId}/nodes/{nodeId}/ilawtocm Equip/UnEquip ILA with WTOCM
  17. PUT /api/designs/{designId}/nodes/{nodeId}/ilashelftype Change shelfType in ILA
  18. PUT /api/designs/{designId}/nodes/{nodeId}/ilaconversion ILA node conversion
  19. PUT /api/designs/{designId}/nodes/{gtId}/trail/{omsId}/toila Change GT to ILA
  20. PUT /api/designs/{designId}/node/{nodeId}/lineBlocks/{blockInstance}/virtualOT Edit Line Block virtual OT
  21. PUT /api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/section/{sectionId}/editadbnoise Edit AdbNoise Details By PackId and SectionId
  22. PUT /api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/editadbnoise Edit AdbNoise Details By PackId
  23. PUT /api/designs/{designId}/failureScopes/{id}/active Set Failure Scope as active
  24. PUT /api/designs/{designId}/designPermission/user Set User Roles for Design
  25. DELETE /api/designs/{designId}/designPermission/user Remove User Roles for Design
  26. GET /api/designs/{designId}/colorProfile/{colorProfileId} Retrieve Color Profiles associated to Design
  27. PUT /api/designs/{designId}/colorProfile/{colorProfileId} Update Color Profile
  28. DELETE /api/designs/{designId}/colorProfile/{colorProfileId} Delete Color Profile by Id
  29. GET /api/designs/{designId}/bomSettings Get BOM settings for design
  30. PUT /api/designs/{designId}/bomSettings Update BOM settings for design
  31. GET /api/designs/{designId}/alienShelves/{asId} Retrieve Shelf
  32. PUT /api/designs/{designId}/alienShelves/{asId} Move Alien Shelf
  33. PUT /api/designs/{designId}/OTUplinkPreferenceTemplate/{operation} To associate/dissociate OT/Uplink Preference
  34. GET /api/designFamily/{id} Get design family based on id
  35. PUT /api/designFamily/{id} Update design family name and description
  36. PUT /api/OTUplinkPreferenceTemplate/{templateId} Update OT/Uplink Preference
  37. DELETE /api/OTUplinkPreferenceTemplate/{templateId} delete OT/Uplink Preference
  38. POST /api/routing/designs/{designId}/resetValidationClassic/{routeId}/{demandId} Delete Validate Cache for classic
  39. POST /api/routing/designs/{designId}/applyEditClassic Invoke to apply the selected changes on to route.
  40. POST /api/reports/{designId}/wizardReport/view Get Wizard Report file
  41. POST /api/reports/{designId}/wizardReport/generate Generate Wizard Report
  42. POST /api/plans/{planId}/designs/all Create designs one for each supported template
  43. POST /api/jobs/designs/{designId}/setWarningSuppression Configure design warning suppression
  44. POST /api/jobs/designs/{designId}/runEnhancedDesign Run Enhanced Design
  45. POST /api/jobs/designs/{designId}/clearWarningSuppression Clear all design warning suppression
  46. POST /api/designs/{designId}/upgradeToOtnIntegrated Upgrade Current Design To OTN Integrated
  47. POST /api/designs/{designId}/trails/freeze Configure freeze state
  48. POST /api/designs/{designId}/slots/{slotId}/pluggables Create Pluggable
  49. POST /api/designs/{designId}/routeOverConstraint Create RouteOverConstraint
  50. POST /api/designs/{designId}/rollback Rollback branch to a revision
  51. POST /api/designs/{designId}/nodes/insertNode Insert a Node in the selected segment
  52. POST /api/designs/{designId}/nes/{neId}/reservedShelves Reserve an OTN shelf number
  53. GET /api/designs/{designId}/nes/{neId}/alienShelves Retrieve Alien Shelves associated to Network Element
  54. POST /api/designs/{designId}/nes/{neId}/alienShelves Create Alien Shelf
  55. POST /api/designs/{designId}/nes/{neId}/addOmdclPortGroup Add new OMDCL port group for Network Element
  56. GET /api/designs/{designId}/designPreferences Retrieve design Preferences For a Design
  57. POST /api/designs/{designId}/designPreferences Save Design Preferences
  58. POST /api/designs/{designId}/createLineProtection Create OMSP/OLP protection Path
  59. POST /api/designs/{designId}/correctiveActions/autoCorrect Attempt to perform auto correction of design errors
  60. POST /api/designs/{designId}/colorProfile Create Color Profile
  61. POST /api/designs/{designId}/branch Create a new design branch
  62. POST /api/designs/{designId}/assignOrRemoveColorProfile Assign or Remove Color Profile
  63. POST /api/catalogueManagement/uploadCatalogue Upload Catalogue Management
  64. POST /api/catalogueManagement/updateCatalogue Update Catalogue Management
  65. POST /api/catalogueManagement/resetCatalogue Reset Catalogue Management
  66. GET /api/OTUplinkPreferenceTemplate Get OT/Uplink Preferences by Id
  67. POST /api/OTUplinkPreferenceTemplate Create OT/Uplink Preference
  68. GET /api/{designId}/designActivityLogsAsExcel Download Design Specific Activity Log as an Excel
  69. GET /api/users/usersCountByGrp Retrieve users count by user group.
  70. GET /api/users/userSessionInfo Retrieve the user session details for react screen.
  71. GET /api/users/meReact Retrieve the current user details for react screen.
  72. GET /api/users/all/paged Retrieve paged users list.
  73. GET /api/routing/designs/{designId}/preSearch/{demandId}/info To pre populate data before search.
  74. GET /api/routing/designs/{designId}/getRoutesClassic/{isFirstLayer} Retrieve the selected set of routes.
  75. GET /api/routing/designs/{designId}/getRoutesCascaded/{demandId} Get OT port details for cascaded trail
  76. GET /api/routing/designs/{designId}/getDetailsClassic/{routeId} Fetch detailed information for a selected Route.
  77. GET /api/routing/designs/{designId}/editClassic/{demandId} Edit an existing routed trail request.
  78. GET /api/recentActivities Retrieve Recent Activity for Designs.
  79. GET /api/recentActivities/count Retrieve Count of Recent Activity for Designs.
  80. GET /api/react/about WaveSuite Planner React release information.
  81. GET /api/processes/me Retrieve all WaveSuite Planner Process used by me
  82. GET /api/plans/{planId}/designFamilies Retrieve Design Families for a Plan
  83. GET /api/plans/allCheckedInDesigns Get All Checked-In Designs under each plan.
  84. GET /api/plannerList/{userGroup} Planner List
  85. GET /api/planOverview Plan Overview
  86. GET /api/plan/{planId}/designs Retrieve Designs info for a plan
  87. GET /api/plan/{id} Retrieve Plan based on Id
  88. GET /api/jobs Retrieve all jobs
  89. GET /api/jobsCountByStatus Retrieve jobs count by its status
  90. GET /api/jobs/{id} Retrieve all jobs
  91. GET /api/jobExecutionsStep/{id} Retrieve a job execution steps
  92. GET /api/history/design/{designId}/page/{pageNumber} Retrieve Git history for a design branch
  93. GET /api/history/design/{designId}/page/count Retrieve total count of commits in a given design branch
  94. GET /api/history/design/mergebase/{designId1}/{designId2} Retrieve Git merge base (common ancestor) for two branches within a design family
  95. GET /api/excel/users Download users as an Excel.
  96. GET /api/designs/{primDesignId}/{secDesignId}/l0 Export and Compare L0 Report
  97. GET /api/designs/{designId}/trails/{trailId}/layerview Export Layerview Report
  98. GET /api/designs/{designId}/trails/fullCplusLupgradeCheck Check for upgrade lines
  99. GET /api/designs/{designId}/trails/cMinusLupgradeCheck Check for upgrade lines to C minus L
  100. GET /api/designs/{designId}/slots/{slotId}/ports/{portId}/pluggableTypes Get Port List And Apn
  101. GET /api/designs/{designId}/slots/{slotId}/portTypes Get Port List And Pluggable
  102. GET /api/designs/{designId}/slots/{slotId}/packTypes Get Pack List And Apn
  103. GET /api/designs/{designId}/reports/visioSchematicView Export Schematic Report
  104. GET /api/designs/{designId}/publishHistory Get publish history for design branch
  105. GET /api/designs/{designId}/openNraDesign/{nraId} Get WSP design with NRA data
  106. GET /api/designs/{designId}/nodes/{nodeId}/blockConns Retrieve Node block connectivity
  107. GET /api/designs/{designId}/nodes/insertNode/{spanId} Retrieve valid Sites For InsertNode
  108. GET /api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/section/{sectionId}/adbnoise Get AdbNoise Details By PackId and SectionId
  109. GET /api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/adbnoise Get AdbNoise Details By PackId
  110. GET /api/designs/{designId}/node/{nodeId}/adBlocks/{blockInstance}/trails Retrieve list of trails connected to AD block
  111. GET /api/designs/{designId}/nes/{neId}/getOmdclPortGroup Retrieve the OMDCL port group associated to Network Element
  112. GET /api/designs/{designId}/map/nes
  113. GET /api/designs/{designId}/lineProtectionConfirm Get Line protections dialog message
  114. GET /api/designs/{designId}/filterColoring Filter Coloring Failure Scope
  115. GET /api/designs/{designId}/exportWspDesignRevision Export WSP design for a specific revision
  116. GET /api/designs/{designId}/designPermission Fetch the users authorized to access the design
  117. GET /api/designs/{designId}/designParams Retrieve select design params
  118. GET /api/designs/{designId}/designFamily Retrieve Design Family for a Design
  119. GET /api/designs/{designId}/demands/availableDemandForProvisioning Demands Provisioning
  120. GET /api/designs/{designId}/colorProfiles Retrieve Color Profiles associated to Design
  121. GET /api/designs/{designId}/btmTblLineProtectionData Retrieve line protections associated to Design
  122. GET /api/designFamily/{designFamilyId}/plan Retrieve Plan for a Design Family
  123. GET /api/designFamily/{designFamilyId}/branches Retrieve Designs for a Design Family
  124. GET /api/design/{designId} Retrieve design info on basis of designId
  125. GET /api/allDesign Retrieve All available Designs
  126. GET /api/activityLog/{logId} Retrieve activity log parameters for specified log id
  127. GET /api/activePlans Retrieve all active Plans
  128. GET /api/activeDesigns Retrieve All Active Designs.
  129. GET /api/OTUplinkPreferences Get Default OT/Uplink Preference List/Available Preference List
  130. GET /api/OTUplinkPreferenceTemplates Get OT/Uplink Preference
  131. GET /api/OTUplinkPreferenceTemplateByDesign Get OT/Uplink Preference associated to design
  132. DELETE /api/designs/{designId}/slots/{slotId}/ports/{portId}/pluggables Delete Pluggable
  133. DELETE /api/designs/{designId}/nes/{id}/deleteOmdclPortGroup Remove unused OMDCL port group for Network Element
  134. DELETE /api/designs/{designId}/lineProtection Delete list of Line protections
  135. DELETE /api/designs/{designId}/alienShelves/{id} Delete Alien Shelf

What's Deleted⇑

  1. POST /api/templates/management/create Create Template
  2. POST /api/templates/create Create Template
  3. POST /api/routing/designs/{designId}/validateRoute Start the validation of the route modifications.
  4. POST /api/routing/designs/{designId}/stopSearch Stop the current active search for routes.
  5. POST /api/routing/designs/{designId}/startSearch Start the searching for routes.
  6. POST /api/routing/designs/{designId}/resetValidation Delete Validate Cache
  7. POST /api/routing/designs/{designId}/resetValidationClassic Delete Validate Cache for classic
  8. POST /api/routing/designs/{designId}/finish Invoke to Create the and set the selected route.
  9. POST /api/designs/{designId}/failureScopes/advanceSearch Advanced Search
  10. GET /api/routing/designs/{designId}/getRoutesClassic Retrieve the selected set of routes.
  11. GET /api/routing/designs/{designId}/getRoutes/{startingFrom}/{count}/{isWorking} Retrieve the selected set of routes.
  12. GET /api/routing/designs/{designId}/getRoute/{routeId} Retrieve Route by selected route id.
  13. GET /api/routing/designs/{designId}/getOTDetailsCascaded/{demandId} Get OT port details for cascaded trail
  14. GET /api/routing/designs/{designId}/getDetails/{routeId} Fetch detailed information for a selected Route.
  15. PUT /api/designs/{designId}/shelves/{id} Update Shelf
  16. GET /api/designs/{designId}/parameters Retrieve Design Params for a Design

What's Deprecated⇑

What's Changed⇑

  1. PUT /api/designs/{designId}/demands/{demandId}/verificationSetting

    • Response

      • Changed response : [200]//Demand successfully updated

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> object)

  2. POST /api/templates/management/design/{designId}/import Import templates in design

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  3. GET /api/templates/systemTemplates Retrieves the system defined templates

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  4. GET /api/templates/systemTemplates/{type} Retrieves system defined templates by type

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  5. GET /api/templates/management/design/{designId}/defaultTemplates Retrieve the default templates in design

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  6. GET /api/templates/entity/design/{designId}/type

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  7. GET /api/queuedoperations

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (string -> array)

  8. GET /api/designs/{designId}/trails/{trailId}

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (string -> object)

  9. GET /api/designs/{designId}/trails/{trailId}/routes Retrieve the RouteDto model based on the layer for a trail

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  10. GET /api/designs/{designId}/trails/{trailId}/routesHierarchy

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  11. GET /api/designs/{designId}/trails/{trailId}/routesHierarchyForTrail

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  12. GET /api/designs/{designId}/trails/{trailId}/routeDetailsDto Retrieve the route details as a RouteDetailObject to display the layer view of demand.

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> array)

  13. GET /api/designs/{designId}/trails/{trailId}/restorationRoutes Retrieve the restoration routes for a demand based on a GMPLS failure

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  14. GET /api/designs/{designId}/trails/{trailId}/failures

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Missing property: id (integer)

          Missing property: name (string)

          Missing property: description (string)

          Missing property: nfmtName (string)

  15. GET /api/designs/{designId}/slots/{slotId}/shelf/{shelfId}/getOtList

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (array -> object)

  16. GET /api/designs/{designId}/sconParams

    • Response

      • Changed response : [200]//OK

        • Schema

          Changed body: '*/*'
  17. GET /api/designs/{designId}/reports/gmpls

    • Parameters

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

    • Parameters

      • reportType in query
      • Delete reportFormat in query //Report Format
  19. GET /api/designs/{designId}/node/{nodeId}/block/{blockId}/schematicView/block Retrieves the data for node schematic panel

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (array -> object)

  20. GET /api/designs/{designId}/map/sites

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> array)

  21. GET /api/designs/{designId}/map/demands

    • Response

      • Changed response : [200]//Demands retrieved successfully

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  22. GET /api/designs/{designId}/map/demands/{demandId}

    • Response

      • Changed response : [200]//Demand retrieved successfully

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

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

    • Parameters

      • reportType in query
  24. GET /api/designs/{designId}/getNraDesigns

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Changed property type: (object -> array)

  25. GET /api/designs/{designId}/failureScenarios/{trailId}/impactedResources Retrieve all the impacted resources of a GMPLS failure for a demand

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> string)

  26. GET /api/designs/{designId}/designHistory

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (object -> array)

  27. GET /api/designs/verifyDesignData

    • Response

      • Changed response : [200]//Verify Design Data completed

        • Schema incompatible

          Changed body: 'application/json'

          Changed property type: (string -> array)

  28. GET /api/proxy Retrieve Proxy settings.

    • Response

      • Changed response : [200]//OK

        • Schema incompatible

          Changed body: '*/*'

          Missing property: id (string)

  29. PUT /api/proxy Update Proxy settings.