Changelog

WS-NOC Versions⇑

Changes from 22.12 to 23.6.0

What's New

1. PUT /livepmdata/{userSessionId} Updates the subscription to retrieve the Live PM data for Connections or NEs
2. DELETE /livepmdata/{userSessionId} Unsubscribes to stop receiving the Live PM data
3. POST /ne/queryWithDetails Fetches PM data for NEs
4. POST /livepmdata Subscribes to Live PM data for Connections or NEs
5. POST /livepmdata/{userSessionId}/resume Resumes the subscription to start receiving Live PM data
6. POST /livepmdata/{userSessionId}/pause Pauses the subscription to pause receiving Live PM data
7. POST /connection/queryWithDetails Fetches PM data for connections
8. GET /livepmdatasessions Fetches Current and Max Live PM sessions and many other configured system preference settings

What's Deleted

What's Deprecated

1. POST /ne/missingmappinginfo This API finds all missing mapping info

What's Changed

1. POST /getCurrentlyRunningJobsCount Fetches the current job count
2. GET /getNeCount
3. GET /downloadreportfile/{profileId}/{fileName}

   • Response

     • Changed response : [400]//Validation errors: <br />Download Failed because of Too many download file requests in processing
4. GET /nbi-streaming/api/v1/subscriptions/ Fetches all details of all NBI forwarding subscriptions
5. POST /nbi-streaming/api/v1/subscriptions/ Creates new NBI forwarding subscription for PM Data with given filters

   • Response

     • Changed response : [400]//Validation errors: <br /> Granularity should be 15mins or 24hours in this release. <br /> Start time should be a valid timestamp. It annot be very older date time<br /> profileName should not be empty. <br /> Filter key cannot be empty in neFilter. <br /> Filter key under neFilter should be one of [neLabel, addr, loc, rel, type]. <br /> Filter value cannot be empty in neFilter. <br /> Filter value under neFilter should start with one of keyword [starts, ends, contains] followed by space. <br /> This operation is not allowed for current user.
6. DELETE/nbi-streaming/api/v1/subscriptions/{subscriptionId} Stops and unsubscribes NBI forwarding for given subscription id

   • Response

     • Changed response : [400]//Validation errors: <br /> subscriptionId should not be empty. <br />User cannot delete subscription created by others
7. GET/nbi-streaming/api/v1/subscriptions/{subscriptionId} Fetches all details of specified NBI forwarding subscription

   • Response

     • Changed response : [400]//Validation errors: <br /> subscriptionId should not be empty
8. POST/nbi-streaming/api/v1/subscriptions/{subscriptionId} Updates the subscription details for given subscription id

   • Response

     • Changed response : [400]//Validation errors: <br /> Granularity should be 15mins or 24hours in this release. <br /> User cannot update subscription created by others. <br /> Start time should be a valid timestamp. It cant be very older date time <br /> Filter key cannot be empty in neFilter. <br /> Filter key under neFilter should be one of [neLabel, addr, loc, rel, type]. <br /> Filter value cannot be empty in neFilter. <br /> Filter value under neFilter should start with one of keyword [starts, ends, contains] followed by space. <br /> subscriptionId should not be empty.
9. DELETE/schedulejob/delete/{profileId}

   • Response

     • Changed response : [400]//Validation errors: <br /> Profile Id does not exists in DB
10. DELETE//deletereportfile/{profileId}/{fileName}

    • Response

      • Changed response : [400]//Validation errors: <br />The given file does not exist in the location
11. POST/ne/top5/{kpiName} Fetch Top 5 elements for the given KPI
12. POST/ne/top5/lagUtilization Fetch Top 5 elements for the LAG Utilization
13. POST/mdcxnlist

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

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

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validation errors: <br /> Granularity should be 15mins or 24hours in this release <br /> Profile Id should contain only Alpha Numeric and Underscore characters <br /> Local File location should contain only Alpha Numeric, Eiphen and Underscore characters <br /> SFTP details are incorrect hence could not able connect to sftp server <br /> SFTP File location is not matching the ip:port/path pattern <br /> Profile Status should be either active or inactive <br /> PmReport Duration of data should not be empty <br /> PmReport Duration of data should have valid value <br /> Purge Criteria should be specified <br /> Frequency should be set to either daily, weekly, monthly and Yearly. It should not be empty <br /> Daily option should be either onetime or reccurence .It should not be null <br /> Enter a valid hour and min in onetime field, reccurence field <br /> Enter a valid hour and min in daily, weekly, monthly and in yearly fields <br /> Start date should be valid <br /> End date time should be greater than start time <br /> End date time should be greater than current time <br /> Sftp field should not be set to "active" or "inactive" <br /> Report format version should not be null or empty
15. PUT/hadoop/file/{neId} stores specific NE PM Data in different files under specified dsts hadoop folder
16. POST/schedulejob/create

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

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

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validtion errors: <br />The given file does not exist in the location
18. POST/ne/exportpdf

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validtion errors: <br />The given file does not exist in the location <br />Error in generating pdf report
19. POST/ne/exportcompactpdf

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validtion errors: <br />The given file does not exist in the location <br />Error in generating pdf report
20. POST/hadoop/file stores the NE PM DATA under specified dsts hadoop folder
21. POST/getcxnspanloss/

    • Response

      • Changed response : [400]//Validation errors: <br />Granularity should be 15mins or 24hours <br />objIds should not be empty and it should contain valid Connection Ids
22. GET/getschedule/{profileId}

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: <br />ProfileId is not valid, please try with valid profileId

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [404]//The resource you were trying to reach is not found

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'
23. GET/getallschedules

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'
24. POST/ne/query

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: <br />Response size exceeded Granularity should be 15mins or 24hours <br />File location is not matching the ip <br />Start time should be a valid timestamp <br />End time should be a valid timestamp <br />NE ID should not be empty <br />Start date time should be less than end date time <br />Sftp details are incorrect, could not connect to sftp server

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'
25. POST/ne/nePmData

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: <br />Response size exceeded <br />Granularity should be 15mins or 24hours <br />File location is not matching the ip <br />Start time should be a valid timestamp <br />End time should be a valid timestamp <br />NE ID should not be empty <br />Start date time should be less than end date time <br />Sftp details are incorrect, could not connect to sftp server

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'
26. POST/cxn/export

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

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

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

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

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

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

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validtion errors: <br />Response size exceeded <br />Granularity should be 15mins or 24hours <br />File location is not matching the ip <br />Start time should be a valid timestamp <br />End time should be a valid timestamp <br />ObjIds should not be empty and should contain valid Connection IDs <br />Start date time should be less than end date time

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'
30. POST /connection/cxnPmData

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [200]//Successfully retrieved data

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: <br />Response size exceeded <br />Granularity should be 15mins or 24hours <br />File location is not matching the ip <br />Start time should be a valid timestamp <br />End time should be a valid timestamp <br />ObjIds should not be empty and should contain valid Connection IDs <br />Start date time should be less than end date time

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to view the resource

        • Schema

          Changed body: '*/*'
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden

        • Schema

          Changed body: '*/*'
      • Changed response : [500]//Internal application error

        • Schema

          Changed body: '*/*'