Api Change Log

Application Versions


Changes between 23.12.0 to 25.6.0

What's New


  1. No Changes

What's Deleted


  1. POST/service/fetchMessageCountersForTimeDistribution fetch these counters from the NE. Announce Message Tx, Announce Message Rx, Sync Message Tx, Sync Message Rx, Delay Request Message Rx, Delay Request Message Tx, Delay Response Message Tx, Delay Response Message Rx, Signalling Message Tx, Signalling Message Rx.
  2. POST/service/clearMessageCountersForTimeDistribution clears these counters in the NE, sets their value to zero. Announce Message Tx, Announce Message Rx, Sync Message Tx, Sync Message Rx, Delay Request Message Rx, Delay Request Message Tx, Delay Response Message Tx, Delay Response Message Rx, Signalling Message Tx, Signalling Message Rx.
  3. POST/labels/unassignLabelToWSSService This endpoint allows you to unAssign a label to either PTP or SYNCE services if being attached previously by specifying the proper service ID.
  4. POST/labels/createAndAssignLabelToWSSService This endpoint allows you to create a new label and assign that label to either PTP or SYNCE services by specifying the proper service ID.
  5. POST/labels/assignLabelToWSSService This endpoint allows you to assign a label to either PTP or SYNCE services by specifying the proper service ID.
  6. GET/portsBrowser/getAllDeployedPorts Gets deployed time distribution port details for the given filter. Filter can be nserviceid, neid, clockid or port type. Get time distribution port details include portname, port ID, type, role, profile, port description, clock id, clock name, clock mode, admin state etc. as output. Supported NE Types: 1830 PSS-32, 1830 PSS-4, 1830 PSS-8, 1830 PSS-16II
  7. GET/portsBrowser/getAllBitsPortParamForFreqDist Fetches BITS port parameters for frequency distribution service with nserviceId portID and bitsPortDirection Supported NE Types - 1830 PSS-32,1830 PSS-4,1830 PSS-8,1830 PSS-16II
  8. GET/pmBrowser/getPortProfileDetailsByServiceID get PTP ports which are associated to the profile for the given serviceId.
  9. GET/pmBrowser/getAllPortsDetailsByServiceIDForAssociate Get All PTP ports details by giving the service ID as input For TCA profile association.
  10. GET/linksBrowser/getSubRouteDetailsByTpIds Get SubRoutes based on source and destination tpids for each route
  11. GET/linksBrowser/getLinksByServiceId Get route details both OPS & PTPIOC to PTPIOC links present in the time distribution service by service id
  12. GET/linerefSyn0SyncOutBits/getAllDeployedSyncOAndSyncOutDetails get Sync0, SyncOut details based on service id and ne id
  13. GET/labels/getAllLabelNamesForWSS This endpoint allows you to fetch all the labels required to assign or unAssign those labels to a PTP or SYNCE
  14. GET/clocksBrowser/getAllDeployedClocks Get PTP deployed clock details for a given service ID. Clock details include Clock name, clock mode , Time reference , Priority 1, Priority 2, Local priority, TOD Msg type, Sync uncertain monitoring, enhanced EPRTC, path trace enabled, maximum steps removed, Time error settings, Holdover in spec duration and SYNC OAM parameters will be displayed. Supported NE Types: 1830 PSS-32,1830 PSS-4,1830 PSS-8,1830 PSS-16II

What's Deprecated


  1. No Changes

What's Changed


  1. GET/data/timeDist/TimeDistServ2Ds Get Data of NE's with Master Clock
    • Response

      • New response : [403]//Forbidden
      • Changed response : [200]//NE data on which master clocks are riding
    • GET/portsBrowser/getPorts searches port Data for time distribution
      • Response

        • New response : [403]//Forbidden
        • Changed response : [400]//bad input parameter
          • Changed response : [200]//search results for given neid and portType
            • Schema incompatible

              Changed body: 'application/json'

              Missing property: notMaster (string)

              Missing property: monitorSender (string)

              Missing property: monitorReceiver (string)

              Missing property: pmEnabled (string)

              Missing property: signalFailLOTM (string)

              Missing property: signalFailSU (string)

              Missing property: neName (string)

              Missing property: release (string)

      • GET/pmBrowser/getSyncEProfileDetailsByServiceID get SyncE elements details associated to a profile
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//SyncE Profile details
            • Schema incompatible

              Changed body: 'application/json'
      • GET/pmBrowser/getAllSyncEProfileDetailsByServiceIDForAssociate Get SyncE Details for Associate By Service ID
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//SyncE Profile details
            • Schema incompatible

              Changed body: 'application/json'
      • GET/jobs Get Jobs
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//Job Count
            • Schema

              Changed body: 'application/json'
      • GET/cardsBrowser/getCardsFromNeId searches card Data
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//search results for given neid
            • Schema

              Changed body: 'application/json'
      • POST/templatesService/unPublishTimeDistributionTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/unPublishFreqDistributionTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/publishTimeDistributionTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/publishFreqDistributionTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/modifyTimeDistTemplate
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: clockTimeTemplateAttributes.holdoverInSpecDuration (integer)

      • POST/templatesService/modifyFreqDistTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/deleteMultipleTimeDistTemplate deletion of Time Distribution Template
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/deleteMultipleFreqDistTemplate deletion of Frequency Distribution Template
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/templatesService/createTimeDistTemplate
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: clockTimeTemplateAttributes.holdoverInSpecDuration (integer)

      • POST/templatesService/createFreqDistTemplate
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/saveTimeDistributionServiceClockAndPortInfo
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: clockList[n].holdoverInSpecDuration (integer)

            Missing property: clockList[n].clockName (string)

            Missing property: clockList[n].additionalProperties (object)

            Missing property: portsList[n].notMaster (string)

            Missing property: portsList[n].monitorSender (string)

            Missing property: portsList[n].monitorReceiver (string)

            Missing property: portsList[n].pmEnabled (string)

            Missing property: portsList[n].clockMode (string)

            Missing property: portsList[n].additionalProperties (object)

            Missing property: portsList[n].portName (string)

      • POST/service/exportServicesToCsv
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/pmService/deleteTCAProfile
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/pmService/createTCAProfile
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: ptoffattAverage (integer)

            Missing property: ptoffattMaxTR1day (integer)

            Missing property: ptoffattMaxTR15min (integer)

            Missing property: ptoffattMinTR15min (integer)

            Missing property: ptoffattMinTR1day (integer)

            Missing property: ptoffattMaxRTR15min (integer)

            Missing property: ptoffattMinRTR15min (integer)

      • POST/domainBrowser/exportDomains
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/syncService/syncNodes Sync PTP clock data from WS-NOC application
        • Request

          • Schema

            Changed body: 'application/json'
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//Successfully sync time distribution clock for given nodes
            • Schema

              Changed body: 'application/json'
      • POST/syncService/syncDomains
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/syncTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/syncFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/saveFreqDistributionServiceLinerefAndPortInfo
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deployTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deployFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deleteTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deleteMultipleServices deletion of Services
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deleteFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/decommissionTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/decommissionFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/deactivateTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/dbdeleteTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/dbdeleteFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/createTimeDistributionService
        • Request

          • Schema incompatible

            Changed body: 'application/json'
      • POST/service/createFreqDistributionService
        • Request

          • Schema incompatible

            Changed body: 'application/json'
      • POST/service/createFreqDistributionServiceWithPortDetails
        • Request

          • Schema incompatible

            Changed body: 'application/json'
      • POST/service/clearPMTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/clearPMFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/activateTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/abortTimeDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/service/abortFreqDistributionService
        • Request

          • Schema

            Changed body: 'application/json'
      • POST/pmService/clearTCAProfile
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: associateaPortProfileList (array)

      • POST/pmService/clearTCAProfileForSyncE
        • Request

          • Schema incompatible

            Changed body: 'application/json'
      • POST/pmService/associateTCAProfile
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Missing property: associateaPortProfileList (array)

      • POST/pmService/associateTCAProfileForSyncE
        • Request

          • Schema incompatible

            Changed body: 'application/json'
      • POST/discoveryService/discovery discovery PTP & SyncE clock data from WS-NOC application
        • Parameters

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

          • Schema

            Changed body: 'application/json'
        • Response

          • New response : [403]//Forbidden
          • Changed response : [200]//Successfully sync time distribution clock for given nodes
            • Schema

              Changed body: 'application/json'