Api Change Log

Application Versions⇑

Changes between 24.6.0 to 24.12.0

What's New⇑

1. POST/ne/missingmappinginfo This API finds all missing mapping info
2. POST/ne/exportpdf Download PM data as a PDF report for NEs
3. POST/hadoop/file stores the NE PM DATA under specified dsts hadoop folder
4. POST/cxn/exportpdf Download PM data as a report for connections

What's Deleted⇑

1. No Changes

What's Deprecated⇑

1. No Changes

What's Changed⇑

1. POST/livepmdata/{userSessionId}/pause

   • Response

     • Changed response : [200]//Successfully paused the subscription to pause receiving Live PM data
     • Changed response : [500]//Internal application error
     • 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/getCurrentlyRunningJobsCount

   • Response

     • Changed response : [500]//Internal Server Error
     • Changed response : [404]//The resource you were trying to reach is not found
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [200]//Successfully retrieved data
     • Changed response : [401]//You are not authorized to view the resource
3. GET/livepmdatasessionstatus/{userSessionId}

   • Response

     • Changed response : [500]//Internal application error
     • 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/getCxnCount

   • Response

     • Changed response : [500]//Internal Server Error
     • Changed response : [200]//Successfully retrieved data
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [401]//You are not authorized to view the resource
     • Changed response : [404]//The resource you were trying to reach is not found
5. POST/startJobNowByProfileId

   • Response

     • Changed response : [200]//Successfully retrieved data
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [404]//The resource you were trying to reach is not found
     • Changed response : [500]//Internal Server Error
     • Changed response : [401]//You are not authorized to view the resource
     • Changed response : [400]//Validation errors: <br />ErrInStarting:Error in starting this job
6. POST/skipNextRunOfJobByProfileId

   • Response

     • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [200]//Successfully retrieved data
     • Changed response : [401]//You are not authorized to view the resource
     • Changed response : [500]//Internal Server Error
     • Changed response : [404]//The resource you were trying to reach is not found
7. POST/resumeJobByProfileId

   • Response

     • Changed response : [200]//Successfully retrieved data
     • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [401]//You are not authorized to view the resource
     • Changed response : [404]//The resource you were trying to reach is not found
     • Changed response : [500]//Internal Server Error
8. POST/pauseJobByProfileId

   • Response

     • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
     • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
     • Changed response : [200]//Successfully retrieved data
     • Changed response : [401]//You are not authorized to view the resource
     • Changed response : [404]//The resource you were trying to reach is not found
     • Changed response : [500]//Internal Server Error
9. POST/livepmdata

   • Response

     • Changed response : [500]//Internal application error
     • Changed response : [409]//Max allowed live session count reached
     • Changed response : [404]//Validation errors: <br /> ErrInvalidUserNe : Specified NE involved does not belong to current user domain. <br /> ErrInvalidUserNes : Some of NEs involved does not belong to current user domain. <br /> ErrInvalidUserCxns : Some of CXNs involved does not belong to current user domain. <br /> ErrInvalidUserCxn : Specified CXN involved does not belong to current user domain
10. POST/deleteJobByProfileId

    • Response

      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [500]//Internal Server Error
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [400]//Validation errors: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty
      • Changed response : [404]//The resource you were trying to reach is not found
11. GET/readjobstatus/

    • Response

      • Changed response : [400]//Validation errors: <br />ErrHadoopError:Error in reading data from PM database.

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
      • Changed response : [200]//Successfully retrieved data

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
12. GET/livepmdatasessions

    • Response

      • Changed response : [500]//Internal application error

        • Schema incompatible

          Changed body: '*/*'
      • Changed response : [200]//Successfully retrieved Live Pm Sessions data

        • Schema incompatible

          Changed body: '*/*'
13. DELETE/schedulejob/delete/{profileId}

    • Response

      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully Deleted data
      • Changed response : [401]//You are not authorized to delete the resource
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [404]//The resource you were trying to reach is not found
14. DELETE/deletereportfile/{profileId}/{fileName}

    • Response

      • Changed response : [200]//Successfully deleted file
      • Changed response : [500]//Internal application error
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to delete the resource
15. POST/mdcxnlist

    • Response

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

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
      • 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.

        • Schema incompatible

          Changed body: '*/*'
      • Changed response : [500]//Internal Server Error

        • Schema incompatible

          Changed body: '*/*'
      • Changed response : [200]//Successfully retrieved data

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
16. POST/getPortDataForNes/

    • Response

      • Changed response : [500]//Internal Server Error
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [404]//The resource you were trying to reach is not found
      • Changed response : [401]//You are not authorized to view the resource
17. PUT/schedulejob/update

    • Response

      • Changed response : [200]//Successfully updated the data
      • 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
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [404]//The resource you were trying to reach is not found
      • Changed response : [500]//Internal application error
18. PUT/hadoop/file/{neId}

    • Response

      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [404]//The resource you were trying to reach is not found
19. POST/schedulejob/create

    • Response

      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [404]//The resource you were trying to reach is not found
      • Changed response : [409]//Already a profile with specified Id exists in DB
      • Changed response : [200]//Successfully created CSV report schedule job
      • Changed response : [400]//Validation errors:<br /> Granularity should be 15mins or 24hours <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
      • Changed response : [500]//Internal application error
20. POST/ne/exportcompactpdf

    • Response

      • Changed response : [200]//Successfully PDF export done
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to download the resource
      • Changed response : [404]//ErrPreviewFailed: Too many ODR requests in processing
      • Changed response : [500]//Internal application error
21. POST/ne/export

    • Response

      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [500]//Internal application error
      • Changed response : [404]//ErrPreviewFailed: Too many ODR requests in processing
      • Changed response : [200]//Successfully downloaded data
      • Changed response : [401]//You are not authorized to download the resource
22. POST/getcxnspanloss/

    • Response

      • Changed response : [401]//You are not authorized to download the resource
      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully found the spanloss KPI values for given connection ids
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • 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
23. GET/getschedule/{profileId}

    • Response

      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [500]//Internal application error
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [404]//The resource you were trying to reach is not found
      • Changed response : [400]//Validation errors: <br />ProfileId is not valid, please try with valid profileId
24. GET/getallschedules

    • Response

      • Changed response : [500]//Internal application error
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
25. POST/ne/query

    • Response

      • Deleted response : [404]//Errors: <br>The NE ID is not present in PM DB <br /> The NE ID is not having matching data in PM dB
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [500]//Internal application error
26. POST/ne/nePmData

    • Response

      • Deleted response : [404]//Errors: <br>The NE ID is not present in PM DB <br /> The NE ID is not having matching data in PM dB
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [500]//Internal application error
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [200]//Successfully retrieved data
27. POST/cxn/exportcompactpdf

    • Response

      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [404]//ErrPreviewFailed: Too many ODR requests in processing
      • Changed response : [500]//Validation errors: <br />Internal application error <br />Unable to get the report
      • Changed response : [200]//Successfully downloaded data
      • Changed response : [401]//You are not authorized to download the resource
      • 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
28. POST/cxn/export

    • Response

      • Changed response : [200]//Successfully downloaded data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • 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
      • Changed response : [401]//You are not authorized to download the resource
      • Changed response : [404]//ErrPreviewFailed: Too many ODR requests in processing
      • Changed response : [500]//Validation errors: <br />Internal application error <br />Unable to get the report
29. POST/connection/query

    • Response

      • Deleted response : [404]//Errors: <br>The CXN ID is not present in PM DB <br /> The CXN ID is not having matching data in PM db
      • 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
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [500]//Internal application error
30. POST/connection/kpiquery

    • Response

      • Changed response : [401]//You are not authorized to view the resource
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully retrieved data
31. POST/connection/cxnPmData

    • Response

      • Deleted response : [404]//Errors: <br>The CXN ID is not present in PM DB <br /> The CXN ID is not having matching data in PM db
      • Changed response : [401]//You are not authorized to view the resource
      • 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
      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully retrieved data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden