Api Change Log

Changes from 21.4 to 22.12

What's New⇑

1. POST/connection/cxnPmData Fetches PM data for connections
2. POST/cxn/exportpdf Download PM data as a report for connections
3. POST/getPortDataForNes/ Fetch the port details for the given Network Element IDs.
4. POST/getcxnspanloss/ Retrieves spanloss for given connections
5. POST/hadoop/file Get the NE PM Data stored in specified hadoop file in old hadoop file format. This API is deprecated. This API will be supported till N, N+2 WSNOC Release i.e. R24.1H Alternate API to be used - /mncpm//hadoop/file/{neId} This alternate API Get the specific NE PM Data stored in different files under specified dsts hadoop folder
6. PUT/hadoop/file/{neId} Get the specific NE PM Data stored in different files under specified dsts hadoop folder
7. GET/nbi-streaming/api/v1/subscriptions/ Fetches all details of all scheduled reports
8. POST/nbi-streaming/api/v1/subscriptions/ subscribe
9. GET/nbi-streaming/api/v1/subscriptions/{subscriptionId} getSubscription
10. POST/nbi-streaming/api/v1/subscriptions/{subscriptionId} updateSubscription
11. DELETE/nbi-streaming/api/v1/subscriptions/{subscriptionId} unsubscribe
12. POST/ne/exportpdf Download PM data as a PDF report for NEs
13. POST /ne/missingmappinginfo This API finds all missing mapping info
14. POST/ne/nePmData Fetches PM data for NEs
15. POST/ne/top5/lagUtilization Fetch Top 5 elements having max value for the LAG Utilization
16. POST/ne/top5/{kpiName} Fetch Top 5 elements having max value for the given KPI

What's Deleted⇑

1. GET/getNeTpCount Fetches number of Physical Ports

What's Deprecated⇑

1. GET/getNeCount Fetches total number of NEs present in system

What's Changed⇑

1. GET/getNeCount Fetches total number of NEs present in system

   • Response

     • Changed response : [404]//Communication with WSNOC is failed
2. POST/connection/query

   • Request

     • Schema

       Changed body: 'application/json'
3. POST/cxn/export

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • New response : [400]//Validation errors: Granularity should be 1min/15mins/24hours/4hr/8/hr/1hr File location is not matching the ip Start time should be a valid timestamp End time should be a valid timestamp ObjIds should not be empty and should contain valid Connection IDs Start date time should be less than end date time Sftp details are incorrect, could not connect to sftp server The given file does not exist in the location
     • Changed response : [500]//Validation errors:Internal application error Unable to get the report
4. POST/mdcxnlist Fetch the Connection list from the Meta Data

   • Request

   • Response

     • Changed response : [400]//Validation errors: Request Object cannot be empty Number of Entries field should be always greater than 0 Column name field cannot be empty if sortBy is specified Operation value should be "asc" or "desc" Filter value should not be empty Case Sensitive should be true of false Negation should be either true of false CxnIds should contain valid Connection Ids. ConnectionID should not be empty.
5. POST/ne/export

   • Request

     • Schema

       Changed body: 'application/json'
6. POST/ne/query

   • Request

     • Schema

       Changed body: 'application/json'
7. POST/schedulejob/create

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • Changed response : [400]//Validation errors: Granularity should be 15mins or 24hours in this release Profile Id should contain only Alpha Numeric and Underscore characters Local File location should contain only Alpha Numeric, Eiphen and Underscore characters SFTP details are incorrect hence could not connect to sftp server SFTP File location is not matching the ip:port/path pattern Profile Status should be either active or inactive Duration of data should not be empty Duration of data should have valid value Purge Criteria should be specified Frequency should be set to either daily, weekly, monthly and Yearly. It should not be empty Daily option should be either onetime or reccurence .It should not be null Enter a valid hour and min in onetime field or reccurence field Enter a valid hour and min in daily, weekly, monthly and in yearly fields Start date should be valid End date time should be greater than start time End date time should be greater than current time Sftp field should not be set to "active" or "inactive" Report format version should not be null or empty
     • Changed response : [500]//Internal application error
     • Changed response : [200]//Successfully created CSV report schedule job
8. PUT/schedulejob/update

   • Request

     • Schema incompatible

       Changed body: 'application/json'

   • Response

     • New response : [400]//Validation errors: Granularity should be 15mins or 24hours in this release Profile Id should contain only Alpha Numeric and Underscore characters Local File location should contain only Alpha Numeric, Eiphen and Underscore characters SFTP details are incorrect hence could not able connect to sftp server SFTP File location is not matching the ip:port/path pattern Profile Status should be either active or inactive PmReport Duration of data should not be empty PmReport Duration of data should have valid value Purge Criteria should be specified Frequency should be set to either daily, weekly, monthly and Yearly. It should not be empty Daily option should be either onetime or reccurence .It should not be null Enter a valid hour and min in onetime field, reccurence field Enter a valid hour and min in daily, weekly, monthly and in yearly fields Start date should be valid End date time should be greater than start time End date time should be greater than current time Sftp field should not be set to "active" or "inactive" \n Report format version should not be null or empty
     • Changed response : [500]//Internal application error