Api Change Log

Application Versions⇑

Changes between 24.6.0 to 25.12.0

What's New⇑

GET/nbi-streaming/api/v1/subscriptions/{subscriptionId}/ Fetches all details of specified NBI forwarding subscription
POST/nbi-streaming/api/v1/subscriptions/{subscriptionId}/ Updates the subscription details for given subscription id
DELETE/nbi-streaming/api/v1/subscriptions/{subscriptionId}/ Stops and unsubscribes NBI forwarding for given subscription id
POST/nbi-streaming/api/v1/subscriptions Creates new NBI forwarding subscription for PM Data with given filters
GET/getallschedules/ Fetch the details of all scheduled CSV reports
GET/connection/tps It is NAD compliant. Fetches Endpoints or all TPs for connections

What's Deleted⇑

PUT~~/hadoop/file/{neId}~~ stores specific NE PM Data in different files under specified dsts hadoop folder
POST~~/ne/top5/{kpiName}~~ Fetch Top 5 elements for the given KPI
POST~~/ne/top5/lagUtilization~~ Fetch Top 5 elements having maximum LAG Utilization
POST~~/ne/missingmappinginfo~~ This API finds all missing mapping info
POST~~/ne/exportpdf~~ Download PM data as a PDF report for NEs
POST~~/hadoop/file~~ stores the NE PM DATA under specified dsts hadoop folder
POST~~/cxn/exportpdf~~ Download PM data as a report for connections

What's Deprecated⇑

No Changes

What's Changed⇑

POST/livepmdata/{userSessionId}/pause
- Response
 - Changed response : [200]//Successfully paused the subscription to stop receiving Live PM data.
 - Changed response : [400]//Validation errors occurred. Possible issues include: ErrSessionIdIsEmpty:Session Id should not be empty ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format ErrSessionIdIsEmpty:ErrSessionIdNotFound:Session Id is not found 
 - Changed response : [500]//An internal application error occurred while processing the request.
POST/getCurrentlyRunningJobsCount
- Response
  - Changed response : [200]//Successfully retrieved the count of currently scheduled jobs.
  - Changed response : [401]//Unauthorized: You are not authorized to view the resource. Please check your authentication details.
  - Changed response : [403]//Forbidden: You do not have the necessary permissions to access the resource.
  - Changed response : [404]//Not Found: The resource you were trying to reach is not found. Ensure that the endpoint and request parameters are correct.
  - Changed response : [500]//Internal Server Error: An error occurred on the server side, preventing the completion of your request.
GET/livepmdatasessionstatus/{userSessionId}
- Response
 - Changed response : [400]//Validation errors occurred. Possible errors include: ErrSessionIdIsEmpty:Session Id should not be empty ErrSessionIdIsEmpty:ErrInvalidSessionId:Invalid Session Id format ErrSessionIdIsEmpty:ErrSessionIdNotFound:Session Id is not found 
 - Changed response : [500]//Internal server error occurred while fetching the Live PM session status
GET/getCxnCount
- Response
  - Changed response : [200]//Successfully retrieved the total count of Physical, Infra, and Service connections.
  - Changed response : [401]//Unauthorized: You do not have the necessary permissions to view the connection count.
  - Changed response : [403]//Forbidden: Access to the requested resource is restricted.
  - Changed response : [404]//Not Found: The requested resource could not be found. This may indicate an issue with the API endpoint or the system is unable to process the request at this time.
  - Changed response : [500]//Internal Server Error: An unexpected error occurred while fetching the connection count. Please try again later.
POST/startJobNowByProfileId
- Response
 - Changed response : [200]//Successfully initiated the CSV report generation for the specified profile ID. The response will include details confirming the operation's success.
 - Changed response : [400]//Validation error occurred: 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 : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure you are logged in and have the necessary permissions to access this resource.
 - Changed response : [403]//Forbidden access: The server understands the request but refuses to authorize it. Check your permissions for accessing this resource.
 - Changed response : [404]//Resource not found: The specified profile ID does not exist in the system. Double-check the profile ID for accuracy.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred during the operation. Please try again later. If the issue persists, contact support.
POST/skipNextRunOfJobByProfileId
- Response
 - Changed response : [200]//Successfully skipped the next scheduled execution for the specified job(s). The response includes confirmation and details of which job profiles were successfully skipped.
 - Changed response : [400]//Validation errors: 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 : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure that you are logged in and have the necessary permissions to perform this operation.
 - Changed response : [403]//Forbidden access: The server understood the request but refuses to authorize it. Verify your user permissions and roles to ensure you have access to this resource.
 - Changed response : [404]//Resource not found: The specified profile ID does not exist. Check the profile IDs provided for accuracy and ensure they are active within the system.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred during the operation. Please try again later. If the issue persists, contact support for further assistance.
POST/resumeJobByProfileId
- Response
 - Changed response : [200]//Successfully resumed the scheduled job(s). The response includes confirmation and details about which job profiles were successfully resumed.
 - Changed response : [400]//Validation error: 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 : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure you are logged in with the necessary permissions to perform this operation.
 - Changed response : [403]//Forbidden access: The server understood the request but refuses to authorize it. Verify your user permissions to ensure you have access to this resource.
 - Changed response : [404]//Resource not found: The specified profile ID does not exist. Check the provided profile IDs for accuracy and ensure they correspond to active profiles in the system.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred during the operation. Please try again later, and if the issue persists, contact support for further assistance.
POST/pauseJobByProfileId
- Response
 - Changed response : [200]//Successfully paused the scheduled job(s). The response includes confirmation and details about which job profiles were successfully paused.
 - Changed response : [400]//Validation errors: 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 : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure you are logged in with the necessary permissions to perform this operation.
 - Changed response : [403]//Forbidden access: The server understood the request but refuses to authorize it. Verify your user permissions to ensure you have access to this resource.
 - Changed response : [404]//Resource not found: The specified profile ID does not exist. Check the provided profile IDs for accuracy and ensure they correspond to active profiles in the system.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred during the operation. Please try again later, and if the issue persists, contact support for further assistance.
POST/livepmdata
- Response
 - Changed response : [404]//Validation errors occurred indicating that specified resources do not belong to the current user domain: ErrInvalidUserNe : Specified NE involved does not belong to current user domain. ErrInvalidUserNes : Some of NEs involved does not belong to current user domain. ErrInvalidUserCxns : Some of CXNs involved does not belong to current user domain. ErrInvalidUserCxn : Specified CXN involved does not belong to current user domain
 - Changed response : [409]//Conflict: Maximum allowed live session count has been reached. Please unsubscribe from some active sessions before creating new subscriptions.
 - Changed response : [500]//Internal application error: An unexpected error occurred while processing your request. Please try again later or contact support.
POST/deleteJobByProfileId
- Response
 - Changed response : [200]//Successfully deleted the scheduled jobs. The response includes the count of jobs that were successfully deleted from the scheduler.
 - Changed response : [400]//Validation error occurred. Possible issues include: ErrProfileIdIsEmpty:ProfileId cannot be empty ErrInvalidProfileId: The provided ProfileId does not match any valid scheduled job.
 - Changed response : [401]//User is not authorized to perform this action. Ensure you have the necessary permissions to delete jobs from the PM scheduler.
 - Changed response : [403]//Access to the resource is forbidden. You may lack permission to delete scheduled jobs in the PM scheduler.
 - Changed response : [404]//The requested resource (ProfileId or scheduled job) was not found. The provided ProfileId may not exist in the system or is not associated with any active jobs
 - Changed response : [500]//Internal server error occurred while processing the request. This could be due to issues with the backend services that manage the PM scheduler.
GET/readjobstatus/
- Response
 - Changed response : [200]//Successfully retrieved the current status of all scheduled CSV reports.
 - Schema
 Changed body: '*/*'
 - Changed response : [400]//Validation errors: ErrHadoopError:Error in reading data from PM database.
 - Schema
 Changed body: '*/*'
 - Changed response : [401]//Unauthorized: You do not have the necessary permissions to view the resource.
 - Schema
 Changed body: '*/*'
 - Changed response : [403]//Forbidden: Access to the resource is restricted
 - Schema
 Changed body: '*/*'
 - Changed response : [500]//Internal server error: An unexpected error occurred while processing the request.
 - Schema
 Changed body: '*/*'
GET/livepmdatasessions
- Response
  - Changed response : [200]//Successfully retrieved data on current and maximum Live PM sessions, along with system preference settings.
    - Schema
      Changed body: '*/*'
  - Changed response : [500]//Internal server error occurred while retrieving the data.
    - Schema
      Changed body: '*/*'
DELETE/schedulejob/delete/{profileId}
- Response
  - Changed response : [200]//Successfully deleted the scheduled CSV report job profile from the database.
  - Changed response : [401]//Unauthorized: The user does not have the necessary permissions to delete the resource. Please check your authorization level.
  - Changed response : [403]//Forbidden: Access to the resource is denied due to insufficient privileges or other restrictions.
  - Changed response : [404]//Not Found: The resource you were trying to reach is not present.
  - Changed response : [500]//Internal Server Error: An unexpected error occurred while processing the request. Please try again later or contact support.
DELETE/deletereportfile/{profileId}/{fileName}
- Response
  - Changed response : [200]//Successfully deleted the specified CSV report file.
  - Changed response : [401]//Unauthorized: You do not have the necessary permissions to delete the specified file.
  - Changed response : [403]//Forbidden: Access to the requested resource is restricted.
  - Changed response : [500]//Internal Server Error: An unexpected error occurred while attempting to delete the file. Please try again later.
POST/mdcxnlist
- Response
 - Changed response : [200]//Successfully retrieved the connection list based on the specified filters.
 - Schema
 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
 Changed body: '*/*'
 - Changed response : [401]//Unauthorized access: You do not have permission to view this resource.
 - Schema
 Changed body: '*/*'
 - Changed response : [403]//Forbidden: Accessing the requested resource is forbidden.
 - Schema
 Changed body: '*/*'
 - Changed response : [404]//Not Found: The resource you were trying to access does not exist.
 - Schema
 Changed body: '*/*'
 - Changed response : [500]//Internal Server Error: An unexpected error occurred while processing your request.
 - Schema
 Changed body: '*/*'
POST/getPortDataForNes/
- Response
  - Changed response : [200]//Successfully retrieved port details for the given Network Element IDs.
  - Changed response : [401]//Unauthorized: You are not authorized to view the resource. Please check your credentials or permissions.
  - Changed response : [403]//Forbidden: Accessing the resource is forbidden. You might not have the necessary permissions.
  - Changed response : [404]//Not Found: The specified Network Element IDs were not found in the system or do not exist.
  - Changed response : [500]//Internal Server Error: An error occurred on the server side. Please try again later.
PUT/schedulejob/update
- Request
 - Schema incompatible
 Changed body: 'application/json'
- Response
 - Changed response : [200]//The data was successfully updated, confirming that the scheduled job modifications have been applied correctly
 - Changed response : [400]//Validation errors occurred due to incorrect input. Ensure that the following criteria are met: 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" Report format version should not be null or empty
 - Changed response : [401]//Unauthorized access: You do not have the necessary permissions to view or modify this resource.
 - Changed response : [403]//Forbidden: You are attempting to access a resource that you do not have permission to access.
 - Changed response : [404]//Not Found: The requested resource could not be found on the server. Please check the URL and try again.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred within the application. Please try again later, and contact support if the issue persists.
POST/schedulejob/create
- Request
 - Schema
 Changed body: 'application/json'
- Response
 - Changed response : [200]//Successfully created a CSV report schedule job. The response includes confirmation of the scheduled job and any relevant details.
 - Changed response : [400]//Validation errors occurred. Granularity should be 15mins or 24hours 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 : [403]//Accessing the requested resource is forbidden. Ensure that you possess the correct permissions to perform this action.
 - Changed response : [404]//The resource you attempted to access could not be found. Please verify the parameters or resource IDs provided.
 - Changed response : [409]//A profile with the specified ID already exists in the database. Please choose a different profile ID to avoid conflicts.
 - Changed response : [500]//An internal application error occurred. This unexpected issue may require a retry later. If the problem persists, please contact support for assistance.
POST/ne/exportcompactpdf
- Response
  - Changed response : [200]//Successfully generated compact PDF report.
  - Changed response : [401]//Unauthorized access: The user is not authorized to download the resource.
  - Changed response : [403]//Forbidden access: Accessing the resource you were trying to reach is forbidden.
  - Changed response : [404]//Error preview failed: Too many ODR requests in processing.
  - Changed response : [500]//Internal Server Error: An unexpected error occurred during the processing of the request.
POST/ne/export
- Response
  - Changed response : [200]//Successfully downloaded the PM data report in CSV format.
  - Changed response : [401]//Unauthorized access: The user is not authorized to download the resource.
  - Changed response : [403]//Forbidden access: Accessing the resource you were trying to reach is forbidden.
  - Changed 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 : [500]//Internal Server Error: An unexpected error occurred while processing the request.
POST/getcxnspanloss/
- Response
 - Changed response : [200]//Successfully retrieved spanloss KPI values for the specified connection IDs.
 - Schema
 Changed body: '*/*'
 - Changed response : [400]//Validation errors. Possible causes include: Granularity should be 15mins or 24hours objIds should not be empty and it should contain valid Connection Ids
 - Schema
 Changed body: '*/*'
 - Changed response : [401]//Unauthorized: The user is not authorized to access the resource.
 - Schema
 Changed body: '*/*'
 - Changed response : [403]//Forbidden: Access to the resource is denied due to insufficient permissions.
 - Schema
 Changed body: '*/*'
 - Changed response : [500]//Internal Server Error: An error occurred on the server side preventing the retrieval of spanloss data.
 - Schema
 Changed body: '*/*'
GET/getschedule/{profileId}
- Response
 - Changed response : [200]//Successfully retrieved the scheduled report details for the specified Profile ID. The response contains all relevant information regarding the scheduled CSV report profile.
 - Schema
 Changed body: '*/*'
 - Changed response : [400]//Bad Request: Validation error: ProfileId is not valid, please try with valid profileId
 - Schema
 Changed body: '*/*'
 - Changed response : [401]//Unauthorized: You do not have the necessary permissions to access the requested resource.
 - Schema
 Changed body: '*/*'
 - Changed response : [403]//Forbidden: You are not allowed to access the resource.
 - Schema
 Changed body: '*/*'
 - Changed response : [404]//Not Found: The profile associated with the given Profile ID could not be found. Ensure that the Profile ID is correct and that the profile exists in the scheduled state.
 - Schema
 Changed body: '*/*'
 - Changed response : [500]//Internal Server Error: An unexpected error occurred while fetching the scheduled report details. Please try again later.
 - Schema
 Changed body: '*/*'
GET/getallschedules
- Response
  - Changed response : [200]//Successfully retrieved all scheduled CSV report profiles.
    - Schema
      Changed body: '*/*'
  - Changed response : [401]//Unauthorized: You do not have the necessary permissions to view the scheduled report profiles.
    - Schema
      Changed body: '*/*'
  - Changed response : [403]//Forbidden: Access to the requested resource is restricted.
    - Schema
      Changed body: '*/*'
  - Changed response : [500]//Internal Server Error: An unexpected error occurred while fetching the scheduled report profiles.
    - Schema
      Changed body: '*/*'
POST/ne/query
- Response
 - New response : [404]//Errors: The NE ID is not present in PM DB The NE ID is not having matching data in PM dB
 - Changed response : [200]//Successfully retrieved the requested PM data. The response contains structured data for the specified Network Elements, following the `PmDataQueryRsp` schema.
 - Changed response : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure that you are properly authenticated and have the necessary permissions to access this resource.
 - Changed response : [403]//Forbidden access: The server understands the request but refuses to authorize it. Verify your user permissions to ensure access to the requested resource.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred while processing the request. Please try again later. If the issue persists, contact support for assistance.
POST/ne/nePmData
- Response
 - New response : [404]//Errors: The NE ID is not present in PM DB The NE ID is not having matching data in PM dB
 - Changed response : [200]//Successfully retrieved the requested PM data. The response contains structured data regarding the specified Network Elements, formatted according to the `PmDataQueryRsp` schema.
 - Changed response : [401]//Unauthorized access: The request lacks valid authentication credentials. Ensure you are logged in and have the necessary permissions to access this resource.
 - Changed response : [403]//Forbidden access: The server understands the request but refuses to authorize it. Verify your user permissions to ensure access to the requested resource.
 - Changed response : [500]//Internal Server Error: An unexpected error occurred while processing the request. Please try again later. If the issue persists, contact support for assistance.
POST/cxn/exportcompactpdf
- Response
 - Changed response : [200]//Successfully generated and downloaded the compact PDF report containing the requested PM data.
 - Changed response : [400]//Validation errors have occurred. Possible causes include: 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 Error in reading data from PM database
 - Changed response : [401]//You are not authorized to download the resource. Ensure you have the appropriate permissions.
 - Changed response : [403]//Access to the resource is forbidden. This may be due to insufficient permissions or restrictions on the resource.
 - Changed response : [404]//ErrPreviewFailed: Too many ODR requests in processing The CXN ID is not present in PM DB The CXN ID is not having matching data in PM db
 - Changed response : [500]//Internal server error. This could be due to an application-level issue or a failure in generating the compact PDF report. If the error persists, please contact support.
POST/cxn/export
- Response
 - Changed response : [200]//Successfully generated and downloaded the PM data report in CSV format.
 - Changed response : [400]//Validation errors occurred. Possible causes include: Granularity should be 1min/15mins/24hours/4hr/8/hr/1hr Connection ID is not present in PM DB. NeId and port is not present in given connection ID. NeId is not present for given Connection ID. 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 requested resource. Ensure you have the correct credentials and permissions.
 - Changed response : [403]//Access to the requested resource is forbidden. You may not have sufficient privileges to download the report.
 - Changed 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 : [500]//Internal server error. This may be due to an internal application failure or inability to generate the report. Contact support if the issue continues.
POST/connection/query
- Response
 - New response : [404]//Errors: The CXN ID is not present in PM DB The CXN ID is not having matching data in PM db
 - Changed response : [400]//Validation errors occurred. Possible causes include: 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
 - Changed response : [401]//You are not authorized to view the requested resource. Ensure you have the correct permissions.
 - Changed response : [403]//Access to the resource is forbidden. You may not have sufficient privileges to access the requested PM data.
 - Changed response : [500]//Internal server error. This could be caused by an application issue or a failure in generating the report.
POST/connection/kpiquery Retrieves Availability (Unavailable Seconds) data for given connections
- Response
  - Changed response : [200]//Successfully retrieved PM Availability (Unavailable Seconds) KPI data for the specified connections, time range, and granularity.
  - Changed response : [401]//Unauthorized: You do not have the necessary permissions to view the requested resource.
  - Changed response : [403]//Forbidden: Accessing the requested resource is not allowed.
  - Changed response : [500]//Internal application error: An unexpected error occurred while processing the request. Please try again later.
POST/connection/cxnPmData
- Response
 - New response : [404]//Errors: The CXN ID is not present in PM DB The CXN ID is not having matching data in PM db
 - Changed response : [200]//Successfully retrieved the requested PM data for the specified connections, time range, and granularity.
 - 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
 - Changed response : [401]//Unauthorized: You do not have the necessary permissions to view this resource.
 - Changed response : [403]//Forbidden: You are not allowed to access this resource.
 - Changed response : [500]//Internal application error: An unexpected error occurred while processing the request. Please try again later.

Application Versions⇑

What's New⇑

What's Deleted⇑

What's Deprecated⇑

What's Changed⇑

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Schema

Schema

Schema

Schema

Schema

Response

Schema

Schema

Response

Response

Response

Schema

Schema

Schema

Schema

Schema

Schema

Response

Request

Schema incompatible

Response

Request

Schema

Response

Response

Response

Response

Schema

Schema

Schema

Schema

Schema

Response

Schema

Schema

Schema

Schema

Schema

Schema

Response

Schema

Schema

Schema

Schema

Response

Response

Response

Response

Response

Response

Response