Api Change Log

Application Versions


Changes between 23.6 to 25.6

What's New


  1. PUT/v1/channels-esnr/tca/acknowledgment API to skip the auto-reversion.
  2. POST/v1/channels API to retrieve OTUk channels.
  3. POST/v1/channels/validate API to perform validation of channels before optimization
  4. POST/v1/channels/optimization-options This API is used to initiate computation of optimization options for channels.
  5. POST/v1/channels/compute-q API to initiate Compute Q for supported channels
  6. POST/v1/channels-esnr/tca-profiles API to retrieve Traffic Channel Assert(TCA) profile group details
  7. POST/v1/channels-esnr/details/profiles-qmargin API to retrieve current and previous profile and qmargin details
  8. POST/v1/channels-esnr/connections/{dataBearerId}/{operation} API to initiate for the profile modification/reversion for the channel.
  9. POST/v1/channels-esnr/active-path/evaluation API to initiate or cancel evaluation for protected channels.
  10. GET/v1/channels/optimization-options/result/{tracking-id} API to retrieve optimization options computed for set of channels using the tracking identifier for operation.
  11. GET/v1/channels/details This API is used to fetch the details associated with a channel.

What's Deleted


  1. POST/v2/channels/jobs/optimizationoptions API To initiate a Optimization Options Request Call (upto max 10 trails)
  2. POST/v2/channels/computeq API to initiate Compute Q for upto 10 channels
  3. GET/v2/channels/{trackingid}/computeq API To Retrive the Result Of ComputeQ Operations using the tracking ID
  4. GET/v2/channels/viewDetails API to fetch the Channels Details
  5. GET/v2/channels/validate API to perform Channels validation for upto 10 channels
  6. GET/v2/channels/list API to Retrieve OTUk Channels
  7. GET/v2/channels/jobs/{jobid}/optimizationoptions API To Retrive the Result Of Optimization Options Operations using the tracking ID

What's Deprecated


  1. No Changes

What's Changed


  1. POST/v1/link/optimize API to Perform Link Optimization for one OMS link
    • Response

      • New response : [403]//Forbidden
      • New response : [408]//Request Timeout
      • New response : [425]//Too Early
      • New response : [504]//Gateway Timeout
      • Changed response : [200]//Instance of all MessageImmediateRespModel.
        • Changed response : [400]//Bad Request. If query param has invalid values.
          • Schema incompatible

            Changed body: '*/*'

            Missing property: error.developerMessage (string)

        • Changed response : [429]//Too Many Requests
          • Schema incompatible

            Changed body: '*/*'

            Missing property: error.developerMessage (string)

        • Changed response : [500]//Internal server error.
          • Schema incompatible

            Changed body: '*/*'

            Missing property: error.developerMessage (string)

    • POST/v1/link/ept/design API is designed to upload a network design file in XML format.
      • Request

        • Schema

          Changed body: 'multipart/form-data'
      • Response

        • New response : [403]//Forbidden
        • New response : [408]//Request Timeout
        • New response : [425]//Too Early
        • New response : [504]//Gateway Timeout
        • Changed response : [200]//Message identifier for polling the operation status and other additional information indicating the file upload status.
          • Changed response : [400]//Bad Request. If query param has invalid values.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [429]//Too Many Requests
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [500]//Internal server error.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

      • POST/v1/link/deploy API to perform link deployment with optimized values on the OMS link.
        • Request

          • Schema incompatible

            Changed body: 'application/json'

            Changed property type: (object -> array)

        • Response

          • New response : [403]//Forbidden
          • New response : [408]//Request Timeout
          • New response : [425]//Too Early
          • New response : [504]//Gateway Timeout
          • Changed response : [200]//Instance of WsoJobCreationStatus.
            • Schema

              Changed body: 'application/json'
          • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [429]//Too Many Requests
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [500]//Internal server error.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

      • POST/v1/data/exports/{entityType}
        • Parameters

          • Add type in query//Type of channels to be fetched, supported values: all,optimizable, maintenance & failed, Applicable only for CO channels
          • Add label in query//Fetch channel data based on the NEs associated with label.label is optional, default will load entire data
        • Request

          • Schema

            Changed body: 'application/json'
        • Response

          • New response : [403]//Forbidden
          • New response : [408]//Request Timeout
          • New response : [425]//Too Early
          • New response : [504]//Gateway Timeout
          • Changed response : [200]//Instance of FileSystemResource.
            • New body: 'application/json'
            • Deleted body: 'text/csv'
          • Changed response : [204]//No Content.
            • New body: 'application/json'
            • Deleted body: 'text/csv'
          • Changed response : [400]//Bad Request
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [429]//Too Many Requests
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [500]//Internal server error.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

      • POST/v1/channels-esnr
        • Parameters

          • Add label in query//Fetch channel data based on the NEs associated with label.label is optional, default will load entire data
        • Request

          • Schema incompatible

            Changed body: 'application/json'
        • Response

          • New response : [403]//Forbidden
          • New response : [408]//Request Timeout
          • New response : [425]//Too Early
          • New response : [504]//Gateway Timeout
          • Changed response : [200]//Collection of Esnr Channels Data.
            • Schema incompatible

              Changed body: 'application/json'

              Changed property type: [n].lastUpdated (integer -> string)

              Changed property type: [n].lastUpdatedQValues (integer -> string)

          • Changed response : [204]//No Content.
            • Schema incompatible

              Changed body: 'application/json'

              Changed property type: [n].lastUpdated (integer -> string)

              Changed property type: [n].lastUpdatedQValues (integer -> string)

          • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [429]//Too Many Requests
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

          • Changed response : [500]//Internal server error.
            • Schema incompatible

              Changed body: '*/*'

              Missing property: error.developerMessage (string)

      • POST/v1/channels-esnr/validate
        • Request

          • Response

            • New response : [403]//Forbidden
            • New response : [408]//Request Timeout
            • New response : [425]//Too Early
            • New response : [504]//Gateway Timeout
            • Changed response : [200]//Collection of Esnr Channel Validation Response.
              • Schema incompatible

                Changed body: 'application/json'
            • Changed response : [400]//Bad Request. If payload does not have any connection identifiers.
              • Schema incompatible

                Changed body: '*/*'

                Missing property: error.developerMessage (string)

            • Changed response : [429]//Too Many Requests
              • Schema incompatible

                Changed body: '*/*'

                Missing property: error.developerMessage (string)

            • Changed response : [500]//Internal server error.
              • Schema incompatible

                Changed body: '*/*'

                Missing property: error.developerMessage (string)

        • POST/v1/channels-esnr/optimization-options
          • Request

            • Response

              • New response : [403]//Forbidden
              • New response : [408]//Request Timeout
              • New response : [425]//Too Early
              • New response : [504]//Gateway Timeout
              • Changed response : [200]//Instance of Wso Async Operation Immediate Response.
                • Changed response : [400]//Bad Request. If payload does not have any connection identifiers or connection identifiers provided in input exceeds maximum supported channels.
                  • Schema incompatible

                    Changed body: '*/*'

                    Missing property: error.developerMessage (string)

                • Changed response : [429]//Too Many Requests
                  • Schema incompatible

                    Changed body: '*/*'

                    Missing property: error.developerMessage (string)

                • Changed response : [500]//Internal server error.
                  • Schema incompatible

                    Changed body: '*/*'

                    Missing property: error.developerMessage (string)

            • POST/v1/channels-esnr/compute-q
              • Request

                • Response

                  • New response : [403]//Forbidden
                  • New response : [408]//Request Timeout
                  • New response : [425]//Too Early
                  • New response : [504]//Gateway Timeout
                  • Changed response : [200]//Instance of Wso Async Operation Immediate Response.
                    • Changed response : [400]//Bad Request. If payload does not have any connection identifiers or connection identifiers provided in input exceeds maximum supported channels.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [429]//Too Many Requests
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [500]//Internal server error.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                • GET/v1/{operation-type}/status/{tracking-id} Fetch operation status by operation type and identifier.
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [408]//Request Timeout
                    • New response : [425]//Too Early
                    • New response : [504]//Gateway Timeout
                    • Changed response : [200]//Instance of WsoAsyncPollingResponse, having details on status of operation.
                      • Schema

                        Changed body: 'application/json'
                    • Changed response : [400]//Bad Request. If operation type parameter has un-supported value.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [429]//Too Many Requests
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [500]//Internal server error.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                • GET/v1/link/{trackingid}/optimize API to get status for link optimization operation.
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [408]//Request Timeout
                    • New response : [425]//Too Early
                    • New response : [504]//Gateway Timeout
                    • Changed response : [200]//Instance of LinkOptimizeRespModel.
                      • Schema

                        Changed body: 'application/json'
                    • Changed response : [400]//Bad Request. If query param has invalid values.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [429]//Too Many Requests
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [500]//Internal server error.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                • GET/v1/link/trailList API to retrieve impacted channels data if optimizations is performed for the OMS link associated with it.
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [408]//Request Timeout
                    • New response : [425]//Too Early
                    • New response : [504]//Gateway Timeout
                    • Changed response : [200]//Instance of TrailValidationFinalResp, gives impacted channels margin details.
                      • Schema

                        Changed body: 'application/json'
                    • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [429]//Too Many Requests
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [500]//Internal server error.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                • GET/v1/link/getAllOMSList Fetch details of all the OMS links.
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [408]//Request Timeout
                    • New response : [425]//Too Early
                    • New response : [504]//Gateway Timeout
                    • Changed response : [200]//Collection of OmsData. Provides details on ports, NE and OTS associated with the OMS links.
                      • Schema

                        Changed body: 'application/json'
                    • Changed response : [400]//Bad Request. If query param has invalid values.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [429]//Too Many Requests
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                    • Changed response : [500]//Internal server error.
                      • Schema incompatible

                        Changed body: '*/*'

                        Missing property: error.developerMessage (string)

                • GET/v1/link/ept/{trackingid}/design API To Track Upload Network Design File Using Tracking ID
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [408]//Request Timeout
                    • New response : [425]//Too Early
                    • New response : [504]//Gateway Timeout
                    • Changed response : [200]//Instance of FileUploadRespModel.
                      • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [429]//Too Many Requests
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [500]//Internal server error.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                  • GET/v1/link/audit/{trackingidentifier}/info API to get audit operation information for OMS link.
                    • Response

                      • New response : [403]//Forbidden
                      • New response : [408]//Request Timeout
                      • New response : [425]//Too Early
                      • New response : [504]//Gateway Timeout
                      • Changed response : [200]//Instance of AuditStatus.
                        • Schema

                          Changed body: 'application/json'
                      • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [429]//Too Many Requests
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [500]//Internal server error.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                  • GET/v1/channels-esnr/details
                    • Response

                      • New response : [403]//Forbidden
                      • New response : [408]//Request Timeout
                      • New response : [425]//Too Early
                      • New response : [504]//Gateway Timeout
                      • Changed response : [200]//Instance of EsnrChannelServerData, having relevant channel data.
                        • New body: 'application/json'
                        • Deleted body: '*/*'
                      • Changed response : [400]//Bad Request. If query param has invalid values.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [429]//Too Many Requests
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [500]//Internal server error.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                  • GET/v1/channels-esnr/optimization-options/result/{jobId} This API is used to retrieve optimization options computed for set of channels using the job identifier
                    • Response

                      • New response : [403]//Forbidden
                      • New response : [408]//Request Timeout
                      • New response : [425]//Too Early
                      • New response : [504]//Gateway Timeout
                      • Changed response : [400]//Bad Request
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [429]//Too Many Requests
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [500]//Internal server error.
                        • Schema incompatible

                          Changed body: '*/*'

                          Missing property: error.developerMessage (string)

                      • Changed response : [200]//Collection of Esnr Optimization Options. Provides details for optimization options for requested channels.
                        • Schema incompatible

                          Changed body: 'application/json'

                          Changed property type: [n].optimizationOptionsData[n].profileId (integer -> string)

                      • Changed response : [204]//No Content.
                        • Schema incompatible

                          Changed body: 'application/json'

                          Changed property type: [n].optimizationOptionsData[n].profileId (integer -> string)