Api Change Log

Application Versions⇑

Changes between 24.6 to 25.12

What's New⇑

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.
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.
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.
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.
POST/labels/assignLabelToWSSService This endpoint allows you to assign a label to either PTP or SYNCE services by specifying the proper service ID.
GET/templatesBrowser/getTemplateTotalRecords Get the total count of templates
GET/serviceBrowser/allServices Get all Time Distributed or Frequency Distributed or PTP or SyncE Services. This API supports advanced filters 1. Text filters - Supported fields are SERVICE NAME (serviceName), REMARKS (remarks) a. serviceName contains 'Dis' or 'te' text Ex - (serviceName=*Dis*|serviceName=*te*) b. Multiple text filters symbols are AND -> &, exlude -> ! , wildcards -> _ 2. Enums filters - Supported fields are operational state(adminState), SYNC PARAMS STATUS (isSyncRunningremarks). Here in case of multiple enum values matching can pass with , seperated a. operational state values are in Down,Up Ex - adminState=Down,Up b. SYNC PARAMS STATUS values are In Progress, Success and Failure Ex - isSyncRunning=SUCCESS,FAILURE,INPROGRESS 3. Number range filters - Supported fields are PTP DOMAIN ID (eDomainId), UPTIME (uptimeOpstateMs) a. eDomainId values range from 0 to 255 Ex - eDomainId=ge=0&eDomainId=le=255 b. uptimeOpstateMs values range from 0 to 86400000 Ex - uptime_opstate_ms=ge=0&uptime_opstate_ms=le=86400000 4. Date filters - Supported fields are LAST MODIFIED (lastModified) time Ex - lastModified=2024-04-01T06-51-58.671Z;2024-04-11T06-51-58.676Z - here ; services list the lastModified time between 2024-04-01T06-51-58.671Z and 2024-04-11T06-51-58.676Z 5. Sorting - Sorting should apply only on a single field at a time and supported fields are serviceName, remarks, adminState, isSyncRunningremarks, eDomainId, uptimeOpstateMs and lastModified Ex - sort(serviceName) - asscending order and sort(-serviceName) - descending order.
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
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
GET/pmBrowser/getTotalTCAProfileCount Get the total count of TCA profiles
GET/pmBrowser/getPortProfileDetailsByServiceID get PTP ports which are associated to the profile for the given serviceId.
GET/pmBrowser/getAllPortsDetailsByServiceIDForAssociate Get All PTP ports details by giving the service ID as input For TCA profile association.
GET/nodesBrowser/getNodesForSyncByParentSubNetworkIds Get WSS supported nodes details for sync based on the given subnetwork IDs
GET/linksBrowser/getLinksByServiceId Get route details both OPS & PTPIOC to PTPIOC links present in the time distribution service by service id
GET/linerefSyn0SyncOutBits/getAllDeployedSyncOAndSyncOutDetails get Sync0, SyncOut details based on service id and ne id
GET/labels/getAllLabelNamesForWSS This endpoint allows you to fetch all the labels required to assign or unAssign those labels to a PTP or SYNCE
GET/domainBrowser/getAllSubnets fetches all subnetworks present in WS-NOC
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 Deleted⇑

No Changes

What's Deprecated⇑

No Changes

What's Changed⇑

GET/tpBrowser/getPortDataForTimeDistributionService Get port data by additional properties such as cardId and NeId for time distributed service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//ports(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/tpBrowser/getPortDataForFrequencyDistributionService fetches port data by additionalproperties as cardId and NeId for frequency distributed service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//ports(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/templatesBrowser/allTimeDistributionTemplates Get all WSS time distribution template details for the given template state
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//ptp/time distribution template data
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/templatesBrowser/allFreqDistributionTemplates Get All Frequency Distribution Templates with input Range (Ex 0-All)
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Frequency distribution template data
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/serviceBrowser/isTimeDistributionServiceModified
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/serviceBrowser/isFreqDistributionServiceModified
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/serviceBrowser/getServiceTreeViewNodeDetails Get tree view node details for ptp and syncE service by serviceId
- Parameters
  - serviceType in query
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Get tree view node details for ptp and syncE service by providing required service ID.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getPorts Get time distribution port details for the given filter. Filter can be nserviceid, neid, clockid or port type
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Search results for given neid and portType
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//Bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getPortsParamForFreqDist Get all ports and params associated for the given neId, serviceId, shelfID and cardID for frequency distribution service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for port
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getPortsForFreqDist Retrieve all the linerefs with the corresponding port details for a given cardId and serviceId for frequency distribution service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for port
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getPortsAndBitsParamForFreqDist Fetches port and bits params for frequency distribution service with neId, serviceId, shelfID and cardID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for port
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getLineRefVsPortsForFreqDist Fetches lineref vs port details for frequency distribution service with neId, serviceId , shelfID and cardID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for port
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/portsBrowser/getFreqPorts Fetches all the port details based on a filter which includes details like nename for frequency distribution services
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given neid and portType
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/pmBrowser/getSyncEProfileDetailsByServiceID get SyncE profile details which are associated for the given service id.
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//SyncE TCA Profile details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/pmBrowser/getClockProfileDetailsByServiceID get PTP clock details associated to a profile for the given serviceId.
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Clock Profile details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/pmBrowser/getAllTCAProfiles get all TCA profiles for WSS
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//TCA Profile details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/pmBrowser/getAllSyncEProfileDetailsByServiceIDForAssociate Get SyncE Details for Associate TCA profile By Service ID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//SyncE TCA Profile details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/pmBrowser/getAllClocksDetailsByServiceIDForAssociate Get all PTP clock details for a given service id in TCA profile association
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Clocks details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/nodesBrowser/getNodesForSyncBySubNetworkId Get WSS supported nodes details for the given subnetwork ID by excluding ENE model
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given subnetwork Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/nodesBrowser/getNodesBySubNetworkId Get WSS supported nodes details for the given subnetwork ID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given domainId
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/nodesBrowser/getNodesByServiceId Get node details present in time distribution service for the given range and filter
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for the provided serviceid and neid.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/nodesBrowser/getFreqNodesByServiceId Get Node details from Frequency Distribution service for given serviceId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for the provided serviceid and neid.
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/nodesBrowser/allNodes Get all supported nodes details for the given range and filter
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all Node(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linksBrowser/getSubRouteDetailsByTpIds
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given tpIds
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linksBrowser/getLinksByFreqDistServiceId Get routes details OPS and PTPIOC-PTPIOC present in the frequency distribution service by service id
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given linkid
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getSyncOutDetails
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All SyncOut Data by service Id and ne Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getSyncAndBitsDetails
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All SyncO,SyncOut and Bits Data by service Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getSyncAndBitsDetailsByServiceIdCardIdAndNeId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All SyncO,SyncOut and Bits Data by service Id,Card Id and ne Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getSyncAndBitsDetailsByServiceIdAndNeId get Sync0, SyncOut and BITS details based on serviceid and neid
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All SyncO,SyncOut and Bits Data by service Id and ne Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getSyncAndBitsDetailsByServiceIdAndNeIdAndShelfId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All SyncO,SyncOut and Bits Data by service Id and ne Id
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/linerefSyn0SyncOutBits/getLinerefDetails Get the list of all Lineref details based on a filter which includes service Id and neId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//All lineref Data
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/domainBrowser/getAllSubnetworks
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all domain details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/data/timeDist/TimeDistServ2Ds Get service and Timetrasmitter {master} clock information by providing required list of time distribution service IDs
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//NE data on which Timetrasmitter (master) clocks are riding
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/data/timeDist/TimeDistRouteServ2Ds
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Route of Frequency/Time distribution service
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/clocksBrowser/getClockDetails
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Clock Details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getShelfOrCardDetailsForFreqDistFromNeId Get shelf data by passing neid and optional serviceId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all Shelf(s) and Card details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getShelfFromNeId Get all available shelf details for a give NEID in WSS
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all Shelf(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getShelfForFreqDistFromNeId Get the shelf data based on the clock association by passing NE id and optional Service id along with boolean attribute isSelected.
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all Shelf(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getCardsFromNeId Gets details of WSS supported cards associated with particular NE whose ID is mentioned as a parameter
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for given neid , neId can be fetched from restcall - /nodesBrowser/allNodes based on neName
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getCardDetailsForLinerefFromNeIdAndShelfIdAndServiceId Get selected cards data by passing neid and shelf id and service id for frequency distribution service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Selected card(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getAllCardFromNeIdAndShelfId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all card(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getAllCardForFreqDistFromNeIdAndShelfId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all card(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/cardsBrowser/getAllCardForFreqDistFromNeIdAndServiceId Get the card data by passing neid and optional service id for frequency distribution service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//all card(s) details
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/bitsPortsBrowser/getBitsPortsParamForFreqDist Gets BITS port parameters for a given NE, shelf and card for frequency distribution service
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//search results for bits port
    - Schema incompatible
      Changed body: 'application/json'
      Changed property type: (object -> array)
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
GET/systempropertiesBrowser/getExternalSystemAddressAndPorts Get NFMT OMS 1350 external system address and port details
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//External system address and ports
    - Schema
      Changed body: 'application/json'
GET/serviceBrowser/getServiceById Get Time Distribution Service details by serviceId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//Time distribution service details
    - Schema
      Changed body: 'application/json'
GET/serviceBrowser/getFreqServiceById Get Frequency Distribution Service details By serviceId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//Frequency distribution service details
    - Schema
      Changed body: 'application/json'
GET/portsBrowser/getPortDetailsById Get time distribution port details for the given port ID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//search results for given neid, serviceid and portId
    - Schema incompatible
      Changed body: 'application/json'
GET/portsBrowser/getFreqPortDetailsById Get the port Data by portId applicable for data ports only for frequency distribution services
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//search results for given neid, serviceid and portId
    - Schema
      Changed body: 'application/json'
GET/pmBrowser/dashBoardTCAProfileCard Get count of all TCA profiles present in WSS application to display in dashboard
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//dashBoard TCAProfileCard data
    - Schema
      Changed body: 'application/json'
GET/nodesBrowser/getNodesTotalRecords Get total count of WSS supported nodes reachable/ non reachable count
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//node data
    - Schema
      Changed body: 'application/json'
GET/jobs
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//Bad request
    - New body: 'application/json'
  - Changed response : [200]//Jobs Count
    - Schema
      Changed body: 'application/json'
GET/alarmsBrowser/GetAlarmsCount Gets total number of alarms including critical, major, minor and warning alarms counts that wss supports
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//Alarm count
    - Schema
      Changed body: 'application/json'
POST/templatesService/unPublishTimeDistributionTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [200]//TimeDistribution Template UnPublish success or failure with validation
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/unPublishFreqDistributionTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [200]//FreqDistribution Template UnPublish success or failure with validation
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/publishTimeDistributionTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [200]//TimeDistribution Template Publish success or failure with validation
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/publishFreqDistributionTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [200]//FreqDistribution Template Publish success or failure with validation
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/modifyTimeDistTemplate
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful modification of time distribution template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/modifyFreqDistTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful modification of Frequency distribution template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/deleteMultipleTimeDistTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful deleteion of Template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/deleteMultipleFreqDistTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful deletion of Template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/createTimeDistTemplate
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful creation of Template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/templatesService/createFreqDistTemplate
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Successful creation of Template
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/saveTimeDistributionServiceClockAndPortInfo
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Clock and Port info for time distribution service has been successfully saved.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/exportServicesToCsv
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Export Time distribution service details
    - New body: 'application/vnd.ms-excel'
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
    - New body: 'application/vnd.ms-excel'
POST/pmService/deleteTCAProfile
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/pmService/createTCAProfile
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/domainBrowser/exportDomains
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [200]//Time/Frequency distribution service details
    - New body: 'application/vnd.ms-excel'
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
    - New body: 'application/vnd.ms-excel'
GET/templatesBrowser/getTemplateById Get time distribution template details for the given template ID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//template data
    - Schema incompatible
      Changed body: 'application/json'
GET/templatesBrowser/getFreqTemplateById Get Frequency Distribution Service Template by template Id
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//template data
    - Schema
      Changed body: 'application/json'
GET/pmBrowser/getProfileById get WSS TCA profile details for the given profile ID
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//TCA Profile detailsap
    - Schema incompatible
      Changed body: 'application/json'
GET/clocksBrowser/getClockDetailsById Get PTP clocks data by clockId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//Clock Details
    - Schema incompatible
      Changed body: 'application/json'
POST/syncService/syncNodes
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//Bad request
    - New body: 'application/json'
  - Changed response : [200]//Successfully triggered sync for the given nodes
    - Schema
      Changed body: 'application/json'
POST/syncService/syncDomains
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//Bad request
    - New body: 'application/json'
  - Changed response : [200]//Successfully sync time distribution clock for given nodes
    - Schema
      Changed body: 'application/json'
POST/service/syncTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Sync of Clock/Port parameters and routes for the time distribution service is successful.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/syncFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Sync of Clock/Port parameters and routes for the frequency distribution service is successful.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/saveFreqDistributionServiceLinerefAndPortInfo
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Lineref and port info for the frequency distribution service have been successfully saved.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/deployTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Time distribution service has been deployed successfully.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/deployFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Frequency distribution service has been deployed successfully.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/deleteTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Time distribution service has been successfully deleted.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/deleteMultipleServices
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid or bad request
    - New body: 'application/json'
  - Changed response : [201]//Successful deletion of Services
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
  - Changed response : [500]//Internal server error
    - Schema
      Changed body: 'application/json'
POST/service/deleteFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Frequency distribution service has been successfully deleted.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/decommissionTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//response for decommissioning of time distribution service
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/decommissionFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//response for decommissioning of frequency distribution service
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/deactivateTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Time distribution service has been successfully deactivated.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/dbdeleteTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Success Or Fail
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/dbdeleteFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Success Or Fail
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/createTimeDistributionService
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//The time distribution service has been successfully created.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/createFreqDistributionService
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//The frequency distribution service has been successfully created.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/createFreqDistributionServiceWithPortDetails
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//The frequency distribution service has been successfully created with port details.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/clearPMTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//response for clear PM of time distribution service
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/clearPMFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//response for clear PM of freq distribution service
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/activateTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Time distribution service has been successfully activated.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/abortTimeDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Abort the time distribution service was successful.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/service/abortFreqDistributionService
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//Abort the frequency distribution service was successful.
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/pmService/clearTCAProfile
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/pmService/clearTCAProfileForSyncE
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/pmService/associateTCAProfile
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/pmService/associateTCAProfileForSyncE
- Request
  - Schema incompatible
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//invalid input, object invalid
    - New body: 'application/json'
  - Changed response : [201]//search results for given neid
    - Schema
      Changed body: 'application/json'
  - Changed response : [409]//an existing item already exists
    - Schema
      Changed body: 'application/json'
POST/discoveryService/discovery
- Request
  - Schema
    Changed body: 'application/json'
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//Bad request
    - New body: 'application/json'
  - Changed response : [200]//Successfully triggered WS-S Discovery operation
    - Schema
      Changed body: 'application/json'
GET/serviceBrowser/getServiceDetailsById Get Time distribution Service Details By serviceId
- Response
  - Deleted response : [403]//Forbidden
  - Changed response : [400]//bad input parameter
    - New body: 'application/json'
  - Changed response : [200]//Time distribution service details
    - Schema incompatible
      Changed body: 'application/json'
      Missing property: clocks[n].clockdataset[n].currentdataset[n].offsetfrommaster (string)
      Missing property: clocks[n].ptpportdetails[n].masterOnly (string)
      Missing property: clocks[n].ptpportdetails[n].announceMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].announceMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].syncMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].syncMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].delayReqMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].delayReqMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].delayResMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].delayResMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].signalingMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].signalingMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].managementMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].managementMsgRx (string)
      Missing property: clocks[n].ptpportdetails[n].followUpMsgTx (string)
      Missing property: clocks[n].ptpportdetails[n].followUpMsgRx (string)

Application Versions⇑

What's New⇑

What's Deleted⇑

What's Deprecated⇑

What's Changed⇑

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Response

Parameters

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response

Schema incompatible

Response