Api Change Log

Application Versions⇑

Changes between 22.12 to 24.6

What's New⇑

1. POST /syncService/syncDomains Sync PTP clock data from WS-NOC application
2. POST /service/deleteMultipleServices Supports bulk deletion of Services.
3. POST /service/decommissionFreqDistributionService decommission frequency distribution service
4. POST /domainBrowser/exportDomains Export Domains to Csv
5. GET /linksBrowser/getSubRouteDetailsByTpIds Get SubRoutes based on source and destination tpids for each route
6. GET /cardsBrowser/getShelfOrCardDetailsForFreqDistFromNeId fetches shelf data by passing neid and optional serviceId
7. GET /cardsBrowser/getCardDetailsForLinerefFromNeIdAndShelfIdAndServiceId fetches selected card data by passing neid and shelf id and service id for frequency distribution service

What's Deleted⇑

1. GET /resources/common/menu/systemProperty.json null
2. GET /resources/common/list/GuiProperty.json null
3. GET /data/plat/usermgt/** null
4. GET /data/otn/system/getVersion null
5. GET /preferences/common/guiProperty/{userId} null
6. GET /nodesBrowser/test test
7. GET /login null
8. GET /data/common/sessionInfo null
9. GET /redirected-to-unreachable-nodes null
10. PUT /redirected-to-unreachable-nodes null
11. POST /redirected-to-unreachable-nodes null
12. DELETE /redirected-to-unreachable-nodes null
13. PATCH /redirected-to-unreachable-nodes null
14. HEAD /redirected-to-unreachable-nodes null
15. OPTIONS /redirected-to-unreachable-nodes null
16. GET /redirected-to-reachable-nodes null
17. PUT /redirected-to-reachable-nodes null
18. POST /redirected-to-reachable-nodes null
19. DELETE /redirected-to-reachable-nodes null
20. PATCH /redirected-to-reachable-nodes null
21. HEAD /redirected-to-reachable-nodes null
22. OPTIONS /redirected-to-reachable-nodes null
23. GET /redirected-to-mnc-map null
24. PUT /redirected-to-mnc-map null
25. POST /redirected-to-mnc-map null
26. DELETE /redirected-to-mnc-map null
27. PATCH /redirected-to-mnc-map null
28. HEAD /redirected-to-mnc-map null
29. OPTIONS /redirected-to-mnc-map null
30. GET /redirected-to-help null
31. PUT /redirected-to-help null
32. POST /redirected-to-help null
33. DELETE /redirected-to-help null
34. PATCH /redirected-to-help null
35. HEAD /redirected-to-help null
36. OPTIONS /redirected-to-help null
37. GET /redirected-to-common-jobs null
38. PUT /redirected-to-common-jobs null
39. POST /redirected-to-common-jobs null
40. DELETE /redirected-to-common-jobs null
41. PATCH /redirected-to-common-jobs null
42. HEAD /redirected-to-common-jobs null
43. OPTIONS /redirected-to-common-jobs null
44. GET /redirected-to-alarms null
45. PUT /redirected-to-alarms null
46. POST /redirected-to-alarms null
47. DELETE /redirected-to-alarms null
48. PATCH /redirected-to-alarms null
49. HEAD /redirected-to-alarms null
50. OPTIONS /redirected-to-alarms null

What's Deprecated⇑

What's Changed⇑

1. GET /serviceBrowser/getServiceById

   • Response

     • Changed response : [200]//Time distribution service details

       • Schema

         Changed body: 'application/json'
2. GET /portsBrowser/getPorts searches port Data for time distribution service

   • Parameters

     • Add filter in query//For time distribution service creation/modification, filters for looking up port data and filter keys are serviceid, neid, clockid, porttype , the serviceid can be fetched from restcall - serviceBrowser/allServices based on the serviceName , neId can be fetched from restcall - /nodesBrowser/allNodes based on neName clockId can be taken from rest call - clocksBrowser/getClockDetails porttype can be DATA , TOD or PPSTEST.
3. GET /portsBrowser/getPortsParamForFreqDist searches port params data for frequency distribution services

   • Parameters

     • Add cardId in query//card id for which data has to be fetched , card id can be fetched from /cardsBrowser/getCardsFromNeId.
4. GET /portsBrowser/getPortsAndBitsParamForFreqDist searches port params data for frequency distribution service

   • Parameters

     • Add cardId in query//card id for which data has to be fetched , card id can be fetched from /cardsBrowser/getCardsFromNeId.
5. GET /portsBrowser/getFreqPorts searches port Data for frequency distribution services

   • Parameters

     • Add filter in query//For frequency distribution service creation/modification, filters for looking up frequency distribution port data and filter keys are nserviceid, neid, cardid, shelfid nserviceid can be fetched from restcall - serviceBrowser/allServices based on the serviceName , neId can be fetched from restcall - /nodesBrowser/allNodes based on neName , card id can be fetched from /cardsBrowser/getCardsFromNeId.
6. GET /nodesBrowser/getNodesForSyncBySubNetworkId

   • Response

     • Changed response : [200]//search results for given subnetwork Id
   • GET /nodesBrowser/getNodesByServiceId

     • Parameters

       • Add filter in query//filters keys for querying node data are nserviceid in time distribution service create/modify flow and nserviceid can be fetched from restcall - serviceBrowser/allServices based on the serviceName.

     • Response

       • Changed response : [200]//search results for the provided serviceid and neid.
     • GET /nodesBrowser/getFreqNodesByServiceId searches Node Data based on Service Id for frequency distribution service

       • Parameters

         • Add filter in query//filters keys for querying node data are nserviceid in frequency distribution service create/modify flow and nserviceid can be fetched from restcall - serviceBrowser/allServices based on the serviceName.

       • Response

         • Changed response : [200]//search results for the provided serviceid and neid.
       • GET /linerefSyn0SyncOutBits/getSyncOutDetails get SyncOut details of a service based on serviceId , neId along with optional shelfId and cardId

         • Parameters

           • Add cardId in query//pass card id for looking up syncOut details , card id can be fetched from /cardsBrowser/getCardsFromNeId.
           • shelfId in query change into not required
       • GET /linerefSyn0SyncOutBits/getSyncAndBitsDetailsByServiceIdAndNeIdAndShelfId get Sync0, SyncOut and BITS details based on service id and ne id and shelf id and card id

         • Parameters

           • Add cardId in query//pass card id for looking up syncO,syncOut and bits details , card id can be fetched from /cardsBrowser/getCardsFromNeId.
           • shelfId in query change into not required
       • GET /jobs Get count of inprogress , completed and aborted jobs of WSS

         • Response

           • Changed response : [200]//Jobs Count

             • Schema

               Changed body: 'application/json'
       • GET /cardsBrowser/getCardsFromNeId

         • Response

           • Changed response : [200]//search results for given neid , neId can be fetched from restcall - /nodesBrowser/allNodes based on neName
         • GET /bitsPortsBrowser/getBitsPortsParamForFreqDist

           • Parameters

             • Add cardId in query//pass a card id along with ne id & service id for getting card data based on associated clock , card id can be fetched from /cardsBrowser/getCardsFromNeId.
             • shelfId in query change into not required
         • POST /templatesService/modifyTimeDistTemplate

           • Response

             • Changed response : [201]//Successful modification of time distribution template
           • POST /templatesService/modifyFreqDistTemplate modification of Frequency Distribution Template and send "templateType" as "SYNCE"

             • Response

               • Changed response : [201]//Successful modification of Frequency distribution template
             • POST /service/saveTimeDistributionServiceClockAndPortInfo

               • Response

                 • Changed response : [201]//Clock and Port info for time distribution service has been successfully saved.
               • POST /service/exportServicesToCsv Export Time Distribution Services in Csv format

                 • Response

                   • Changed response : [200]//Export Time distribution service details
                 • GET /portsBrowser/getLineRefVsPortsForFreqDist

                   • Parameters

                     • Add cardId in query//card id for which data has to be fetched , card id can be fetched from /cardsBrowser/getCardsFromNeId.
                     • shelfId in query change into not required
                 • GET /data/timeDist/TimeDistRouteServ2Ds Get routes data of Frequency/Time distribution service

                   • Response

                     • Changed response : [200]//Route of Frequency/Time distribution service

                       • Schema

                         Changed body: 'application/json'
                 • POST /syncService/syncNodes The WS-S entities for clock and the corresponding PTP/SyncE port details are synced for the given nodes

                   • Response

                     • Changed response : [200]//Successfully triggered sync for the given nodes
                   • POST /service/syncTimeDistributionService

                     • Response

                       • Changed response : [201]//Sync of Clock/Port parameters and routes for the time distribution service is successful.
                     • POST /service/syncFreqDistributionService

                       • Response

                         • Changed response : [201]//Sync of Clock/Port parameters and routes for the frequency distribution service is successful.
                       • POST /service/saveFreqDistributionServiceLinerefAndPortInfo

                         • Request

                           • Schema

                             Changed body: 'application/json'

                         • Response

                           • Changed response : [201]//Lineref and port info for the frequency distribution service have been successfully saved.
                         • POST /service/deployTimeDistributionService

                           • Response

                             • Changed response : [201]//Time distribution service has been deployed successfully.
                           • POST /service/deployFreqDistributionService

                             • Response

                               • Changed response : [201]//Frequency distribution service has been deployed successfully.
                             • POST /service/deleteTimeDistributionService

                               • Response

                                 • Changed response : [201]//Time distribution service has been successfully deleted.
                               • POST /service/deleteFreqDistributionService

                                 • Response

                                   • Changed response : [201]//Frequency distribution service has been successfully deleted.
                                 • POST /service/deactivateTimeDistributionService

                                   • Response

                                     • Changed response : [201]//Time distribution service has been successfully deactivated.
                                   • POST /service/createTimeDistributionService

                                     • Response

                                       • Changed response : [201]//The time distribution service has been successfully created.
                                     • POST /service/createFreqDistributionService

                                       • Response

                                         • Changed response : [201]//The frequency distribution service has been successfully created.
                                       • POST /service/createFreqDistributionServiceWithPortDetails

                                         • Response

                                           • Changed response : [201]//The frequency distribution service has been successfully created with port details.
                                         • POST /service/activateTimeDistributionService

                                           • Response

                                             • Changed response : [201]//Time distribution service has been successfully activated.
                                           • POST /service/abortTimeDistributionService

                                             • Response

                                               • Changed response : [201]//Abort the time distribution service was successful.
                                             • POST /service/abortFreqDistributionService

                                               • Response

                                                 • Changed response : [201]//Abort the frequency distribution service was successful.
                                               • POST /discoveryService/discovery discover PTP, SyncE clock data from WS-S application

                                                 • Parameters

                                                   • Add discoveryType in query//Holds discovery type for discovering PTP, SyncE or Both services. Accepted values are "PTP","SyncE","PTPAndSyncE".

                                                 • Response

                                                   • Changed response : [200]//Successfully triggered WS-S Discovery operation
                                                 • GET /serviceBrowser/getServiceDetailsById Get Time distribution Service Details By Id

                                                   • Response

                                                     • Changed response : [200]//Time distribution service details

                                                       • Schema incompatible

                                                         Changed body: 'application/json'

                                                         Missing property: clocks[n].todportdetails[n].pssStatus (string)

                                                         Missing property: clocks[n].todportdetails[n].pssFormat (string)

                                                         Missing property: clocks[n].clockdataset[n].defaultdataset[n].adminState (string)

                                                         Missing property: clocks[n].clockdataset[n].currentdataset[n].currentTime (string)

                                                         Missing property: clocks[n].clockdataset[n].timepropertiesdataset[n].syncUncertainMon (string)