Api Change Log

Application Versions⇑

Changes between 22.12.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
5. GET/getNeCount Fetches total number of NEs present in system

What's Deleted⇑

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/livepmdata Subscribes to Live PM data for Connections or NEs
4. POST/livepmdata/{userSessionId}/resume Resumes the subscription to start receiving Live PM data
5. POST/livepmdata/{userSessionId}/pause Pauses the subscription to pause receiving Live PM data
6. POST/connection/kpiquery Fetches PM SUTS KPI data for connections
7. GET/livepmdatasessionstatus/{userSessionId} Fetches current status of Live PM session
8. GET/livepmdatasessions Fetches Current and Max Live PM sessions and many other configured system preference settings

What's Deprecated⇑

1. No Changes

What's Changed⇑

1. 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
2. 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
3. GET/downloadreportfile/{profileId}/{fileName}

   • Response

     • Changed response : [400]//Validation errors: Download Failed because of Too many download file requests in processing
4. POST/startJobNowByProfileId

   • Response

     • Deleted response : [400]//Validation error occurred: <br />ErrInStarting: An error occurred while starting the job. This may be due to an invalid or missing profile ID. Please verify the profile ID and try again.
     • 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
5. POST/skipNextRunOfJobByProfileId

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • Deleted response : [400]//Validation errors: <br />The request failed due to invalid input. Common issues include an empty profile ID or an incorrectly formatted request body. Ensure that the profile IDs are valid and correctly specified.
     • 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
6. POST/resumeJobByProfileId

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • Deleted response : [400]//Validation error: <br />The request failed due to invalid input. Common issues include an empty profile ID or an incorrectly formatted request body. Ensure that the `profileIds` array contains valid identifiers.
     • 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
     • Changed response : [500]//Internal Server Error
7. POST/pauseJobByProfileId

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • Deleted response : [400]//Validation errors: <br />The request failed due to invalid input. Common issues include an empty profile ID or an incorrectly formatted request body. Ensure that the `profileIds` array contains valid identifiers.
     • 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
8. DELETE/nbi-streaming/api/v1/subscriptions/{subscriptionId}

   • Response

     • Changed response : [400]//Validation errors: subscriptionId should not be empty. User cannot delete subscription created by others
9. GET/nbi-streaming/api/v1/subscriptions/{subscriptionId}

   • Response

     • Changed response : [400]//Validation errors: subscriptionId should not be empty
10. POST/nbi-streaming/api/v1/subscriptions/{subscriptionId}

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validation errors: Granularity should be 15mins or 24hours in this release. User cannot update subscription created by others. Start time should be a valid timestamp. It cant be very older date time Filter key cannot be empty in neFilter. Filter key under neFilter should be one of [neLabel, addr, loc, rel, type]. Filter value cannot be empty in neFilter. Filter value under neFilter should start with one of keyword [starts, ends, contains] followed by space. subscriptionId should not be empty.
11. POST/nbi-streaming/api/v1/subscriptions/

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [400]//Validation errors: Granularity should be 15mins or 24hours in this release. Start time should be a valid timestamp. It annot be very older date time profileName should not be empty. Filter key cannot be empty in neFilter. Filter key under neFilter should be one of [neLabel, addr, loc, rel, type]. Filter value cannot be empty in neFilter. Filter value under neFilter should start with one of keyword [starts, ends, contains] followed by space. This operation is not allowed for current user.
12. POST/deleteJobByProfileId

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Deleted response : [400]//Validation error occurred. Possible issues include: <br />ErrProfileIdIsEmpty:ProfileId cannot be empty <br />ErrInvalidProfileId: The provided ProfileId does not match any valid scheduled job.
      • 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 : [404]//The resource you were trying to reach is not found
13. GET/readjobstatus/

    • Response

      • Deleted response : [400]//Validation errors: <br />ErrHadoopError:Error in reading data from PM database.
      • 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: '*/*'
14. DELETE/schedulejob/delete/{profileId}

    • Response

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

        • Schema

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

        • Schema

          Changed body: '*/*'
      • Changed response : [401]//You are not authorized to delete 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 : [400]//Validation errors: Profile Id does not exists in DB

        • Schema

          Changed body: '*/*'
15. DELETE/deletereportfile/{profileId}/{fileName}

    • Response

      • Changed response : [200]//Successfully deleted file

        • Schema

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

        • Schema

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: The given file does not exist in the location

        • Schema

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

        • Schema

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

        • Schema

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

    • Request

      • Schema

        Changed body: 'application/json'

    • 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: 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.

        • 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: '*/*'
17. POST/getPortDataForNes/

    • Request

      • Schema

        Changed body: 'application/json'

    • 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
18. PUT/schedulejob/update

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Changed response : [200]//Successfully updated the data

        • Schema

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

        • Schema

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

        • Schema

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

        • 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: '*/*'
19. 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
20. POST/schedulejob/create

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • 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 : [409]//Already a profile with specified Id exists in DB

        • Schema

          Changed body: '*/*'
      • Changed response : [200]//Successfully created CSV report schedule job

        • Schema

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

        • Schema

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

        • Schema

          Changed body: '*/*'
21. POST/ne/exportcompactpdf

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Deleted response : [404]//Error preview failed: Too many ODR requests in processing.
      • 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 : [500]//Internal application error
      • Changed response : [400]//Validtion errors: The given file does not exist in the location Error in generating pdf report
22. POST/ne/export Download PM data as a report for NEs

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Deleted response : [404]//Not Found: The specified EML NE ID is not present in the PM database or too many ODR requests are currently being processed.
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed response : [500]//Internal application error
      • Changed response : [200]//Successfully downloaded data
      • Changed response : [401]//You are not authorized to download the resource
      • Changed response : [400]//Validtion errors: The given file does not exist in the location
23. POST/getcxnspanloss/ Retrieves spanloss for given connections

    • Request

      • Schema

        Changed body: 'application/json'

    • 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: Granularity should be 15mins or 24hours objIds should not be empty and it should contain valid Connection Ids
24. GET/getschedule/{profileId}

    • Response

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

        • Schema

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

        • Schema

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

        • 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 : [400]//Validation errors: ProfileId is not valid, please try with valid profileId

        • Schema

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

    • Response

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

        • Schema

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

        • Schema

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

        • Schema

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

        • Schema

          Changed body: '*/*'
26. POST/ne/query Fetches PM data for NEs

    • Request

      • Schema

        Changed body: 'application/json'

    • 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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
27. POST/ne/nePmData Fetches PM data for NEs

    • Request

      • Schema

        Changed body: 'application/json'

    • 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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'
28. POST/cxn/exportcompactpdf

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Deleted response : [404]//ErrPreviewFailed: <br> Too many ODR requests in processing <br /> The CXN ID is not present in PM DB <br /> The CXN 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]//Validation errors:Internal application error 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: 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 Error in downloading compact pdf report
29. POST/cxn/export Download PM data as a report for connections

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • Deleted response : [404]//The requested connection ID is not found in the PM database or too many ODR requests are being processed. If the issue persists, check the connection ID or contact support for assistance.
      • Changed response : [200]//Successfully downloaded data
      • Changed response : [403]//Accessing the resource you were trying to reach is forbidden
      • Changed 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 : [401]//You are not authorized to download the resource
      • Changed response : [500]//Validation errors:Internal application error Unable to get the report
30. POST/connection/query Fetches PM data for connections

    • Request

      • Schema

        Changed body: 'application/json'

    • 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: Response size exceeded Granularity should be 15mins or 24hours 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

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

        • Schema incompatible

          Changed body: '*/*'
31. POST/connection/cxnPmData Fetches PM data for connections

    • Request

      • Schema

        Changed body: 'application/json'

    • 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

        • Schema incompatible

          Changed body: '*/*'
      • Changed response : [400]//Validation errors: Response size exceeded Granularity should be 15mins or 24hours 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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

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

        • Schema incompatible

          Changed body: '*/*'