Api Change Log

Application Versions⇑

Changes between 23.12 to 24.6

What's New⇑

What's Deleted⇑

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

What's Deprecated⇑

What's Changed⇑

1. POST/livepmdata/{userSessionId}/resume

   • Response

     • Changed response : [400]//Validation errors: <br /> ErrSessionIdIsEmpty:Session Id should not be empty <br /> ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format <br /> ErrSessionIdIsEmpty:ErrSessionIdNotFound:Session Id is not found <br />
2. POST/livepmdata/{userSessionId}/pause

   • Response

     • Changed response : [400]//Validation errors: <br /> ErrSessionIdIsEmpty:Session Id should not be empty <br /> ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format <br /> ErrSessionIdIsEmpty:ErrSessionIdNotFound:Session Id is not found <br />
3. GET/livepmdatasessionstatus/{userSessionId}

   • Response

     • Changed response : [200]//Successfully fetches status of the Live PM session specified by userSessionId
     • Changed response : [400]//Validation errors: <br /> ErrSessionIdIsEmpty:Session Id should not be empty <br /> ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format <br /> ErrSessionIdIsEmpty:ErrSessionIdNotFound:Session Id is not found <br />
4. GET/downloadreportfile/{profileId}/{fileName}

   • Response

     • Changed response : [400]//Validation errors: <br />Download Failed because of Too many download file requests in processing. <br />ErrProfileIdNotExist:Profile Id does not exist in DB.
5. DELETE/livepmdata/{userSessionId}

   • Response

     • Changed response : [400]//Validation errors: <br /> ErrSessionIdIsEmpty:Session Id should not be empty <br /> ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format <br />
6. PUT/livepmdata/{userSessionId}

   Response

   • Changed response : [400]//Validation errors: <br /> Connection or NE and Port details should not be empty. <br /> ErrConnectionIdIsEmpty:ConnectionID should not be empty. <br /> ErrNeIdIsEmpty:Ne Id should not be empty. <br /> ErrPortLabelIsEmpty:Portlabel should not be empty. <br /> ErrValuesIsEmpty:cnp values should not be empty. <br /> Technology, Metric Group and Metric details in metrics field should not be empty. <br /> ErrMetricsIsEmpty:Metrics should not be empty. <br /> ErrTechnologyIsEmpty:Technology should not be empty. <br /> ErrMetricGroupIsEmpty:Metric Group should not be empty. <br /> ErrMetricsIsEmpty:Metrics should not be empty. <br /> ErrInvalidGranularity:Only 15mins or 24hours granularity is supported in Live PM<br />
7. POST/startJobNowByProfileId

   • Response

     • Changed response : [400]//Validation errors: <br />ErrInStarting:Error in starting this job
8. POST/skipNextRunOfJobByProfileId

   Response

   • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
9. POST/resumeJobByProfileId

   Response

   • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
10. POST/pauseJobByProfileId

    Response

    • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
11. DELETE/nbi-streaming/api/v1/subscriptions/{subscriptionId}

    • Response

      • Changed response : [400]//Validation errors: <br /> subscriptionId should not be empty. <br /> User cannot delete subscription created by others
12. POST/nbi-streaming/api/v1/subscriptions/

    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 cannot 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.
13. POST/livepmdata

    Response

    • Changed response : [400]//Validation errors: <br /> Connection or NE and Port details should not be empty. <br /> Connection ID is not present in PM DB. <br /> The NeID and port is not present in given ConnectionID. <br /> Ports for NE Id is not present in PM DB. <br /> ErrConnectionIdIsEmpty:ConnectionID should not be empty. <br /> ErrNeIdIsEmpty:Ne Id should not be empty. <br /> ErrPortLabelIsEmpty:Portlabel should not be empty. <br /> ErrValuesIsEmpty:cnp values should not be empty. <br /> Technology, Metric Group and Metric details in metrics field should not be empty. <br /> ErrMetricsIsEmpty:Metrics should not be empty. <br /> ErrTechnologyIsEmpty:Technology should not be empty. <br /> ErrMetricGroupIsEmpty:Metric Group should not be empty. <br /> ErrMetricsIsEmpty:Metrics should not be empty. <br /> ErrInvalidGranularity:Only 15mins or 24hours granularity is supported in Live PM
    • Changed response : [200]//Successfully subscribed to Live PM data <br /> <pre> If this API is successful, PMNextGen will start pumping Live PM Data into websocket topic for every sampling frequency<br /> The successful response contains 2 fields:<br /> 1. topic - Websocket topic name <br /> 2. subscription id to be used further in update, pause, resume and delete subscription APIs <br /> Then user has to perform below operations to start receiving Live PM Data: <br /> A. Connect to the websocket "wss://<<WS-NOC Main IP>>:8443/mncpm/connect" <br /> Authorization, Keystore and Truststore should be set properly while connecting to websocket<br /> B. Once connected to websocket, subscribe to topic which you received the name in 'topic' field in this response<br /> and listen for live pm data messages.<br /> Live PM Data messages will be keep coming in the websocket topic in below format:<br /> {"OTN_CONNECTION_63/7/11DPM12-1-11-L1/NEND/Rx":{"gdm":{"dt":"2023-02-01 20:31:40","OPR-AVG":10.0,"OPR-H":10.0,"OPR-L":10.0},"metrics":["OPR-AVG","OPR-H","OPR-L"]},"OTN_CONNECTION_63/8/11DPM12-1-11-L1/NEND/Rx":{"gdm":{"dt":"2023-02-01 20:31:40","OPR-AVG":10.0,"OPR-H":10.0,"OPR-L":10.0},"metrics":["OPR-AVG","OPR-H","OPR-L"]}} <br /> The key format is "Connection Id/Ne Id/PortLabel/Location/Direction". <br /> The metrics field will have the metric name and value for the specified dt timeframe <br /></pre>
14. POST/deleteJobByProfileId

    Response

    • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
15. GET/getreportfiles/{profileId}/{noOfFiles}

    • Response

      • Changed response : [400]//Validation errors: <br />ErrProfileIdNotExist:Profile Id does not exist in DB.
16. POST/ne/exportcompactpdf

    Response

    • Changed response : [400]//Validtion errors: <br />Granularity should be 15mins/24hours <br />File location is not matching the ip address <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 NE 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 generating pdf report <br />Error in reading data from PM database
17. POST/ne/export It is NAD compliant. Download PM data as a CSV report for NEs

    Response

    • Changed response : [400]//Validtion errors: <br />Granularity should be 15mins/24hours <br />Ports for given NE Id is not present. <br />File location is not matching the ip address <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 NE 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
18. POST/ne/query It is NAD compliant. Fetches PM data for NEs

    Response

    • 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
19. POST/cxn/exportpdf

    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 />The CXN ID is not present in PM DB <br /> The CXN ID is not having matching data in PM db <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
20. POST/cxn/exportcompactpdf

    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 <br />Error in downloading compact pdf report<br />Error in reading data from PM database
21. POST/cxn/export

    Response

    • Changed response : [400]//Validation errors: <br />Granularity should be 1min/15mins/24hours/4hr/8/hr/1hr <br />Connection ID is not present in PM DB. <br />NeId and port is not present in given connection ID. <br />NeId is not present for given Connection ID. <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
22. POST/connection/query

    Response

    • 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 />The CXN ID is not present in PM DB <br /> The CXN ID is not having matching data in PM db <br /> ObjIds should not be empty and should contain valid Connection IDs <br />Start date time should be less than end date time
23. POST/connection/kpiquery Fetches PM SUTS KPI data for connections

    • Response

      • 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 in UTC secs <br />End time should be a valid timestamp in UTC secs <br />ObjIds should not be empty and should contain valid Connection IDs <br />Start date time should be in UTC secs and less than end date time in UTC secs
24. POST/connection/cxnPmData

    Response

    • 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 />The CXN ID is not present in PM DB <br /> The CXN ID is not having matching data in PM db <br /> ObjIds should not be empty and should contain valid Connection IDs <br />Start date time should be less than end date time