Api Change Log

Application Versions⇑

Changes between 23.6 to 23.12

What's New⇑

  1. PUT/data/network/resumeNwReportJob/{jobId}/{jobName} Resume Network Report Job
  2. PUT/data/network/pauseNwReportJob/{jobId}/{jobName} Pause Network Report Job
  3. PUT/data/network/deleteNwReportJob/{jobId} Delete Network Report Job
  4. POST/uncorrelate Un-associate TCA rofile
  5. POST/tcaProfiles Creates TCA profile
  6. POST/tcaProfiles/{tcaId} Modifies TCA Profile
  7. DELETE/tcaProfiles/{tcaId} Deletes TCA
  8. POST/data/otn/node/rearrangeGhost To rearrange connection Ghost channels on a specified Node
  9. POST/data/network/scheduleNwReportJob Schedule Network Report Job
  10. POST/correlate TCA Profile Association
  11. POST/clearbin Clear pm bin from a selected connection
  12. GET/tcaProfiles/ Lists TCA Profiles
  13. GET/data/otn/ne/{neId}/rate/{portRate}/port/{portName}/portParameters Retrieves all port attributes for a specified portName, neId and layerRate
  14. GET/data/otn/connections/{id}/ports Retrieves all ports involved in a connection
  15. GET/data/otn/connections/physical/{nprId}/ports Retrieves all ports involved in a connection
  16. GET/data/npr/generic_ClobData Retrieves the objects in the given table
  17. GET/data/network/nwReports Get Network Reports
  18. GET/data/otn/nwReports Get Network Reports
  19. GET/data/network/generateReport Generate Network Report
  20. GET/data/otn/generateReport Generate Network Report
  21. GET/data/network/downloadReport Download Network Report
  22. GET/data/otn/downloadReport Download Network Report
  23. DELETE/data/network/deleteReport Delete Network Report
  24. DELETE/data/otn/deleteReport Delete Network Report

What's Deleted⇑

  1. POST /data/otn/networkslice/deleteSlice/{sliceId} delete SliceId from all the resources
  2. POST /data/otn/networkslice/connections/{connectionId}/unassignSlice Unassign sliceId from a Connection
  3. POST /data/otn/networkslice/connections/{connectionId}/assignSlice Assign Slice Id to a connection
  4. GET /data/npr/commandLogArchSessions Retrieves the objects in the given table
  5. GET /data/npr/forSessionCommandLogs Retrieves the objects in the given table

What's Deprecated⇑

  1. GET /data/npr/trails/isNeVersion14/{trailId} NeVersion
  2. GET /data/asonNBI/trails/isNeVersion14/{trailId} NeVersion
  3. GET /data/npr/ports/isNeVersion14/{trailId} NeVersion
  4. GET /ason/schedule/isNeVersion14/{trailId} NeVersion
  5. GET /data/npr/physicalConns/timerPm/{connectId}/{pm15}/{pm24} timerPmPhysicalConn
  6. GET /data/swim/anaytics/backupStatus/{period} Fetch NE Types

What's Changed⇑

  1. GET/networkinventory/networkelements/{neType} It is NAD Compliant. Retrieves a list of Network Elements of specified neType(s).

    • Parameters

      • neType in path
  2. GET/networkinventory/equipments/{neType} It is NAD Compliant. Retrieves a list of equipment for Network Elements of specified neType(s).

    • Parameters

      • neType in path
  3. GET/data/otn/node/name

    • Parameters

      • id in query change into required
  4. GET/data/otn/connection/name

    • Parameters

      • id in query change into required
  5. GET/data/otn/connection/id

    • Parameters

      • name in query change into required
  6. GET/data/npr/node/name

    • Parameters

      • id in query change into required
  7. GET/data/npr/ne/name

    • Parameters

      • id in query change into required
  8. GET/data/npr/AdminCommandLogs

    • Parameters

      • Delete ids in path//ids
  9. GET/data/ason/telink/name

    • Parameters

      • id in query change into required
  10. GET/data/ason/srg/name

    • Parameters

      • id in query change into required
  11. GET/data/ason/snc/name

    • Parameters

      • id in query change into required
  12. GET/data/ason/phyconn/name

    • Parameters

      • id in query change into required
  13. GET/data/ason/phyconn/id

    • Parameters

      • name in query change into required
  14. GET/data/ason/npa/name

    • Parameters

      • id in query change into required
  15. GET/data/ason/link/name

    • Parameters

      • id in query change into required
  16. GET/data/otn/darkfiber Get dark fiber connection details.

    • Parameters

      • Add id in query//id is a distinct unique field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add guiLabel in query//guiLabel is a distinct field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add otdrScanStatus in query//otdrScanStatus field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add otdrSupported in query//otdrSupported field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add otdrSummary in query//otdrSummary field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add physLinkAss in query//physLinkAss field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
      • Add kmlLinked in query//kmlLinked field from '/data/otn/darkfiber' or '/data/otn/darkfibers'
  17. POST/data/otn/connections/{id}/cancel

    • Parameters

      • Add requestId in query//requestId
  18. POST/data/otn/connection/renameConnection/ To rename the connection name or the alias for the connection using the connection ID

    • Parameters

      • Delete connId in path//unique Id for the connection, connId can be derived as Id from '/data/otn/connections'
  19. GET/data/otn/schedule/job/name Get OTDR scan job details using the job name.

    • Parameters

      • Add jobname in query// 'jobname' is a unique field from 'esmBrowser/jobList/GetJobListJson/all'
      • Delete name in query//'jobname' is the name of the OTDR scan job for which the details shall be retrieved.
  20. GET/otn/NBI/topoMgmt/TopologicalLinks/{includeInternalLinks} To retrieve all the Internal links

    • Parameters

      • Deprecated XXXX in query//Not Used
  21. DELETE/eqm/prov/{groupId}/{neId}/{neType}/{entityType}/{aid}

    • Parameters

      • neType in path
  22. PUT/eqm/prov/{groupId}/{neId}/{neType}

    • Parameters

      • neType in path
  23. POST/eqm/prov/{groupId}/{neId}/{neType}

    • Parameters

      • neType in path
  24. PUT/eqm/prov/loopBackDetails/{groupId}/{neId}/{neType}/{signalrate}

    • Parameters

      • neType in path
  25. GET/data/otn/tpAvailable

    • Parameters

      • neId in query change into required
      • tpName in query change into required
  26. GET/data/otn/connection/trail

    • Parameters

      • Add accessCtrlDomain in query//'accessCtrlDomain' can be retrieved from '/data/otn/connections' REST call as 'accessCtrlDomain'
      • Add createdByUser in query//'createdByUser' can be retrieved from '/data/otn/connections' REST call as 'createdByUser'
      • Add modifiedBy in query//'modifiedBy' can be retrieved from '/data/otn/connections' REST call as 'modifiedBy'
      • Add modifiedDate in query//'modifiedDate' can be retrieved from '/data/otn/connections' REST call as 'modifiedDate'
      • Add sort in query//'sort' is the query string used for sorting of columns mentioned in the operation description. The syntax is sort=sort(<orderType>columnName). The default case is "ascending" without any order type. For "descending" the order type is '-'
  27. GET/data/otn/connections/trails

    • Parameters

      • Add accessCtrlDomain in query//'accessCtrlDomain' can be retrieved from '/data/otn/connections' REST call as 'accessCtrlDomain'
      • Add createdByUser in query//'createdByUser' can be retrieved from '/data/otn/connections' REST call as 'createdByUser'
      • Add modifiedBy in query//'modifiedBy' can be retrieved from '/data/otn/connections' REST call as 'modifiedBy'
      • Add modifiedDate in query//'modifiedDate' can be retrieved from '/data/otn/connections' REST call as 'modifiedDate'
      • Add sort in query//'sort' is the query string used for sorting of columns mentioned in the operation description. The syntax is sort=sort(<orderType>columnName). The default case is "ascending" without any order type. For "descending" the order type is '-'
  28. GET/data/otn/trails

    • Parameters

      • Add accessCtrlDomain in query//'accessCtrlDomain' can be retrieved from '/data/otn/connections' REST call as 'accessCtrlDomain'
      • Add createdByUser in query//'createdByUser' can be retrieved from '/data/otn/connections' REST call as 'createdByUser'
      • Add modifiedBy in query//'modifiedBy' can be retrieved from '/data/otn/connections' REST call as 'modifiedBy'
      • Add modifiedDate in query//'modifiedDate' can be retrieved from '/data/otn/connections' REST call as 'modifiedDate'
      • Add sort in query//'sort' is the query string used for sorting of columns mentioned in the operation description. The syntax is sort=sort(<orderType>columnName). The default case is "ascending" without any order type. For "descending" the order type is '-'
  29. GET/data/otn/connection/path

    • Parameters

      • Add sort in query//'sort' is the query string used for sorting of columns mentioned in the operation description. The syntax is sort=sort(<orderType>columnName). The default case is "ascending" without any order type. For "descending" the order type is '-'
      • Add createdByUser in query//'createdByUser' can be retrieved from '/data/otn/connections' REST call as 'createdByUser'
      • Add modifiedBy in query//'modifiedBy' can be retrieved from '/data/otn/connections' REST call as 'modifiedBy'
      • Add accessCtrlDomain in query//'accessCtrlDomain' can be retrieved from '/data/otn/connections' REST call as accessCtrlDomain
      • Add lockState in query//'lockState' can be retrieved from '/data/otn/connections' REST call as 'lockState'",required=false
  30. GET/data/otn/connections/paths

    • Parameters

      • Add sort in query//'sort' is the query string used for sorting of columns mentioned in the operation description. The syntax is sort=sort(<orderType>columnName). The default case is "ascending" without any order type. For "descending" the order type is '-'
      • Add createdByUser in query//'createdByUser' can be retrieved from '/data/otn/connections' REST call as 'createdByUser'
      • Add modifiedBy in query//'modifiedBy' can be retrieved from '/data/otn/connections' REST call as 'modifiedBy'
      • Add accessCtrlDomain in query//'accessCtrlDomain' can be retrieved from '/data/otn/connections' REST call as accessCtrlDomain
      • Add lockState in query//'lockState' can be retrieved from '/data/otn/connections' REST call as 'lockState'",required=false
  31. GET/data/otn/connections/affectedConnections to get list of connections on a card or port which are affected by an alarm on the port.Also used to retrieve connections (physical, infrastructure or service) that are associated with node or NE when NE has an issue.

    • Parameters

      • Add serviceType in query//Service Type filter. Current support is only for path type.
  32. GET/data/npr/trails/getHistoricalRoutes/{trailId}

    • Parameters

      • Add historicalRouteId in query//If user wants to get a particular restoration detail, 'historicalRouteId' can be retrieved as 'id' from the REST call - 'data/npr/getHistoricalRoutes/{trailId}'
      • Add fromService in query//'fromService' boolean to be sent true while hitting the REST call from service page
      • Add dataForTimeLine in query//'dataForTimeLine' to be sent true, if events from Timeline wants the configured number of historical records from configuredHistoricalRouteRecordsForTimeLine parameter
  33. GET/data/asonNBI/trails/getHistoricalRoutes/{trailId}

    • Parameters

      • Add historicalRouteId in query//If user wants to get a particular restoration detail, 'historicalRouteId' can be retrieved as 'id' from the REST call - 'data/npr/getHistoricalRoutes/{trailId}'
      • Add fromService in query//'fromService' boolean to be sent true while hitting the REST call from service page
      • Add dataForTimeLine in query//'dataForTimeLine' to be sent true, if events from Timeline wants the configured number of historical records from configuredHistoricalRouteRecordsForTimeLine parameter
  34. GET/data/npr/ports/getHistoricalRoutes/{trailId}

    • Parameters

      • Add historicalRouteId in query//If user wants to get a particular restoration detail, 'historicalRouteId' can be retrieved as 'id' from the REST call - 'data/npr/getHistoricalRoutes/{trailId}'
      • Add fromService in query//'fromService' boolean to be sent true while hitting the REST call from service page
      • Add dataForTimeLine in query//'dataForTimeLine' to be sent true, if events from Timeline wants the configured number of historical records from configuredHistoricalRouteRecordsForTimeLine parameter
  35. GET/ason/schedule/getHistoricalRoutes/{trailId}

    • Parameters

      • Add historicalRouteId in query//If user wants to get a particular restoration detail, 'historicalRouteId' can be retrieved as 'id' from the REST call - 'data/npr/getHistoricalRoutes/{trailId}'
      • Add fromService in query//'fromService' boolean to be sent true while hitting the REST call from service page
      • Add dataForTimeLine in query//'dataForTimeLine' to be sent true, if events from Timeline wants the configured number of historical records from configuredHistoricalRouteRecordsForTimeLine parameter