Api Change Log

Application Versions⇑

Changes between 23.7.0 to 25.6.0

What's New⇑

GET/api/wsNoc Retrieve All available WsNoc.
PUT/api/wsNoc Modify WsNoc
POST/api/wsNoc Create WsNoc
PUT/api/users/activate Activate/Deactivate User
PUT/api/templates/management/{id}/update Update template
PUT/api/processes/{wspAddress}/stop Stops a WaveSuite Planner processes
PUT/api/plans/{planId}/sharePlan Share the plan with the specified users.
GET/api/notes/{noteId} Fetch a Note
PUT/api/notes/{noteId} Update a existing Note
DELETE/api/notes/{noteId} Delete a existing Note
PUT/api/designs/{designId}/{mode}/updateDynamic3R Modifies the dynamic3R attribute of the regen
PUT/api/designs/{designId}/wizard/trails/{trailId} Update Trail using Design Wizard
PUT/api/designs/{designId}/wizard/sites/{siteId} Update Site from design wizard
PUT/api/designs/{designId}/wizard/services/{serviceId} Update Service using Design Wizard
PUT/api/designs/{designId}/wizard/segments/{segmentId} Update Segment from design wizard
PUT/api/designs/{designId}/updateOtsName updates the ots name
PUT/api/designs/{designId}/updateLineProtection Update Line Protection
PUT/api/designs/{designId}/unpublish Unpublish design revision
PUT/api/designs/{designId}/trails/verificationSetting Update Verification Setting for OMS
PUT/api/designs/{designId}/trails/upgradeLines Upgrade lines to IROADM32 on side A or B
PUT/api/designs/{designId}/trails/reverse1fDir Reverse DWDM-1F link direction
PUT/api/designs/{designId}/trails/fullCplusLupgrade upgrade lines to full C plus L
PUT/api/designs/{designId}/trails/cMinusLupgrade upgrade lines to C minus L
PUT/api/designs/{designId}/swapLineProtection Swap Line Protection
PUT/api/designs/{designId}/slots/{slotId} Update Pack
PUT/api/designs/{designId}/slots/{slotId}/powerConfig Update Power Configuration
PUT/api/designs/{designId}/slots/{slotId}/ports/{portId} Update Port
PUT/api/designs/{designId}/slots/{slotId}/ports/{portId}/lbo Update Lbo
PUT/api/designs/{designId}/slots/{slotId}/movePackGroup Move Pack list in PSS24X
PUT/api/designs/{designId}/slots/{slotId}/dcmShelfNumber Set Dcm Shelf Number
PUT/api/designs/{designId}/sites/{siteId}/mergeSpans Merge Spans
PUT/api/designs/{designId}/shelves/{shelfId} Update Shelf
PUT/api/designs/{designId}/shareDesign Share the design with the specified users.
PUT/api/designs/{designId}/setPSS16IIPowerFilterType Convert Pss16IINes AC DC variant
GET/api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} Get RouteOverConstraint by Id
PUT/api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} Update RouteOverConstraint
DELETE/api/designs/{designId}/routeOverConstraint/{routeOverConstraintId} Delete RouteOverConstraint
PUT/api/designs/{designId}/restoration1621Data Set 1621 restoration data
PUT/api/designs/{designId}/regenerators/freeze Configure freeze state
PUT/api/designs/{designId}/powerOffSet/update Update power offset in WDM link
PUT/api/designs/{designId}/powerOffSet/applyPolicy Retrieve the power offset after applying policy calculations to the channel type power offset table
PUT/api/designs/{designId}/nodes/{nodeId}/trail/{omsId}/togt Change ILA to GT
PUT/api/designs/{designId}/nodes/{nodeId}/ilawtocm Equip/UnEquip ILA with WTOCM
PUT/api/designs/{designId}/nodes/{nodeId}/ilashelftype Change shelfType in ILA
PUT/api/designs/{designId}/nodes/{nodeId}/ilaconversion ILA node conversion
PUT/api/designs/{designId}/nodes/{gtId}/trail/{omsId}/toila Change GT to ILA
PUT/api/designs/{designId}/nodes/upgrade/{nodeId} Upgrade Node
PUT/api/designs/{designId}/node/{nodeId}/lineBlocks/{blockInstance}/virtualOT Edit Line Block virtual OT
PUT/api/designs/{designId}/node/{nodeId}/editmeshconnections Edit Node Mesh Connections By NodeId
PUT/api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/section/{sectionId}/editadbnoise Edit AdbNoise Details By PackId and SectionId
PUT/api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/editadbnoise Edit AdbNoise Details By PackId
PUT/api/designs/{designId}/nes/{neId}/typeChangeOmdclPortGroup Update OMDCL port group - Change type,
PUT/api/designs/{designId}/nes/{neId}/swapOmdclPortGroup Update OMDCL port group - Swap
PUT/api/designs/{designId}/nes/{neId}/reassignOmdclPortGroup Update OMDCL port group - Reassign,
PUT/api/designs/{designId}/map/saveSitesLocation Update multiple sites co-ordinates
PUT/api/designs/{designId}/gts/{gtId}/update Update the Description and Loss of a given Glass Through
PUT/api/designs/{designId}/gts/{gtId}/gtDescription Update the Description of a given Glass Through
DELETE/api/designs/{designId}/failureScopes/{id} Delete Failure Scope
PUT/api/designs/{designId}/failureScopes/{id}/active Set Failure Scope as active
PUT/api/designs/{designId}/escalationDetail Update Escalation Details
PUT/api/designs/{designId}/designPermission/user Set User Roles for Design
DELETE/api/designs/{designId}/designPermission/user Remove User Roles for Design
PUT/api/designs/{designId}/demands/{demandId}/updateTC Update Topology Constraint for Demand
PUT/api/designs/{designId}/demands/{demandId}/createTC Create Topology Constraint for Demand Id
PUT/api/designs/{designId}/demands/{demandId}/copyRouteOverConstraint Copy Segment Route Over Constraint From OtnService
PUT/api/designs/{designId}/demands/verificationSetting Bulk Update Verification Setting for a Trail
PUT/api/designs/{designId}/demands/freeze Configure freeze state
GET/api/designs/{designId}/colorProfile/{colorProfileId} Retrieve Color Profiles associated to Design
PUT/api/designs/{designId}/colorProfile/{colorProfileId} Update Color Profile
DELETE/api/designs/{designId}/colorProfile/{colorProfileId} Delete Color Profile by Id
PUT/api/designs/{designId}/bundle Update equipment bundle
POST/api/designs/{designId}/bundle Create equipment bundle
GET/api/designs/{designId}/bomSettings Get BOM settings for design
PUT/api/designs/{designId}/bomSettings Update BOM settings for design
GET/api/designs/{designId}/alienShelves/{asId} Retrieve a given Alien Shelf
PUT/api/designs/{designId}/alienShelves/{asId} Move Alien Shelf to another position
PUT/api/designs/{designId}/SconPowerOffset Set PowerOffset.
PUT/api/designs/{designId}/SconPowerOffset/applyPolicy Get calculated values on Apply Policy For PowerOffSet.
PUT/api/designs/{designId}/SconFrequencyBucket Set Solution Context Frequency Bucket Data
PUT/api/designs/{designId}/OTUplinkPreferenceTemplate/{operation} To associate/dissociate OT/Uplink Preference
GET/api/designFamily/{id} Get design family based on id
PUT/api/designFamily/{id} Update design family name and description
PUT/api/OTUplinkPreferenceTemplate/{templateId} Update OT/Uplink Preference
DELETE/api/OTUplinkPreferenceTemplate/{templateId} delete OT/Uplink Preference
POST/api/upload/generateNdfFiles Generate network data file
POST/api/templates/management/{cloneId}/clone Clones the template
GET/api/systemPreference Get System Preference of sCRM configuration
POST/api/systemPreference Create System Preference of sCRM configuration
DELETE/api/systemPreference Delete System Preference of sCRM configuration
POST/api/routing/designs/{designId}/validateRouteClassic Validate selected route with user selected value.
POST/api/routing/designs/{designId}/validateNodeDetails Validate the selected node with the user selected change.
POST/api/routing/designs/{designId}/stopSearchClassic Stop the current active search for routes.
POST/api/routing/designs/{designId}/startSearchClassic Start the searching for routes.
POST/api/routing/designs/{designId}/resetValidationClassic/{routeId}/{demandId} Reset the temporary route modifications.
POST/api/routing/designs/{designId}/finishClassic Completes the Manual route creation process.
POST/api/routing/designs/{designId}/applyEditClassic Completes the route edit process.
POST/api/reports/{designId}/wizardReport/view Get Wizard Report file
POST/api/reports/{designId}/wizardReport/generate Generate Wizard Report
POST/api/report/{designId}/downloadDeltaBomFile Downloads the generated delta BOM
POST/api/report/v2/generateDeltaBOM Generate delta BOM between two or more designs
POST/api/report/generateDeltaBOM Generate delta BOM between two designs
GET/api/plans/ Retrieve all available Plans
POST/api/plans/ Create Plan
GET/api/notes Fetch Notes
POST/api/notes Add a new Note
POST/api/jobs/designs/{designId}/setWarningSuppression Configure design warning suppression
POST/api/jobs/designs/{designId}/runEnhancedDesign Run Enhanced Design
POST/api/jobs/designs/{designId}/omsPowerTuningEnhanced OMS Power Tuning for OTN-Integrated designs.
POST/api/jobs/designs/{designId}/omsDcmCalculation DCM Calculation.
POST/api/jobs/designs/{designId}/clearWarningSuppression Clear all design warning suppression
POST/api/importUsers Import Users from CSV
POST/api/designs/{designId}/{inputEntity}/highlightEntities Retrieves associated entities using entity ID
POST/api/designs/{designId}/wizard/trails Create Trail using Design Wizard
POST/api/designs/{designId}/wizard/sites Create Site from design wizard
POST/api/designs/{designId}/wizard/services Create Service using Design Wizard
POST/api/designs/{designId}/wizard/segments Create segment from design wizard
POST/api/designs/{designId}/upgradeToOtnIntegrated Upgrades Current Design To OTN Integrated
POST/api/designs/{designId}/updateNeReleaseFamilyForDesign/{isDesignApp} Updates NE Release family version
POST/api/designs/{designId}/trails/freeze Configure freeze state
POST/api/designs/{designId}/systems/advanceSearch System Advanced search
POST/api/designs/{designId}/srgs/advanceSearch SRG Advanced Search
POST/api/designs/{designId}/spans/advanceSearch Segment advanced search
POST/api/designs/{designId}/slots/{slotId}/pluggables Create Pluggable
DELETE/api/designs/{designId}/sites Delete Multiple Sites
POST/api/designs/{designId}/setDiscrepancyReportType Perform WS-NOC Classic Import Operation
POST/api/designs/{designId}/segments/mesh Create Segments in Mesh
POST/api/designs/{designId}/saveAsSconTemplate Create a new Solution Context Template from the solution context of ths design
POST/api/designs/{designId}/routeOverConstraint Create RouteOverConstraint
POST/api/designs/{designId}/rollback Rollback branch to a revision
POST/api/designs/{designId}/regenerators/advanceSearch Regenerators Advanced Search
POST/api/designs/{designId}/publish Publish design revision
POST/api/designs/{designId}/ots/advanceSearch OTS advanced search
POST/api/designs/{designId}/oms/advanceSearch OMS advanced search
POST/api/designs/{designId}/nraSearchEngineInit Initialising the NraSearchEngine
POST/api/designs/{designId}/nra/advanceSearch NRA Advanced Search
POST/api/designs/{designId}/nodes/removegroupisolation Remove Line Group Isolation
POST/api/designs/{designId}/nodes/insertNode Insert a Node in the selected segment
POST/api/designs/{designId}/nodes/applygroupisolation Apply Line Group Isolation
POST/api/designs/{designId}/node/{nodeId}/block/{blockId}/schematicView/editPack Edits the pack
POST/api/designs/{designId}/node/{nodeId}/block/{blockId}/schematicView/createPack Creates pack
POST/api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/schematicView/deletePack Deletes pack by ID.
POST/api/designs/{designId}/nes/{neId}/shelves Create Shelf
POST/api/designs/{designId}/nes/{neId}/reservedShelves Reserve a shelf number for a PSS-24X or PSS-12X or PSS-8X to be hosted in a Network ELement
GET/api/designs/{designId}/nes/{neId}/alienShelves Retrieve all Alien Shelves associated to a given Network Element
POST/api/designs/{designId}/nes/{neId}/alienShelves Create Alien Shelf associated to a Network Element
POST/api/designs/{designId}/nes/{neId}/addOmdclPortGroup Add new OMDCL port group for network element
POST/api/designs/{designId}/nes/{id}/emptyShelves Delete any empty Shelf not to be retained from the NetworkElement
POST/api/designs/{designId}/ne/{neId}/schematicView/monitoring/deleteConnection Deletes monitoring connection.
POST/api/designs/{designId}/ne/{neId}/schematicView/monitoring/createAction Create monitoring pack or connection
POST/api/designs/{designId}/ne/{neId}/pack/{packId}/schematicView/monitoring/editPack Edit monitoring pack.
POST/api/designs/{designId}/ne/{neId}/pack/{packId}/schematicView/monitoring/deletePack Deletes monitoring pack by ID.
POST/api/designs/{designId}/importSimplifiedTopologyAndTrafficExcel Import topology and traffic excel
POST/api/designs/{designId}/glassThrough/advanceSearch Glass-through advanced search
POST/api/designs/{designId}/failureSequences/advanceSearch Failure Sequence Advanced Search
POST/api/designs/{designId}/failureScopes Create Failure Scope
POST/api/designs/{designId}/failureScopes/advanceSearch Failure Scope advanced search
POST/api/designs/{designId}/escalateToErule Escalate to E-Rules Team
GET/api/designs/{designId}/designPreferences Retrieve design Preferences For a Design
POST/api/designs/{designId}/designPreferences Create and Save Design Preferences
POST/api/designs/{designId}/demandName Get demand name by ID
POST/api/designs/{designId}/createOmspLink Create OMSP Link
POST/api/designs/{designId}/createOmsLink Create OMS Trail
POST/api/designs/{designId}/createLineProtection Create OMSP/OLP protection Path
POST/api/designs/{designId}/correctiveActions/autoCorrect Attempt to correct current [run design/verification] errors in the design
POST/api/designs/{designId}/correctiveActions/acknowledge/{ids} Acknowledge/Delete Corrective action design entities
POST/api/designs/{designId}/convertDesign Convert to GMPLS/non-GMPLS Design
POST/api/designs/{designId}/commission/all Generate commissioning file with all systems
POST/api/designs/{designId}/colorProfile Create Color Profile
POST/api/designs/{designId}/coldCards Create Managed Card
POST/api/designs/{designId}/clientRateSpecific Export Client Rate Specific report
POST/api/designs/{designId}/clearDesignLogs Clear the design core logs
POST/api/designs/{designId}/classicUpload Perform WS-NOC Classic Upload Operation
POST/api/designs/{designId}/classicReloadUpload Perform WS-NOC Classic Reload Upload Operation
POST/api/designs/{designId}/classicImport Perform WS-NOC Classic Import Operation
POST/api/designs/{designId}/branch Create a new design branch
POST/api/designs/{designId}/assignOrRemoveColorProfile Assign or Remove Color Profile
POST/api/designs/{designId}/applyFix Resolve EPT and Network Discrepancy
POST/api/designs/{designId}/advanceSearch Trail/Service Advanced Search
POST/api/designs/newMerge Perform Synchronous Merge of 2 Designs (automation only)
POST/api/designs/mergeV2start Start the Asynchronous Merge of 2 Designs
POST/api/designs/mergeV2 Initialize Asynchronous Merge Request
POST/api/designs/mergeCreate Verify Merge Request And Create Merge Key
POST/api/designs/commission/delta Generate delta commissioning file
POST/api/catalogueManagement/uploadCatalogue Upload Catalogue Management
POST/api/catalogueManagement/updateCatalogue Update Catalogue Management
POST/api/catalogueManagement/resetCatalogue Reset Catalogue Management
GET/api/OTUplinkPreferenceTemplate Get OT/Uplink Preferences by Id
POST/api/OTUplinkPreferenceTemplate Create OT/Uplink Preference
POST/api/OTUplinkPreferenceTemplate/{id}/{action} Share/Unshare the OT/Uplink Preferences with specified users
GET/api/{tableName}/userActivityLogExcel Download User Activity Log as an Excel
GET/api/{designId}/{tableName}/designActivityLogsAsExcel Download Design Specific Activity Log as an Excel
GET/api/wsNoc/{name} Retrieve WsNoc by name.
DELETE/api/wsNoc/{name} Delete WsNoc
GET/api/wsNoc/{id}/test Test WsNoc Connection.
GET/api/wsNoc/counts Get WS-NOC instance counts.
GET/api/users/usersCountByGrp Retrieve users count by user group
GET/api/users/userSessionInfo Retrieve the user session details for react screen.
GET/api/users/permissions Get resources access permissions for the user.
GET/api/users/meReact Retrieve the current user details for react screen
GET/api/users/category Retrieve a set of user categories
GET/api/users/all/paged Retrieve paged users list.
GET/api/upload/getNdfFiles Show list of all NDF files
GET/api/upload/getConstraintType/srg Get the List of SRG for Network Data File Generation
GET/api/upload/getConstraintType/services Get the List of Services for Network Data File Generation
GET/api/upload/getConstraintType/phyConn Get the List of Physical Connections for Network Data File Generation
GET/api/upload/getConstraintType/infraConn Get the List of Infrastructure Connections for Network Data File Generation
GET/api/upload/checkFileStatus Check the File Status of the Network Data File
GET/api/templates/profileInfoForDesignWizard Solution context template or profile list For Design Wizard
GET/api/templates/management/scondesign/{name} Get designs linked to template
GET/api/templates/management/profileList Get ProfileList
GET/api/templates/management/getDesign/{name} Get designs linked to template
GET/api/scrm Retrieve all sCRM data with pagination and remote filter
GET/api/scrmDesigns Retrieve SCRM design details
GET/api/routing/designs/{designId}/preSearch/{demandId}/info Get the Pre-Search inputs.
GET/api/routing/designs/{designId}/getRoutesClassic/{isFirstLayer} Retrieve the selected set of routes.
GET/api/routing/designs/{designId}/getRoutesCascaded/{demandId} Get Route details for cascaded trail
GET/api/routing/designs/{designId}/getRouteClassic/{routeId} Retrieve single Route by selected route id.
GET/api/routing/designs/{designId}/getDetailsClassic/{routeId} Fetch detailed information for a selected Route.
GET/api/routing/designs/{designId}/editClassic/{demandId} Edit an existing routed trail request.
GET/api/routing/designs/{designId}/adBlockInputs/{nodeId} To get Add drop panel selection input data.
GET/api/recentActivities Retrieve Recent Activity for Designs.
GET/api/recentActivities/count Retrieve Count of Recent Activity for Designs.
GET/api/react/about WaveSuite Planner React release information.
GET/api/queuedoperations/react Retrieve Queued Operations
GET/api/processes/me Retrieve all WaveSuite Planner Process used by me
GET/api/processMonitor/processInfo Get all process status
GET/api/processMonitor/designProcessorList Get WS-P design processor list
GET/api/processMonitor/activeMQInterrupted Checks if ActiveMQ has been interrupted
GET/api/plans/{planId}/users Retrieve users who are allowed to access the plan with permission other than READ
GET/api/plans/{planId}/planPermission Fetch the users authorized to access the plan
GET/api/plans/{planId}/designFamilies Retrieve Design Families for a Plan
GET/api/plans/allCheckedInDesigns Get all Checked-In Designs
GET/api/plannerList/{userGroup} Planner information list by user group
GET/api/plan Retrieve plan ID based on plan name
GET/api/planOverview Plan Overview by user name
GET/api/plan/{planId}/designs Retrieve Designs info for a plan
GET/api/plan/{id} Get plan by plan id
GET/api/log/zip/trace Collect Logs & Diagnostic Data
GET/api/jobs Retrieve all jobs
GET/api/jobsCountByStatus Retrieve jobs count by its status and user name
GET/api/jobs/{id} Retrieve job by job id
GET/api/jobExecutionsStep/{id} Retrieve job execution steps
GET/api/jobExecutions/paged Retrieve Paged Jobs list
GET/api/history/{designFamilyId}/mergebase Retrieve Git merge base (common ancestor) info for all branches within a design family
GET/api/history/design/{designId}/page/{pageNumber} Retrieve Git history for a design branch
GET/api/history/design/{designId}/page/count Retrieve total count of commits in a given design branch
GET/api/excel/users Download users as an Excel.
GET/api/engineUsageDetails Fetch detailed engine usage information for the user
GET/api/engineUsage/count/me Retrieve Engine count for the user
GET/api/designs Retrieve All available Designs.
GET/api/designs/{primDesignId}/{secDesignId}/l0 Exports and Compare L0 Report
GET/api/designs/{designId}/{regenId}/otProfiles Retrieving the OT profile list
GET/api/designs/{designId}/{inputEntity}/{inputEntityId}/getAssociatedEntities/{outputEntity} Retrieves list of entities using associated ID
GET/api/designs/{designId}/wsp/map/sites Retrieve Sites associated to Design For WSP Map
GET/api/designs/{designId}/trails/{trailId}/layerview Export layer view report
GET/api/designs/{designId}/trails/fullCplusLupgradeCheck Check for upgrade lines
GET/api/designs/{designId}/trails/cMinusLupgradeCheck Check for upgrade lines to C minus L
GET/api/designs/{designId}/trailServiceListRestored/{id} Retrieve Impacted List of Restored TrailServices by FailureScenario ID and Design ID
GET/api/designs/{designId}/trailServiceListNonRestored/{id} Retrieve Impacted List of Non-Restored TrailServices by FailureScenario ID and Design ID
GET/api/designs/{designId}/trailServiceListImpacted Retrieve Impacted List of TrailServices
GET/api/designs/{designId}/trailServiceListByIdList/{id} Retrieve List Trails/Service Details associated with Design and list of Service/Trails ids, and impacted by Failure Scenario
GET/api/designs/{designId}/slots/{slotId}/shelf/{shelfId}/getOtList The getOtList retrieves the first list of possible attributes that can be used to create a managed card
GET/api/designs/{designId}/slots/{slotId}/powerConfigValues Get Power Configuration Values
GET/api/designs/{designId}/slots/{slotId}/ports/{portId}/pluggableTypes Get Port List And Apn
GET/api/designs/{designId}/slots/{slotId}/ports/{portId}/lboValues Get Lbo values
GET/api/designs/{designId}/slots/{slotId}/portTypes Get Port List And Pluggable
GET/api/designs/{designId}/slots/{slotId}/packTypes Get Pack List And Apn
GET/api/designs/{designId}/slots/{slotId}/dcmShelfNumberValues Get Dcm Shelf Numbers
GET/api/designs/{designId}/slots/{slotId}/adjacency Get Pack list with adjacency constraint
GET/api/designs/{designId}/sites/address/offlineGeoCoding Retrieve Site Address based on Latitude and Longitude
GET/api/designs/{designId}/sites/address/offlineGeoCoding/forwardGeoCode Retrieve Latitude and Longitude of Site
GET/api/designs/{designId}/site/{siteName} Get site ID by name
GET/api/designs/{designId}/segment/{segmentName} Get segment ID by name
GET/api/designs/{designId}/reports/visioSchematicView Export Schematic view Report
GET/api/designs/{designId}/publishHistory Get publish history for design branch
GET/api/designs/{designId}/publishHistory/react Get publish history for design branch
GET/api/designs/{designId}/powerOffSet/Gnp Retrieve the power offset value from GNP
GET/api/designs/{designId}/powerOffSet/Default Retrieves the default power offset data
GET/api/designs/{designId}/openNraDesign Get WSP design with NRA data
GET/api/designs/{designId}/openNraDesign/{nraId} Get WSP design with NRA data
GET/api/designs/{designId}/offlineGeocoding Check if offline geocoding is enabled
GET/api/designs/{designId}/och/{ochId} Retrieves OCH by ID
DELETE/api/designs/{designId}/nodes Delete Nodes
GET/api/designs/{designId}/nodes/{nodeId}/blockConns Retrieve Node block connectivity
GET/api/designs/{designId}/node/{nodeId}/meshconnections Retrieve Node Mesh Connections
GET/api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/section/{sectionId}/adbnoise Get AdbNoise Details By PackId and SectionId
GET/api/designs/{designId}/node/{nodeId}/block/{blockId}/pack/{packId}/adbnoise Get AdbNoise Details By PackId
GET/api/designs/{designId}/node/{nodeId}/adBlocks/{blockType}/options Retrieve additional options for MLFSB AD blocks
GET/api/designs/{designId}/node/{nodeId}/adBlocks/{blockInstance}/trails Retrieve list of trails connected to AD block
GET/api/designs/{designId}/nes/{neId}/shelfTypes Retrieve the Shelf Types
GET/api/designs/{designId}/nes/{neId}/shelfNumbers Retrieve the Shelf Number
GET/api/designs/{designId}/nes/{neId}/getOmdclPortGroup Retrieve the OMDCL port group
GET/api/designs/{designId}/nes/{id}/matrixInstanceSet Get the DTO of the MatrixInstances within a Network Element
GET/api/designs/{designId}/ne/{neId}/schematicView/monitoring Retrieves the data for NE monitoring panel
GET/api/designs/{designId}/map/otottrails Retrieve OTOT Trails
GET/api/designs/{designId}/map/nes Get network elements for map
GET/api/designs/{designId}/map/links Retrieve all Links associated to the provided design
GET/api/designs/{designId}/map/demands/{demandId} To retrieve a Demand
GET/api/designs/{designId}/gts/{id}/gtDescription Retrieve the Description of Glass Through
GET/api/designs/{designId}/getPSS16IIPowerFilterType Get getPSS16IIPowerFilterType list of values
GET/api/designs/{designId}/getNraDesigns Get NRA designs related to given Design
GET/api/designs/{designId}/getNeReleaseFamilyForDesign/{isFromDesignApp} Gets the NE Release family version for Design
GET/api/designs/{designId}/getLatestNeRelease Retrieves latest NE Release family version for Design
GET/api/designs/{designId}/filterColoring Filter Coloring Failure Scope
GET/api/designs/{designId}/failureScenario Retrieve List Failure Scenario Details associated with Design and list of Trail/service ids
GET/api/designs/{designId}/failureScenarioListNonRestored Retrieve List Failure Scenario Details associated with Design impacting Non restorable Trails/Services
GET/api/designs/{designId}/exportWspDesignRevision Export WSP design for a specific revision
GET/api/designs/{designId}/exportSimplifiedTopologyAndTrafficExcel/{isFromPlanDashboard} Export topology and traffic to excel from plan dashboard
GET/api/designs/{designId}/errors/{layer} Retrieve Error list by type
GET/api/designs/{designId}/disjointnessParam Retrieving SCON Route Disjointness
GET/api/designs/{designId}/designSummary Get design summary.
GET/api/designs/{designId}/designPermission Retrieve access permissions for a design
GET/api/designs/{designId}/designParams Retrieving selected design information for given design
GET/api/designs/{designId}/designLogs Retrieve design core logs
GET/api/designs/{designId}/designFamily Retrieve Design Family for a Design
GET/api/designs/{designId}/{ntwLayer}/demandsData Retrieve all Demands associated to Design
GET/api/designs/{designId}/demands/{demandId}/getTC Topology Constraint by Demand Id
GET/api/designs/{designId}/demands/availableTrailsForProvisioning Demands Provisioning
GET/api/designs/{designId}/demands/availableDemandForProvisioning Demands Provisioning
GET/api/designs/{designId}/demand/{demandName} Get demand ID by name
GET/api/designs/{designId}/correctiveActions Retrieve all corrective actions for the design
GET/api/designs/{designId}/commission/published Export commissioning file of published design.
GET/api/designs/{designId}/colorProfiles Retrieve Color Profiles associated to Design
GET/api/designs/{designId}/bundles Retrieve all equipment bundles.
GET/api/designs/{designId}/btmTblLineProtectionData Retrieve line protections associated to Design
GET/api/designs/{designId}/btmTblJobData Retrieve all jobs associated to the design
GET/api/designs/{designId}/SconPowerOffset/otlist/{channelType} Get Ot List For Channel Type of power offset.
GET/api/designs/{designId}/SconPowerOffset/currentSetting Get current PowerOffset data.
GET/api/designs/{designId}/SconFrequencyBucket/{resetDefaultPlan} Get Solution Context Frequency Bucket Default Data
GET/api/designs/{designId}/SconFrequencyBucket/currentData Get Solution Context Frequency Bucket Current Data
GET/api/designs/{designId}/SconFrequencyBucket/convert Get Solution Context Frequency Bucket Convert Data
GET/api/designs/{designId}/SconFrequencyBucket/clear Get Solution Context Frequency Bucket Clear Data
GET/api/designs/merge/v2/poll Retrieve the Latest Status Of The Merge Operation
GET/api/designs/merge/v2/plan/{id} Get Design Data for a Given Plan
GET/api/designs/merge/v2/design/{id} Get Merge V2 Design Information
GET/api/designs/merge/v2/config/defaults Get Merge Default Options
GET/api/designs/merge/v2/completionReport Download Merge Completion Report
GET/api/design Retrieve design ID based on plan name and design name
GET/api/designFamily/{designFamilyId}/plan Retrieve Plan for a Design Family
GET/api/designFamily/{designFamilyId}/branches Retrieve Designs for a Design Family
GET/api/design/{designId} Retrieve design info on basis of designId
GET/api/certificateInfo WaveSuite Planner certificate information.
GET/api/catalogueManagement/catalog Retrieve all catalogue items
GET/api/allDesign Fetch all designs with metadata
GET/api/activityLog/{logId} Retrieve list of activity log parameters for a given activity log record
GET/api/activePlans Retrieve all active plans
GET/api/activeDesigns Retrieve All Active Designs.
GET/api/OTUplinkPreferences Get available Default OT/Uplink preferences list.
GET/api/OTUplinkPreferenceTemplates Get created OT/Uplink Preferences
GET/api/OTUplinkPreferenceTemplateByDesign Get OT/Uplink Preference associated to design
GET/api/OTUplinkPreferenceTemplate/{templateId}/getUsers Retrieve the user names for shared OT/Uplink Preferences
GET/api/OTUplinkPreferenceTemplate/folders Retrieve All OT/Uplink Preference folders
DELETE/api/plans/{planId}/planPermission/user Remove User Access for Plan
DELETE/api/designs/{designId}/slots/{slotId}/ports/{portId}/pluggables Delete Pluggable
DELETE/api/designs/{designId}/slots/{slotId}/coldCards Delete Managed Card
DELETE/api/designs/{designId}/shelves/{id} Delete Shelf
DELETE/api/designs/{designId}/removeAllRestoration Remove all restorations
DELETE/api/designs/{designId}/nes/{id}/deleteOmdclPortGroup Remove unused OMDCL port group
DELETE/api/designs/{designId}/multiplesegments Delete multiple segments
DELETE/api/designs/{designId}/lineProtection Delete list of Line protections
DELETE/api/designs/{designId}/demands/{demandId}/deleteTC Delete Topology Constraint for Demand Id
DELETE/api/designs/{designId}/demands/deleteBulkTC Delete Topology Constraint for Demands in list
DELETE/api/designs/{designId}/bundle/{bundleId} Delete equipment bundle
DELETE/api/designs/{designId}/alienShelves/{id} Delete an Alien Shelf

What's Deleted⇑

PUT~~/api/templates/management/update/{id}~~ Update Template
PUT~~/api/processes/{processId}/stop~~ Stop a WaveSuite Planner Process
PUT~~/api/geocodingData~~ update geocoding data
POST~~/api/geocodingData~~ save geocoding data
DELETE~~/api/geocodingData~~ deactivate geocoding data
POST~~/api/templates/management/clone/{cloneId}~~ Clone Template
POST~~/api/templates/create~~ Create Template
POST~~/api/routing/designs/{designId}/validateRoute~~ Start the validation of the route modifications.
POST~~/api/routing/designs/{designId}/stopSearch~~ Stop the current active search for routes.
POST~~/api/routing/designs/{designId}/startSearch~~ Start the searching for routes.
POST~~/api/routing/designs/{designId}/resetValidation~~ Delete Validate Cache
POST~~/api/routing/designs/{designId}/finish~~ Invoke to Create the and set the selected route.
POST~~/api/designs/{designId}/updateNeReleaseFamilyForDesign~~ Update NE Release family version for Design
POST~~/api/designs/merge~~ Merge two designs
POST~~/api/designs/merge/write~~ Write/Get the merged design
POST~~/api/designs/merge/verify~~ Verify design files to be merged
POST~~/api/designs/merge/update~~ Fix merge issue reported in Merge Tree Node
POST~~/api/designs/merge/tree~~ Get merge data from merge containment tree
POST~~/api/designs/merge/report~~ Export Merge Report
POST~~/api/designs/merge/close~~ Release resources for merge operation
GET~~/api/verifyMergeDesignFiles~~ Verify design files to be merged
GET~~/api/routing/designs/{designId}/getRoutes/{startingFrom}/{count}/{isWorking}~~ Retrieve the selected set of routes.
GET~~/api/routing/designs/{designId}/getRoute/{routeId}~~ Retrieve Route by selected route id.
GET~~/api/routing/designs/{designId}/getDetails/{routeId}~~ Fetch detailed information for a selected Route.
GET~~/api/retrieve/geocodingData~~ retrieve all registered geocoding data
GET~~/api/licenseInput~~ License Information Parameters
GET~~/api/designs/{designId}/sites/{siteId}/compositeNodes~~ null
GET~~/api/designs/{designId}/sites/default~~ Default Site
GET~~/api/designs/{designId}/site/{siteId}/networkelementnode~~ Retrieve Node settings from Site for creation
GET~~/api/designs/{designId}/opticalFibers/opticalFiberData~~ Retrieve Optical Fiber Data associated to Design
GET~~/api/designs/{designId}/networkelementnode/{nodeId}~~ Retrieve Node settings for Node edit
GET~~/api/designs/{designId}/getNeReleaseFamilyForDesign~~ Get NE Release family version for Design
GET~~/api/designs/{designId}/compositeNodes~~ null
GET~~/api/designs/{designId}/btmTblCompositeNodes~~ null
GET~~/api/designs/verifyDesignData~~ Verify Design Data
GET~~/api/btmTblJobData~~ Retrieve all jobs
GET~~/api/designs/{designId}/parameters~~ Retrieve Design Params for a Design
POST~~/api/license~~ Save License

What's Deprecated⇑

DELETE~~/api/jobs/plans/{id}~~ Delete Plan

What's Changed⇑

PUT/api/processes/stop Stops all WaveSuite Planner processes
- Response
  - Changed response : [200]//All processes terminated successfully
GET/api/designs/{designId}/users
- Parameters
  - designId in path
- Response
  - Changed response : [200]//All users with access permission for the design
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
PUT/api/designs/{designId}/users Set user roles for design.
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//Access permissions assigned successfully
GET/api/designs/{designId}/trails/{trailId}/omsEquipment Retrieve OMS equipment data for the provided OMS trail and design.
- Parameters
  - designId in path
  - trailId in path
  - dir in query
- Response
  - Changed response : [200]//OMS equipment data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
PUT/api/designs/{designId}/trails/{trailId}/omsEquipment Update OMS equipment data for the provided OMS trail and design.
- Parameters
  - designId in path
  - trailId in path
  - dir in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//OMS equipment data updated successfully
PUT/api/designs/{designId}/shelves/packPlacement Updates Pack Placement
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//Pack Placement updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
PUT/api/designs/{designId}/share Share the design with the specified user.
- Parameters
  - designId in path
  - username in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [204]//Design shared successfully
PUT/api/designs/{designId}/parameters Update design SCON params for given design
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [204]//SCON parameter data modification successful
GET/api/designs/{designId}/description Get long design description
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Long design description retrieved successfully
    - Schema incompatible
      Changed body: 'text/plain'
      Changed property type: (string -> object)
PUT/api/designs/{designId}/description
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (string -> object)
- Response
  - Changed response : [200]//Design description updated successfully
    - Schema incompatible
      Changed body: 'text/plain'
      Changed property type: (string -> object)
PUT/api/designs/{designId}/demands/{demandId}/verificationSetting
- Parameters
  - designId in path
  - demandId in path
  - verificationSetting in query
- Response
  - Changed response : [200]//Demand successfully updated
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
POST/api/templates/management/design/{designId}/import Import templates in design
- Parameters
  - designId in path
  - action in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//Templates are imported successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/routing/designs/{designId}/deleteCache Delete Route Cache from memory.
- Parameters
  - designId in path
- Response
  - Changed response : [200]//The route cache is cleared successfully.
GET/api/roles/{roleName}/permissions Retrieve all permission associated to a role
- Parameters
  - roleName in path
- Response
  - Changed response : [200]//Permissions retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
POST/api/roles/{roleName}/permissions Add a permission to a role.
- Parameters
  - roleName in path
  - permissionName in query
- Response
  - Changed response : [204]//Permission added successfully
DELETE/api/roles/{roleName}/permissions Remove a permission from a role.
- Parameters
  - roleName in path
  - permissionName in query
- Response
  - Changed response : [204]//Permission removed successfully
POST/api/restore
- Parameters
  - backupFilePath in query
- Response
  - Changed response : [200]//The restore was performed successfully.
POST/api/jobs/designs/{designId}/reserveDesign Reserves the design
- Parameters
  - designId in path
  - sessionId in query
- Response
  - Changed response : [204]//Design reserved successfully
POST/api/jobs/designs/{designId}/releaseDesign Releases the design
- Parameters
  - designId in path
  - sessionId in query
- Response
  - Changed response : [204]//Design released successfully
POST/api/designs/{designId}/system/oms/potential/validate OMS trails potential validity
- Parameters
  - Add isCreateSystem in query//Unique id of the design. designId can be obtained from design name using 'id' field from REST response '/api/allDesign/?name={Design_Name}
  - Add pageable in query
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//OMS validated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
POST/api/designs/{designId}/setOperationalStateToReady Sets the design state to ready
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Operational state successfully updated to 'Ready'
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (boolean -> object)
POST/api/backup
- Response
  - Changed response : [200]//The backup was generated successfully.
POST/api/backup/enableAutoBackup Enable/Disable auto-backup
- Parameters
  - enable in query
- Response
  - Changed response : [200]//Auto-backup enabled/disabled successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (boolean -> object)
GET/api/users/authenticated Retrieve the usernames of currently authenticated users.
- Response
  - Changed response : [200]//List of usernamens of authenticated users
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/users/all Retrieve all users.
- Response
  - Changed response : [200]//List of all users retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/{templateId}/getUsers Retrieves user names for shared templates
- Parameters
  - templateId in path
- Response
  - Changed response : [200]//Usernames associated to shared template retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/type/{templateType}
- Parameters
  - templateType in path
- Response
  - Changed response : [200]//Template list retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/systemTemplates Retrieves the system defined templates
- Response
  - Changed response : [200]//System Defined templates retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/systemTemplates/{type} Retrieves system defined templates by type
- Parameters
  - type in path
- Response
  - Changed response : [200]//System defined templates by Type are retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/profileInfoForDesignCreation Solution context template or profile list
- Parameters
  - Add isOtn in query//Unique isOTN Design of the template
  - Add isGMPLS in query//Unique isGMPLS Design of the template
- Response
  - Changed response : [200]//Retrieves the List of Profiles
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/management/{templateId}/getUsers Retrieve the user names for unsharing templates
- Parameters
  - templateId in path
- Response
  - Changed response : [200]//Usernames are retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/management/type
- Parameters
  - templateType in query
- Response
  - Changed response : [200]//Template based on Type successfully retrieved
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/management/treeview Retrieves the template map
- Response
  - Changed response : [200]//Templates are retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/management/design/{designId}
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Templates associated to design retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/management/design/{designId}/forImports Retrieve the templates available for import
- Parameters
  - designId in path
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Templates available for Imports are successfully retrieved
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/templates/management/design/{designId}/defaultTemplates Retrieve the default templates in design
- Parameters
  - designId in path
  - templateType in query
- Response
  - Changed response : [200]//Default Template for the design successfully retrieved
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/entity/design/{designId}/type
- Parameters
  - designId in path
  - templateType in query
- Response
  - Changed response : [200]//Template associated to Design by Type retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/reports/ept/comm Exports the commissioning file
- Parameters
  - fileName in query
- Response
  - Changed response : [200]//Commissioning file downloaded successfully
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> object)
GET/api/queuedoperations
- Response
  - Changed response : [200]//Queued operations retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (string -> object)
GET/api/processes Retrieves all WaveSuite Planner process
- Response
  - Changed response : [200]//Retrieved processes successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/permissions Retrieve all permission authorities.
- Parameters
  - genericOnly in query
- Response
  - Changed response : [200]//Permission details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/jobExecutions
- Parameters
  - name in query
  - start in query
  - count in query
- Response
  - Changed response : [200]//Jobs retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/jobExecutions/running
- Parameters
  - name in query
- Response
  - Changed response : [200]//Jobs retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/fiberConfigs Retrieve fiber configuration
- Response
  - Changed response : [200]//Fiber configuration retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/uploadLog Retrieve Synchronization Log Data as a list of log records
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Synchronization Log data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/trails/{trailId}
- Parameters
  - designId in path
  - trailId in path
- Response
  - Changed response : [200]//Retrieved trail successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (string -> object)
DELETE/api/designs/{designId}/trails/{trailId}
- Parameters
  - designId in path
  - trailId in path
- Response
  - Changed response : [204]//Oms trail deleted successfully
GET/api/designs/{designId}/trails/{trailId}/routeDetailsDto Retrieve the list of route details as a RouteDetailObject to display the layer view of demand.
- Parameters
  - Add forClassicMR in query//Optional parameter. Specifies if classic manual routing is enabled. It is a boolean value.
  - designId in path
  - trailId in path
  - routeType in query
  - layer in query
- Response
  - Changed response : [200]//Demand data details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/{trailId}/failures Retrieve all the GMPLS failures for a demand
- Parameters
  - designId in path
  - trailId in path
- Response
  - Changed response : [200]//GMPLS failure data retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/omsChannelViewData Retrieve channel view data for the selected trails in the Design
- Parameters
  - designId in path
  - trailIds in query
  - isOmsLayer in query
- Response
  - Changed response : [200]//Channel view data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/templates/type/{templateType} Retrieving templates based on template type for a design
- Parameters
  - templateType in path
- Response
  - Changed response : [200]//Template data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/sconParams Retrieve SCON parameters for a design
- Parameters
  - designId in path
- Response
  - Changed response : [200]//SCON parameters retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/reports/visioEquipmentView Export Equipment view report
- Parameters
  - designId in path
  - siteId in query
  - phaseId in query
- Response
  - Changed response : [200]//Equipment view report exported successfully
    - New body: 'application/vnd.ms-excel'
    - Deleted body: 'image/svg+xml'
GET/api/designs/{designId}/reports/gmpls Export L0 GMPLS/NRA report
- Parameters
  - designId in path
  - reportType in query
  - scopeOrSequenceId in query
- Response
  - Changed response : [200]//Excel file successfully exported
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> object)
GET/api/designs/{designId}/reports/commission
- Parameters
  - designId in path
  - reportType in query
  - Delete~~reportFormat~~in query//Report Format
- Response
  - Changed response : [200]//Commissioning report exported successfully
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> object)
GET/api/designs/{designId}/reports/channelView
- Parameters
  - designId in path
  - entityList in query
  - layerType in query
  - showRestorations in query
  - Delete~~displayMode~~in query//Channel Display Mode
- Response
  - Changed response : [200]//Excel file successfully exported
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> object)
GET/api/designs/{designId}/node/{nodeId}/block/{blockId}/schematicView/block Retrieves the data for node schematic panel
- Parameters
  - designId in path
  - nodeId in path
  - blockId in path
- Response
  - Changed response : [200]//Retrieves the data for node schematic panel inside BlockSchematicPanelData structure
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/node/{nodeId}/adBlocks/options Retrieve AD Block Options
- Parameters
  - Add bandType in query//Band Type. Possible values are C, L. Default = C
  - Add blockIdentifier in query//Block Identifier: name of directional add drop block (FSX#)
  - designId in path
  - nodeId in path
- Response
  - Changed response : [200]//block options retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/designs/{designId}/nes/{neId}/shelves Retrieve shleves
- Parameters
  - designId in path
  - neId in path
- Response
  - Changed response : [200]//Shelves retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/nes/{id}/status Retrieve the NE status
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//NE status retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/designs/{designId}/map/trails
- Parameters
  - Add pageable in query//Pageable input criteria that follows the REST standard format for page size, page number and sorting.
  - designId in path
  - layer in query
  - showRoute in query
- Response
  - Changed response : [200]//Trail data retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/designs/{designId}/map/sites Retrieve all Sites associated to Design For Map
- Parameters
  - Add pageable in query//Pageable input criteria that follows the REST standard format for page size, page number and sorting.
  - designId in path
- Response
  - Changed response : [200]//Site data retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/map/demands Retrieve Demands
- Parameters
  - Add pageable in query//Pageable input criteria that follows the REST standard format for page size, page number and sorting.
  - designId in path
- Response
  - Changed response : [200]//Paged list of demands retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/l0 Export report requested
- Parameters
  - Add clientType in query//Client Type
  - Add otList in query//OT List
  - designId in path
  - reportType in query
  - entityIds in query
- Response
  - Changed response : [200]//Requested report exported successfully
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> object)
GET/api/designs/{designId}/isDesignLoaded Verify if a given design is currently loaded in memory
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Operation completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (boolean -> object)
GET/api/designs/{designId}/gts/{id}/glassThroughLoss Retrieve loss of Glass Through Node.
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//glass through loss read successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (number -> object)
GET/api/designs/{designId}/failureScenarios/{trailId}/impactedResources Retrieve all the impacted resources for a demand based on trail id and restoration id
- Parameters
  - designId in path
  - trailId in path
  - restorationId in query
- Response
  - Changed response : [200]//Impacted resources retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/exportWspDesign Export entire design data to a file.
- Parameters
  - designId in path
  - isWorkingDesign in query
- Response
  - New response : [400]//Bad Request
  - Changed response : [200]//Design exported successfully
GET/api/designs/{designId}/exportTrailToExcel Export the trails to excel
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Exported trails to excel successfully.
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> no schema)
GET/api/designs/{designId}/exportLogData Export Synchronization Log Data as an Excel file
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Synchronization Log data exported successfully
GET/api/designs/{designId}/exportEptDesign Export the design file only
- Parameters
  - designId in path
  - isWorkingDesign in query
- Response
  - New response : [400]//Bad Request
  - Changed response : [200]//Design exported successfully
GET/api/designs/{designId}/exportDesignToExcel/{isFromPlanDashboard} Export design to excel from plan dashboard
- Parameters
  - designId in path
  - isFromPlanDashboard in path
- Response
  - Changed response : [200]//Exported design to excel successfully
    - Schema incompatible
      Changed body: 'application/vnd.ms-excel'
      Changed property type: (string -> no schema)
GET/api/designs/{designId}/designHistory
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Design history details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/commission/logs Retrieves specified commissioning file
- Parameters
  - designId in path
  - comments in query
  - planName in query
  - designName in query
- Response
  - Changed response : [200]//Commissioning file found successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
DELETE/api/designs/{designId}/commission/logs
- Parameters
  - designId in path
  - path in query
- Response
  - Changed response : [200]//Commissioning file deleted successfully
GET/api/dashboards/currentUser Retrieve Dashboards associated with the current user
- Response
  - Changed response : [200]//List of dashboards retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/backup/isAutoBackupEnabled
- Response
  - Changed response : [200]//Retrieved if the auto-backup is enabled/disabled.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (boolean -> object)
GET/api/backup/files Retrieve backup files.
- Response
  - Changed response : [200]//Retrieved list of backup files.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
GET/api/availableEptEngineServices Return count of available EptEngine Services
- Response
  - Changed response : [200]//Data is returned successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (integer -> object)
DELETE/api/templates/management/{id}
- Parameters
  - id in path
- Response
  - Changed response : [204]//Template deleted successfully
DELETE/api/templates/management/folder Delete template folder
- Parameters
  - folder in query
- Response
  - Changed response : [204]//Template folder deleted successfully
DELETE/api/templates/folder
- Parameters
  - folder in query
- Response
  - Changed response : [204]//Template folder deleted successfully
DELETE/api/templates/entity/design/{designId}/{id} Deletes template in design
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [204]//The Template associated with the Design is successfully deleted
DELETE/api/jobs/plans/{id}
- Parameters
  - id in path
- Response
  - Changed response : [204]//Plan deleted successfully
DELETE/api/designs Delete Designs.
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Deleted response : [200]//Deleted Designs Successfully
  - Changed response : [204]//Deleted Designs Successfully
DELETE/api/designs/{designId}/nra/resultsById
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//Selected Resiliency Analyses deleted successfully
DELETE/api/designs/{designId}/nodes/{id}
- Parameters
  - designId in path
  - id in path
DELETE/api/designs/{designId}/failureSequence/{id}
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [204]//Deleted Failure Sequence successfully
DELETE/api/designs/{designId}/edges
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//edges deleted successfully
DELETE/api/designs/{designId}/demands/{demandId}/route Delete demand route
- Parameters
  - designId in path
  - demandId in path
- Response
  - Changed response : [204]//Demand route deleted successfully
DELETE/api/users
- Parameters
  - username in query
- Response
  - Changed response : [204]//user deleted successfully
GET/api/users Retrieve details for the provided user.
- Parameters
  - username in query
- Response
  - Changed response : [200]//user details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/users Update User
- Parameters
  - username in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//user updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/users
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//new user created successfully
    - New body: 'application/json'
    - Deleted body: '*/*'
PUT/api/users/password Update User password.
- Parameters
  - username in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Password successfully updated.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/templates/{id}
- Parameters
  - id in path
- Response
  - Changed response : [204]//Template deleted successfully
PUT/api/templates/{id}
- Parameters
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Template updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/templates/{id}/folder
- Parameters
  - id in path
  - folder in query
- Response
  - Changed response : [200]//Template moved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/templates/management/{id}/folder Move template folder
- Parameters
  - id in path
  - folder in query
- Response
  - Changed response : [200]//Template moved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/templates/management/design/{designId}/setAsDefault
- Parameters
  - designId in path
  - templateId in query
- Response
  - Changed response : [200]//Template successfully set as Default
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/tablePreferences/{id}
- Parameters
  - id in path
- Response
  - Changed response : [204]//Table preference deleted successfully
PUT/api/tablePreferences/{id}
- Parameters
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Table preference updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/proxy Retrieve Proxy settings.
- Response
  - Changed response : [200]//Proxy settings retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/proxy Update Proxy settings.
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Proxy settings updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/plans/{id}
- Parameters
  - id in path
- Response
  - Changed response : [204]//Plan deleted successfully
    - New body: '*/*'
GET/api/plans/{id}
- Parameters
  - id in path
- Response
  - Changed response : [200]//Plan based on Id is retrieved successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/plans/{id}
- Parameters
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Plan updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId} Delete selected design.
- Parameters
  - designId in path
- Response
  - Changed response : [204]//The design has been deleted.
    - New body: '*/*'
GET/api/designs/{designId} Retrieve design based on design Id.
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Design object is retrieved successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId} Update design name and description.
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//The design is updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/trails/{trailId}/wtocmUsage
- Parameters
  - designId in path
  - trailId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//WTOCM usage updated on OMS successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/trails/{trailId}/oms
- Parameters
  - designId in path
  - trailId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Oms trail data updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/systems/{systemId}
- Parameters
  - Add pageable in query
  - designId in path
  - systemId in path
- Request
  - Deleted body: 'application/json'
PUT/api/designs/{designId}/systems/{systemId} Edit the system
- Parameters
  - designId in path
  - systemId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//System updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/srgs/{id}
- Parameters
  - designId in path
  - id in path
GET/api/designs/{designId}/srgs/{id}
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//srg retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/srgs/{id}
- Parameters
  - designId in path
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//srg updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/sites/{siteId} Deletes site by ID
- Parameters
  - designId in path
  - siteId in path
GET/api/designs/{designId}/sites/{siteId} Retrieves site by ID
- Parameters
  - designId in path
  - siteId in path
- Response
  - Changed response : [200]//Site retrieved
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/sites/{siteId}
- Parameters
  - designId in path
  - siteId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Site updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/segments/{segmentId} Delete segment by id
- Parameters
  - designId in path
  - segmentId in path
- Response
  - Changed response : [204]//Segment deleted successfully.
GET/api/designs/{designId}/segments/{segmentId} Retrieves the segment by id
- Parameters
  - designId in path
  - segmentId in path
- Response
  - Changed response : [200]//Segment data retrieved successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/segments/{segmentId} Updates segment
- Parameters
  - designId in path
  - segmentId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Segment updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/regenerators/isUserCreated
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]// Frozen state updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/nodes/{nodeId}/swapline
- Parameters
  - designId in path
  - nodeId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//line number updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/nodes/{nodeId}/adBlocks/{blockInstance}
- Parameters
  - Add bandType in query//Band Type. Possible values are C, L, C with L, L with C
  - Add blockIdentifier in query//Block Identifier: name of directional add drop block (FSX#)
  - Add suppressWarning in query//Suppress Warning: set to true to bypass deletion warnings
  - designId in path
  - nodeId in path
  - blockInstance in path
- Response
  - New response : [304]//warning: block not deleted
  - Changed response : [204]//block deleted successfully
    - New body: 'application/json'
PUT/api/designs/{designId}/nodes/{nodeId}/adBlocks/{blockInstance}
- Parameters
  - designId in path
  - nodeId in path
  - blockInstance in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//block implemented successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/node/{nodeId}
- Parameters
  - designId in path
  - nodeId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//node edited successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/nes/{id} Delete a NetworkElement
- Parameters
  - designId in path
  - id in path
GET/api/designs/{designId}/nes/{id} Get the DTO of a Network Element
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//Dto of the network element retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/nes/{id} Update NE
- Parameters
  - designId in path
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//NE updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/map/sites/{siteId} Update the site co-ordinates
- Parameters
  - designId in path
  - siteId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Site updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/gts/{gtId}/gtLoss Update the loss of a given Glass-Through Node
- Parameters
  - designId in path
  - gtId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//glass through loss updated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/failureSequences/{id}
- Parameters
  - designId in path
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Failure Sequence updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/failureSequences/{id}/active Set active Failure Sequence
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//Failure Sequence set as active successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/failureScopes/{id}
- Parameters
  - designId in path
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Failure Scope update successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/demands/{demandId} Delete demand
- Parameters
  - designId in path
  - demandId in path
- Response
  - Changed response : [204]//Demand deleted successfully
    - New body: '*/*'
GET/api/designs/{designId}/demands/{demandId}
- Parameters
  - designId in path
  - demandId in path
- Response
  - Changed response : [200]//Demand retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/demands/{demandId}
- Parameters
  - designId in path
  - demandId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Demand successfully updated
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
PUT/api/designs/{designId}/blocks/{nodeId}/ilaBlockParams
- Parameters
  - designId in path
  - nodeId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//The node has been successfully implemented using the passed scenario
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
PUT/api/designs/{designId}/blocks/{blockId}/lineBlockParams
- Parameters
  - designId in path
  - blockId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//The line block has been successfully updated with the passed logical scenario
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/dashboards/{id} Delete dashboard
- Parameters
  - id in path
- Response
  - Changed response : [204]//Dashboard deleted successfully
GET/api/dashboards/{id} Retrieve dashboard based on Id
- Parameters
  - id in path
- Response
  - Changed response : [200]//Dashboard retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
PUT/api/dashboards/{id} Updates the dashboard
- Parameters
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Dashboard details updated successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/{id}/userNames Share SCON template to WaveSuite Planner users
- Parameters
  - id in path
  - action in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//SCON templated shared successfully to WaveSuite Planner users
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/management/{id}/userNames Share the template with WaveSuite Planner users
- Parameters
  - id in path
  - action in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [200]//The template is shared/unshared to the users
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/management/design/{designId}/export
- Parameters
  - designId in path
  - templateId in query
- Response
  - Changed response : [201]//Template exported successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/management/create Creates template
- Parameters
  - Add requestId in query//Optional request ID, defaults to 0 if not provided
  - Delete~~bypassValidation~~in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Template created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/entity/design/{designId}/createTemplate Creates the template in design - Save as Template Operation
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [201]//Template successfully saved to the design
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/templates/clone/{cloneId}
- Parameters
  - cloneId in path
  - bypassValidation in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Template cloned successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/tablePreferences
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Table preference created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/roles Retrieve all role authorities.
- Parameters
  - genericOnly in query
- Response
  - Changed response : [200]//Role details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
POST/api/roles Create a new role.
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Role created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/plans
- Parameters
  - Add userName in query//Username for additional filtering, optional
  - Add range in header//Specifies range of items to fetch. Sample values are items=0-49, items=50-99. Default is items=0-ALL
- Response
  - Changed response : [200]//All the plans are retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
DELETE/api/plans
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//Plans deleted successfully
POST/api/plans
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Plan is created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/plans/{planId}/designs
- Parameters
  - planId in path
- Response
  - Changed response : [200]//All designs from a particular plan is retrieved.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/plans/{planId}/designs
- Parameters
  - planId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [201]//new design is successfully created
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/license
- Response
  - Changed response : [200]//License details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/upload
- Parameters
  - Add l0TrailsServices in query//L0 TrailsServices
  - Add l1TrailsServices in query//L1 TrailsServices
  - Add createLineDesign in query//Create Line design
  - Add autoFix in query//Auto Fix
  - planId in path
  - name in query
  - specificationName in query
  - referenceDesignIds in query
  - description in query
  - includeNotFound in query
  - lossMargin in query
  - Delete~~lineDesignOnly~~in query//Line Design Only
- Request
  - New body: 'multipart/form-data'
  - Deleted body: 'application/json'
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//WS-NOC Synchronization completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/importWspDesign Import .wsp design.
- Parameters
  - Add branchName in query//Branch Name
  - Add branchDescription in query//Branch Description
  - Add preserveFutureProjects in query//Preserve Future Projects (if any exist in design)
  - Add eventChannelForProgress in query//Event Channel For Progress
  - planId in path
  - name in query
  - description in query
  - checkout in query
- Request
  - New body: 'multipart/form-data'
  - Deleted body: 'application/json'
- Response
  - Changed response : [202]//Request has been accepted by server
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/importExcelDesign Import design excel from plan dashboard
- Parameters
  - Add name in query//Optional parameter. Design name for the new design. Input value is a string.
  - Add description in query//Optional parameter. Design description for the new design. Input value is a string.
  - Add branchName in query//Optional parameter. Design branch name for the new design. Input value is a string.
  - Add branchDescription in query//Optional parameter. Design branch description for the new design. Input value is a string.
  - Add checkout in query//Optional parameter. Design check out state for the new design. It is a boolean value.
  - Add eventChannelForProgress in query//Event Channel For Progress
  - planId in path
- Request
  - Schema incompatible
    Changed body: 'multipart/form-data'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Design from excel imported successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/importEptDesign Import .ept design.
- Parameters
  - Add branchName in query//Branch Name
  - Add branchDescription in query//Branch Description
  - Add preserveFutureProjects in query//Preserve Future Projects (if any exist in design)
  - Add eventChannelForProgress in query//Event Channel For Progress
  - planId in path
  - name in query
  - description in query
  - checkout in query
- Request
  - New body: 'multipart/form-data'
  - Deleted body: 'application/json'
- Response
  - Changed response : [202]//Request has been accepted by server
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/importEptDesignNoJob Import .ept design without job.
- Parameters
  - Add branchName in query//Branch Name
  - Add branchDescription in query//Branch Description
  - planId in path
  - name in query
  - description in query
- Request
  - New body: 'multipart/form-data'
  - Deleted body: 'application/json'
- Response
  - Changed response : [201]//A new design is created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/plans/{planId}/importDesign Import .ept or .wsp design.
- Parameters
  - Add branchName in query//Branch Name
  - Add branchDescription in query//Branch Description
  - Add preserveFutureProjects in query//Preserve Future Projects (if any exist in design)
  - planId in path
  - name in query
  - description in query
  - checkout in query
- Request
  - New body: 'multipart/form-data'
  - Deleted body: 'application/json'
- Response
  - Changed response : [202]//Request has been accepted by server
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/designs/{designId}/runDesign
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//run design executed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/designs/{designId}/revertCheckout
- Parameters
  - designId in path
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//Design checkout reverted successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/designs/{designId}/omsPowerTuning OMS Power Tuning.
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Request completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/designs/{designId}/omsOscSfpCalculation OSC SFP Calculation.
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Request completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobs/designs/{designId}/asellState ASE Line Loading.
- Parameters
  - designId in path
  - enabled in query change into required
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Request completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/jobExecutions/{id}/stop
- Parameters
  - id in path
- Response
  - Changed response : [200]//Job stopped successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/jobExecutions/{id}/restart
- Parameters
  - id in path
- Response
  - Changed response : [200]//Job restarted successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/jobExecutions/{id}/abandon
- Parameters
  - id in path
- Response
  - Changed response : [200]//Job abandoned successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/globalPreference
- Response
  - Changed response : [200]//Global preference data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/globalPreference
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Global preference data created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/systems Retrieves list of Systems associated to Design
- Parameters
  - Add Range in header
  - designId in path
  - pageable in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Retrieved system successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/systems Creates a new system
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [201]//Created
  - Changed response : [200]//System created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/systems/{systemId}/omsTrails Adds OMS to the system
- Parameters
  - Add pageable in query
  - designId in path
  - systemId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
DELETE/api/designs/{designId}/systems/{systemId}/omsTrails Deletes OMS from the System
- Parameters
  - Add pageable in query
  - designId in path
  - systemId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
GET/api/designs/{designId}/systems/{systemId}/omsTrails Retrieves the list of OMS for the given system
- Parameters
  - designId in path
  - systemId in path
  - pageable in query
- Response
  - Changed response : [200]//Retrieved list of OMS successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
DELETE/api/designs/{designId}/srgs
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
GET/api/designs/{designId}/srgs
- Parameters
  - Add Range in header
  - designId in path
  - srgType in query
  - pageable in query
- Response
  - Changed response : [200]//srgs retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/designs/{designId}/srgs
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//SRG successfully created
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/srgs/{id}/trails
- Parameters
  - designId in path
  - id in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//add trail by srg successful
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/sites Retrieve Sites associated to Design
- Parameters
  - Add colorProfileIds in query//Color Profile Id
  - Add Range in header
  - designId in path
  - startPhaseId in query
  - pageable in query
  - Delete~~rules~~in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Site data retrieved
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/sites
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Site created
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/sites/fastMode Create entities using fast mode
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Sites by fast mode created successfully
POST/api/designs/{designId}/sites/advanceSearch Site Advanced search
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input value is an integer array.
  - Add pageable in query
  - designId in path
  - startPhaseId in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Paged list of sites retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/site/{siteId}/node Create node
- Parameters
  - designId in path
  - siteId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [201]//node created successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/designs/{designId}/site/uniquename Get Unique Name for Site
- Parameters
  - designId in path
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Site unique name returned
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/segments Create segment
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Segment created successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/designs/{designId}/segments/default Retrieve segment related global values
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [201]//Created
  - Changed response : [200]//Retrieved segment validation data successfully.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/designs/{designId}/save Save currently opened design.
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Design saved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/runVerification
- Parameters
  - designId in path
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//Run verification started
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/runVerificationEnhanced
- Parameters
  - designId in path
- Request
  - New body: 'application/json'
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//Enhanced Verification started.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/readOnlyClone
- Parameters
  - Add revision in query//Unique id of the revision if copy should be for a revision
  - designId in path
  - isWorkingDesign in query
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Read-Only copy created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/preferences/{preferenceId} Create the user preferences
- Parameters
  - designId in path
  - preferenceId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [201]//User preference created successfully
POST/api/designs/{designId}/nra/whatifAnalysis Run Restoration Analysis on Failure Sequence
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Job running restoration analysis completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/nra/resiliencyAnalysis Run Restoration Analysis on Failure Scope
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Job running restoration analysis completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/nodes/advanceSearch Retrieve Nodes associated to Design for Advanced Search
- Parameters
  - Add colorProfileIds in query//Optional parameter. Specifies the list of color profile ids. Input value should be integer array.
  - Add pageable in query
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Paged list of nodes retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
POST/api/designs/{designId}/nes/advanceSearch Network Element Advanced search
- Parameters
  - Add colorProfileIds in query//Optional parameter. Specifies the list of color profile ids. Input value should be an integer array.
  - Add pageable in query
  - designId in path
  - startPhaseId in query
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Paged list of Network elements retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/importTrailExcel Import trails from excel
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'multipart/form-data'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Trails from excel imported successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/importDesignExcel Import design excel
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'multipart/form-data'
    Changed property type: (object -> object)
- Response
  - Changed response : [202]//Design from excel imported successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/forceCheckin Force check-in design.
- Parameters
  - designId in path
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Design has been checked in
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/failureSequences
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//Deleted List of Failure Sequences successfully
GET/api/designs/{designId}/failureSequences
- Parameters
  - Add Range in header
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//List of Failure Sequence retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/failureSequences
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Failure Sequence created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/demands Delete demands list
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
POST/api/designs/{designId}/demands
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - New response : [412]//Design not loaded
  - Changed response : [201]//Demand successfully created
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
POST/api/designs/{designId}/commission
- Parameters
  - Add pageable in query
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//Commissioning file generated successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
    - Schema incompatible
      Changed body: 'application/xml'
      Changed property type: (object -> object)
GET/api/designs/{designId}/commission
- Parameters
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//Commissioning file inputs successfully synthesized.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
    - Schema incompatible
      Changed body: 'application/xml'
      Changed property type: (object -> object)
POST/api/designs/{designId}/closeDesign Release a design forcefully from EPT engine and reset design operational state
- Parameters
  - designId in path
- Response
  - Deleted response : [202]//Accepted
  - Changed response : [200]//design is closed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/clone
- Parameters
  - Add branchName in query//Name for new design branch
  - Add branchDescription in query//Description for new design branch
  - designId in path
  - destinationPlanId in query
  - name in query
  - description in query
  - checkout in query
  - isWorkingDesign in query
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Design clone created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/checkout
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Design checked out successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/checkin
- Parameters
  - designId in path
- Request
  - New body: 'application/json'
- Response
  - Deleted response : [200]//OK
  - Changed response : [202]//Design check in done successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
POST/api/designs/{designId}/blocks/{blockId}/logicalScenarioComposition
- Parameters
  - designId in path
  - blockId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Changed response : [200]//next scenario read successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/dashboards Retrieve all dashboards
- Response
  - Changed response : [200]//List of dashboards retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (array -> object)
POST/api/dashboards Create dashboard
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (object -> object)
- Response
  - Deleted response : [200]//OK
  - Changed response : [201]//Dashboard created successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/{designId}/designActivityLogs
- Parameters
  - Add search in query//Search string filter that is applied across the retrieved activity log records.
  - Add Range in header
  - designId in path
  - specification in query
  - pageable in query
- Response
  - Changed response : [200]//Activity log list retrieval for given design
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/users/me Retrieve the current user.
- Response
  - Changed response : [200]//Current user details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/{templateId}
- Parameters
  - templateId in path
- Response
  - Changed response : [200]//Template retrieved successfully based on ID
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/management/{templateId} Retrieves the template based on template ID
- Parameters
  - templateId in path
- Response
  - Changed response : [200]//Template based on ID retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/templates/entity/design/{designId}/{templateId}
- Parameters
  - designId in path
  - templateId in path
- Response
  - Changed response : [200]//Template associated to Design retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/tablePreferences/tableName
- Parameters
  - tableName in query
- Response
  - Changed response : [200]//Table preference retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/roles/{roleName} Delete a role.
- Parameters
  - roleName in path
- Response
  - Changed response : [204]//Role deleted successfully
GET/api/roles/{roleName} Retrieve role details.
- Parameters
  - roleName in path
- Response
  - Changed response : [200]//Role details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/jobExecutions/{id}
- Parameters
  - id in path
- Response
  - Changed response : [200]//Job retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/{trailId}/routes Retrieve the RouteDto model based on the layer for a trail and trail id
- Parameters
  - designId in path
  - trailId in path
  - layer in query
- Response
  - Changed response : [200]//Route details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/{trailId}/routesHierarchy Retrieve routes hierarchy of a demand to use in Show Route
- Parameters
  - designId in path
  - trailId in path
  - layer in query
- Response
  - Changed response : [200]//Show route details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/{trailId}/routesHierarchyForTrail Retrieve the TrailDto model based on the layers
- Parameters
  - designId in path
  - trailId in path
  - layer in query
- Response
  - Changed response : [200]//Trail data details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/trails/{trailId}/restorationRoutes Retrieve the restoration routes for a demand based on a restoration id and trail id
- Parameters
  - designId in path
  - trailId in path
  - restorationId in query
- Response
  - Changed response : [200]//Restoration routes retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/system/potential/namevalidate Retrieves a valid system default name
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Retrieved valid name for system successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/spans Retrieve a page of SegmentDto objects
- Parameters
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//Segments retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/sites/{siteId}/nes Retrieve NEs associated to Site
- Parameters
  - designId in path
  - siteId in path
  - startPhaseId in query
  - pageable in query
- Response
  - Changed response : [200]//Network element(s) retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/shelves/{shelfId} Retrieve shelf
- Parameters
  - designId in path
  - shelfId in path
- Response
  - Changed response : [200]//Shelf retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/shelves/{shelfId}/packPlacement Retrieve pack placement
- Parameters
  - designId in path
  - shelfId in path
- Response
  - Changed response : [200]//Pack Placement retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/regenerators Retrieve list of regenerators associated to Design
- Parameters
  - Add Range in header
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//regens retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/regenerators
- Parameters
  - designId in path
- Request
  - Schema incompatible
    Changed body: 'application/json'
    Changed property type: (array -> object)
- Response
  - Changed response : [204]//3Rs deleted successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/preferences Retrieve user preferences for a design
- Parameters
  - designId in path
- Response
  - Changed response : [200]// User preferences retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/plan Retrieve plan information for given design.
- Parameters
  - designId in path
- Response
  - Changed response : [200]//Request completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/openDesign Get the design engine and load design in the design engine
- Parameters
  - designId in path
- Response
  - Deleted response : [202]//Accepted
  - Changed response : [200]//Request completed successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/omsTrailsData/{trailId} Retrieve Trail Data for OMS
- Parameters
  - designId in path
  - trailId in path
- Response
  - Changed response : [200]//Oms trail data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
DELETE/api/designs/{designId}/nra/results Delete results of all Restoration Analyses
- Parameters
  - designId in path
- Response
  - Changed response : [204]//NRA results successfully removed
GET/api/designs/{designId}/nra/results Retrieve results of Restoration Analyses associated with Design
- Parameters
  - Add Range in header
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//Restoration Analysis results retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/nra/results/{nraId}/summary Retrieve summary of Restoration Analyses results.
- Parameters
  - designId in path
  - nraId in path
- Response
  - Changed response : [200]//Restoration Analysis results retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/nodes
- Parameters
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//nodes retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/nodes/{nodeId}
- Parameters
  - designId in path
  - nodeId in path
- Response
  - Changed response : [200]//node retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/nodes/logical/{nodeId}
- Parameters
  - designId in path
  - nodeId in path
- Response
  - Changed response : [200]//logical node retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/node/{nodeId}/schematicView/nodeBlockList Retrieves the block list in node
- Parameters
  - designId in path
  - nodeId in path
- Response
  - Changed response : [200]//Returns list of Block Id and Block Name to be diplayed in MenuItem inside NodeBlockIdAndNameMap structure
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/node/{nodeId}/lineBlocks/{blockInstance}
- Parameters
  - designId in path
  - nodeId in path
  - blockInstance in path
- Response
  - Changed response : [200]//line block retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/node/{nodeId}/adBlocks/{blockInstance}
- Parameters
  - Add bandType in query//Band Type. Possible values are C, L, C with L, L with C.
  - Add blockIdentifier in query//Block Identifier: name of directional add drop block (FSX#)
  - designId in path
  - nodeId in path
  - blockInstance in path
- Response
  - Changed response : [200]//add drop block retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/nes Retrieve Network Elements by Design
- Parameters
  - Add colorProfileIds in query//Specifies the list of color profile ids
  - Add Range in header
  - designId in path
  - pageable in query
  - Delete~~startPhaseId~~in query//Start Phase Id
- Response
  - Changed response : [200]//Network elements retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/failureSequences/{id}/details
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//Failure Sequence details retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/failureScopes
- Parameters
  - Add Range in header
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//List of Failure Scope retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/failureScopes/{id}/details
- Parameters
  - designId in path
  - id in path
- Response
  - Changed response : [200]//Failure Scope details retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/designErrors Retrieve design errors and warnings
- Parameters
  - Add includeSuppressedWarnings in query//Include suppressed warnings
  - Add Range in header
  - designId in path
  - specification in query
  - pageable in query
- Response
  - Changed response : [200]//Design errors/warnings/info retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/demandsData Retrieve all Demands associated to Design
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input is an integer array.
  - Add serviceType in query//Optional Parameter. Specifies the service type. Default value is L0. Possible values are L0, L1.
  - Add Range in header
  - designId in path
  - routingRequestType in query
  - pageable in query
- Response
  - Changed response : [200]//Demand data retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/btmTblSegmentTrailData Retrieve segments associated to Design
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input value is an integer array.
  - Add Range in header
  - designId in path
  - pageable in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Segment trail data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/btmTblOtsTrailsData Retrieve all OTS associated to the design
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input value is an integer array.
  - Add Range in header
  - designId in path
  - pageable in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Paged list of OTS retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/btmTblOmsTrailsData Retrieve list of Oms associated to the design
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input value is an integer array.
  - Add Range in header
  - designId in path
  - pageable in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Paged list of OMS retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/btmTblNodeData Retrieve nodes data associated to design
- Parameters
  - Add colorProfileIds in query//Optional parameter. Specifies the list of color profile ids. Input value should be an integer array.
  - Add Range in header
  - designId in path
  - pageable in query
- Response
  - Changed response : [200]//Paged list of Node data retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/designs/{designId}/btmTblGlassThrough Retrieve all GlassThrough associated to Design
- Parameters
  - Add colorProfileIds in query//Optional Parameter. Specifies the list of color profile ids. Input value is an integer array.
  - Add Range in header
  - designId in path
  - pageable in query
- Request
  - New body: 'application/json'
- Response
  - Changed response : [200]//Glass-through data retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/blocks/{blockId}/logicalila Retrieve the DTO of an ILA Block
- Parameters
  - designId in path
  - blockId in path
- Response
  - Changed response : [200]//the logical and physical representation of an ILA block has been retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/blocks/{blockId}/logical Retrieve composition of a Line Block
- Parameters
  - designId in path
  - blockId in path
- Response
  - Changed response : [200]//line block composition retrieved successfully
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/designs/{designId}/activeFailureScope
- Parameters
  - designId in path
  - Delete~~pageable~~in query
- Response
  - Changed response : [200]//Active Failure Scope retrieved successfully
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/backup/info
- Response
  - Changed response : [200]//Retrieved backup information successfully.
    - Schema incompatible
      Changed body: '*/*'
      Changed property type: (object -> object)
GET/api/activityLogs
- Parameters
  - search in query
  - specification in query
  - pageable in query
- Response
  - Changed response : [200]//Activity log list retrieval
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (array -> object)
GET/api/about WaveSuite Planner release information.
- Response
  - Changed response : [200]//WaveSuite Planner release information retrieved successfully.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)
GET/api/aboutDa WaveSuite Planner Design Algorithm release information.
- Response
  - Changed response : [200]//WaveSuite Planner Design Algorithm release information retrieved successfully.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> object)

Application Versions⇑

What's New⇑

What's Deleted⇑

What's Deprecated⇑

What's Changed⇑

Response

Parameters

Response

Schema incompatible

Parameters

Request

Schema incompatible

Response

Parameters

Response

Schema incompatible

Parameters

Request

Schema incompatible

Response

Parameters

Request

Schema incompatible

Response

Schema incompatible

Parameters

Request

Schema incompatible

Response

Parameters

Request

Schema incompatible

Response

Parameters

Response

Schema incompatible

Parameters

Request

Schema incompatible

Response

Schema incompatible

Parameters

Response

Schema incompatible

Parameters

Request

Schema incompatible

Response

Schema incompatible

Parameters

Response

Parameters

Response

Schema incompatible

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Request

Schema incompatible

Response

Schema incompatible

Parameters

Response

Schema incompatible

Response

Parameters

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible