Api Change Log

Application Versions


Changes between 24.6 to 25.6

What's New


  1. No Changes

What's Deleted


  1. No Changes

What's Deprecated


  1. No Changes

What's Changed


  1. PUT/v1/channels-esnr/tca/acknowledgment
    • Response

      • New response : [403]//Forbidden
      • New response : [408]//Request Timeout
      • New response : [425]//Too Early
      • New response : [429]//Too Many Requests
      • New response : [504]//Gateway Timeout
      • Deleted response : [412]//Precondition Failed. If the deployment state of the NE is not in Needs Reversion state.
      • Changed response : [202]//Threshold Crossing Alert Acknowledgment Accepted.
    • POST/v1/link/optimize API to Perform Link Optimization for one OMS link
      • Response

        • New response : [403]//Forbidden
        • New response : [425]//Too Early
        • Changed response : [200]//Instance of all MessageImmediateRespModel.
          • Changed response : [400]//Bad Request. If query param has invalid values.
            • Changed response : [500]//Internal server error.
          • 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 : [425]//Too Early
              • 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.
                  • Changed response : [500]//Internal server error.
                • POST/v1/link/deploy API to perform link deployment with optimized values on the OMS link.
                  • Response

                    • New response : [403]//Forbidden
                    • New response : [425]//Too Early
                    • 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.
                      • Changed response : [500]//Internal server error.
                    • POST/v1/channels
                      • Response

                        • New response : [403]//Forbidden
                        • New response : [408]//Request Timeout
                        • New response : [425]//Too Early
                        • New response : [429]//Too Many Requests
                        • New response : [504]//Gateway Timeout
                        • Changed response : [200]//Collection of Channels Protected List Response.
                      • POST/v1/channels/validate
                        • Request

                          • Response

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

                                Changed body: 'application/json'
                        • POST/v1/channels/optimization-options This API is used to initiate computation of optimization options for channels.
                          • Request

                            • Response

                              • New response : [403]//Forbidden
                              • New response : [408]//Request Timeout
                              • New response : [425]//Too Early
                              • New response : [429]//Too Many Requests
                              • New response : [504]//Gateway Timeout
                              • Changed response : [200]//Instance of Wso Job Response.
                            • POST/v1/channels/compute-q
                              • Request

                                • Response

                                  • New response : [403]//Forbidden
                                  • New response : [408]//Request Timeout
                                  • New response : [425]//Too Early
                                  • New response : [429]//Too Many Requests
                                  • New response : [504]//Gateway Timeout
                                  • Changed response : [200]//Instance of Wso Async Operation Immediate Response.
                                • POST/v1/channels-esnr
                                  • Response

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

                                        Changed body: 'application/json'
                                    • Changed response : [204]//No Content.
                                      • Schema

                                        Changed body: 'application/json'
                                • POST/v1/channels-esnr/validate
                                  • Request

                                    • Response

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

                                          Changed body: 'application/json'
                                  • POST/v1/channels-esnr/optimization-options
                                    • Request

                                      • Response

                                        • New response : [403]//Forbidden
                                        • New response : [408]//Request Timeout
                                        • New response : [425]//Too Early
                                        • New response : [429]//Too Many Requests
                                        • New response : [504]//Gateway Timeout
                                        • Changed response : [200]//Instance of Wso Async Operation Immediate Response.
                                      • POST/v1/channels-esnr/compute-q
                                        • Request

                                          • Response

                                            • New response : [403]//Forbidden
                                            • New response : [408]//Request Timeout
                                            • New response : [425]//Too Early
                                            • New response : [429]//Too Many Requests
                                            • New response : [504]//Gateway Timeout
                                            • Changed response : [200]//Instance of Wso Async Operation Immediate Response.
                                          • 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 : [429]//Too Many Requests
                                              • 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.
                                            • GET/v1/link/{trackingid}/optimize API to get status for link optimization operation.
                                              • Response

                                                • New response : [403]//Forbidden
                                                • New response : [425]//Too Early
                                                • Changed response : [200]//Instance of LinkOptimizeRespModel.
                                                  • Schema

                                                    Changed body: 'application/json'
                                                • Changed response : [400]//Bad Request. If query param has invalid values.
                                                  • Changed response : [500]//Internal server error.
                                                • 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 : [425]//Too Early
                                                    • 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.
                                                      • Changed response : [500]//Internal server error.
                                                    • GET/v1/link/getAllOMSList Fetch details of all the OMS links.
                                                      • Response

                                                        • New response : [403]//Forbidden
                                                        • New response : [425]//Too Early
                                                        • 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.
                                                          • Changed response : [500]//Internal server error.
                                                        • GET/v1/link/ept/{trackingid}/design API To Track Upload Network Design File Using Tracking ID
                                                          • Response

                                                            • New response : [403]//Forbidden
                                                            • New response : [425]//Too Early
                                                            • Changed response : [200]//Instance of FileUploadRespModel.
                                                              • Changed response : [400]//Bad Request. If payload or any query params has invalid values.
                                                                • Changed response : [500]//Internal server error.
                                                              • GET/v1/link/audit/{trackingidentifier}/info API to get audit operation information for OMS link.
                                                                • Response

                                                                  • New response : [403]//Forbidden
                                                                  • New response : [425]//Too Early
                                                                  • 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.
                                                                    • Changed response : [500]//Internal server error.
                                                                  • GET/v1/channels/details This API is used to fetch the details associated with a channel.
                                                                    • Response

                                                                      • New response : [403]//Forbidden
                                                                      • New response : [408]//Request Timeout
                                                                      • New response : [425]//Too Early
                                                                      • New response : [429]//Too Many Requests
                                                                      • New response : [504]//Gateway Timeout
                                                                      • Changed response : [200]//Instance of ChannelServerDetails, having relevant channel data.
                                                                        • New body: 'application/json'
                                                                        • Deleted body: '*/*'
                                                                      • Changed response : [400]//Bad Request. If query param has invalid value.
                                                                    • GET/v1/channels-esnr/details
                                                                      • Response

                                                                        • New response : [403]//Forbidden
                                                                        • New response : [408]//Request Timeout
                                                                        • New response : [425]//Too Early
                                                                        • New response : [429]//Too Many Requests
                                                                        • New response : [504]//Gateway Timeout
                                                                        • Deleted response : [204]//No content
                                                                        • Changed response : [200]//Instance of EsnrChannelServerData, having relevant channel data.
                                                                          • New body: 'application/json'
                                                                          • Deleted body: '*/*'
                                                                    • GET/v1/channels/optimization-options/result/{tracking-id} API to retrieve optimization options computed for set of channels using the tracking identifier for operation.
                                                                      • Response

                                                                        • New response : [400]//Bad Request
                                                                        • New response : [403]//Forbidden
                                                                        • New response : [408]//Request Timeout
                                                                        • New response : [425]//Too Early
                                                                        • New response : [429]//Too Many Requests
                                                                        • New response : [504]//Gateway Timeout
                                                                        • Changed response : [200]//Collection of MarginOptimizationOptions. 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)

                                                                    • 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 : [400]//Bad Request
                                                                        • New response : [403]//Forbidden
                                                                        • New response : [408]//Request Timeout
                                                                        • New response : [425]//Too Early
                                                                        • New response : [429]//Too Many Requests
                                                                        • New response : [504]//Gateway Timeout
                                                                        • 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)