WaveSuite H&A API Documentation
This page provides links to Swagger documentation for the WaveSuite Health & Analytics product.
- API Diff
- 25.12
- 25.6
- 24.12
- 24.6
| REST API | Swagger |
|---|---|
| Admin |
|
| Event notifications |
|
| H&A application |
|
To understand the execution of WaveSuite H&A workflows in detail, see How To WS-HA.
What's New for REST API
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for 25.6 release, see:
Deleted APIs
| Request Method | API Path | Deleted in Release | Alternate API with same Request Method |
|---|---|---|---|
| GET | /api/v1/alarm-configs/{alarmConfigId} | 25.12 | NA |
| PUT | /api/v1/alarm-configs/{alarmConfigId} | 25.12 | NA |
| DELETE | /api/v1/alarm-configs/{alarmConfigId} | 25.12 | NA |
| POST | /api/v1/network-ports/clear-alarm-profile/bulk | 25.12 | NA |
| POST | /api/v1/network-ports/apply-alarm-profile/{alarmProfileId}/bulk | 25.12 | NA |
| POST | /api/v1/network-elements/clear-alarm-profile/bulk | 25.12 | NA |
| POST | /api/v1/network-elements/apply-alarm-profile/{alarmProfileId}/bulk | 25.12 | NA |
| POST | POST/api/v1/network-cards/clear-alarm-profile/bulk | 25.12 | NA |
| POST | /api/v1/network-cards/apply-alarm-profile/{alarmProfileId}/bulk | 25.12 | NA |
| GET | /api/v1/alarm-configs/{alarmConfigId}/alarm-profiles | 25.12 | NA |
| PUT | /api/v1/alarm-profiles/{alarmProfileId} | 25.12 | NA |
| DELETE | /api/v1/alarm-profiles/{alarmProfileId} | 25.12 | NA |
| POST | /api/v1/alarm-profiles | 25.12 | NA |
| POST | /api/v1/alarm-profiles/{alarmProfileId}/alarm-configs | 25.12 | NA |
| POST | /api/v1/alarm-configs | 25.12 | NA |
| REST API | Swagger |
|---|---|
| Admin |
|
| Audit logs |
|
| Event notifications |
|
| H&A application |
|
To understand the execution of WaveSuite H&A workflows in detail, see How To WS-HA.
What's New for REST API
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for 25.6 release, see:
Deprecated APIs
| Request Method | API Path | Deprecated in Release | Support Discontinued from the Release | Alternate API with same Request Method |
|---|---|---|---|---|
| POST | /api/v1/network-connections/{connectionId}/apply-alarm-profile | 25.6 | 26.6 | /api/v1/services/{serviceId}/apply-alarm-profile |
| POST | /api/v1/network-connections/{connectionId}/clear-alarm-profile | 25.6 | 26.6 | /api/v1//services/{serviceId}/clear-alarm-profile |
| GET | /api/v1/network-connections/{connectionId}/legend-data | 25.6 | 26.6 | /api/v1/services/{serviceId}/legend-data |
| PUT | /api/v1/network-connections/{connectionId}/network-groups | 25.6 | 26.6 | /api/v1/services/{serviceId}/network-groups |
| POST | /api/v1/network-connections/{connectionId}/network-groups | 25.6 | 26.6 | /api/v1/services/{serviceId}/network-groups |
| DELETE | /api/v1/network-connections/{connectionId}/network-groups | 25.6 | 26.6 | /api/v1/services/{serviceId}/network-groups |
| GET | /api/v1/network-external-links/{externalLinkId}/legend-data | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/legend-data |
| PUT | /api/v1/network-external-links/{externalLinkId}/network-groups | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/network-groups |
| POST | /api/v1/network-external-links/{externalLinkId}/network-groups | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/network-groups |
| DELETE | /api/v1/network-external-links/{externalLinkId}/network-groups | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/network-groups |
| POST | /api/v1/network-groups/{networkGroupId}/network-connections | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/services |
| DELETE | /api/v1/network-groups/{networkGroupId}/network-connections | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/services |
| POST | /api/v1/network-groups/{networkGroupId}/network-external-links | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/physical-connections |
| DELETE | /api/v1/network-groups/{networkGroupId}/network-external-links | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/physical-connections |
| POST | /api/v1/network-groups/{networkGroupId}/network-lightpaths | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/lightpaths |
| DELETE | /api/v1/network-groups/{networkGroupId}/network-lightpaths | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/lightpaths |
| GET | /api/v1/network-lightpaths/{lightpathId}/legend-data | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/legend-data |
| PUT | /api/v1/network-lightpaths/{lightpathId}/network-groups | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/network-groups |
| POST | /api/v1/network-lightpaths/{lightpathId}/network-groups | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/network-groups |
| DELETE | /api/v1/network-lightpaths/{lightpathId}/network-groups | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/network-groups |
| POST | /api/v1/network-managers/{networkManagerId}/reset-alarm-profiles | 25.6 | 26.6 | /api/v1/networks/{networkId}/reset-alarm-profiles |
| GET | /api/v1/network-ports/{portId}/alarm-statuses/summary | 25.6 | 26.6 | NA |
| GET | /api/v1/network-connections/connection-trends | 25.6 | 26.6 | /api/v1/services/trends |
| GET | /api/v1/network-connections/connection-trends/overview | 25.6 | 26.6 | /api/v1/services/trends/overview |
| GET | /api/v1/network-connections/overview | 25.6 | 26.6 | /services/overview |
| GET | /api/v1/network-connections/{connectionId}/network-lightpaths/overview | 25.6 | 26.6 | /api/v1/services/{serviceId}/lightpaths/overview |
| GET | /api/v1/network-connections/{connectionId}/network-ports/overview | 25.6 | 26.6 | /api/v1/services/{serviceId}/network-ports/overview |
| GET | /api/v1/network-connections/{connectionId}/overview | 25.6 | 26.6 | /api/v1/services/{serviceId}/overview |
| GET | /api/v1/network-elements/{elementId}/network-connections/overview | 25.6 | 26.6 | /api/v1/network-elements/{elementId}/services/overview |
| GET | /api/v1/network-external-links/{externalLinkId}/network-lightpaths/overview | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/lightpaths/overview |
| GET | /api/v1/network-external-links/{externalLinkId}/overview | 25.6 | 26.6 | /api/v1/physical-connections/{physicalConnectionId}/overview |
| GET | /api/v1/network-groups/{networkGroupId}/network-connections/overview | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/services/overview |
| GET | /api/v1/network-groups/{networkGroupId}/network-external-links/overview | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/physical-connections/overview |
| GET | /api/v1/network-groups/{networkGroupId}/network-lightpaths/overview | 25.6 | 26.6 | /api/v1/network-groups/{networkGroupId}/lightpaths/overview |
| GET | /api/v1/network-lightpaths/lightpath-trends/overview | 25.6 | 26.6 | /api/v1/lightpaths/trends/overview |
| GET | /api/v1/network-lightpaths/overview | 25.6 | 26.6 | /api/v1/network-lightpaths/overview |
| GET | /api/v1/network-lightpaths/{lightpathId}/network-connections/overview | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/services/overview |
| GET | /api/v1/network-lightpaths/{lightpathId}/network-external-links/overview | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/physical-connections/overview |
| GET | /api/v1/network-lightpaths/{lightpathId}/network-ports/overview | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/network-ports/overview |
| GET | /api/v1/network-lightpaths/{lightpathId}/overview | 25.6 | 26.6 | /api/v1/lightpaths/{lightpathId}/overview |
| GET | /api/v1/network-managers | 25.6 | 26.6 | /api/v1/networks |
| GET | /api/v1/network-managers/{networkManagerId} | 25.6 | 26.6 | /api/v1/networks/{networkId} |
| PUT | /api/v1/network-managers/{networkManagerId} | 25.6 | 26.6 | /api/v1/networks/{networkId} |
| GET | /api/v1/network-managers/{networkManagerId}/forecasted-kpis/{measurement} | 25.6 | 26.6 | NA |
| GET | /api/v1/network-managers/{networkManagerId}/kpis/{measurement} | 25.6 | 26.6 | /api/v1/networks/{networkId}/kpis/{measurement} |
| GET | /api/v1/network-managers/{networkManagerId}/kpis/{measurement}/histogram | 25.6 | 26.6 | /api/v1/network-ports/{portId}/kpis/{measurement}/histogram |
| GET | /api/v1/network-managers/{networkManagerId}/kpis/{measurement}/summary | 25.6 | 26.6 | /api/v1/network-ports/{portId}/kpis/{measurement}/summary |
| GET | /api/v1/network-managers/{networkManagerId}/network-element-filter-rules | 25.6 | 26.6 | /api/v1/networks/{networkId}/network-element-filter-rules |
| GET | /api/v1/network-ports/{portId}/network-connections/overview | 25.6 | 26.6 | /api/v1/network-ports/{portId}/services/overview |
| GET | /api/v1/network-ports/{portId}/network-lightpaths/overview | 25.6 | 26.6 | /api/v1/network-ports/{portId}/lightpaths/overview |
| GET | /api/v1/reports/{reportDefinitionId}/target-connections | 25.6 | 26.6 | /api/v1/reports/{reportDefinitionId}/target-services |
| GET | /api/v1/reports/{reportDefinitionId}/target-connections/overview | 25.6 | 26.6 | /api/v1/reports/{reportDefinitionId}/target-services/overview |
| GET | /api/v1/reports/{reportDefinitionId}/target-external-links | 25.6 | 26.6 | /api/v1/reports/{reportDefinitionId}/target-physical-connections |
| GET | /api/v1/reports/{reportDefinitionId}/target-external-links/overview | 25.6 | 26.6 | /api/v1/reports/{reportDefinitionId}/target-external-links/overview |
| REST API | Swagger |
|---|---|
| Admin |
|
| Audit logs |
|
| Event notifications |
|
| H&A application |
|
To understand the execution of WaveSuite H&A workflows in detail, see How To WS-HA.
API diffs from Release 24.6 to Release 24.12
Deprecated APIs
| Endpoint label | Endpoint name | Change |
|---|---|---|
| Returns all data sources | GET /api/v1/data-sources | These endpoints are removed from the DataSource API set in the WaveSuite Health & Analytics API. |
| Creates a single data source instance | POST /api/v1/data-sources | |
| Deletes a data source instance | DELETE /api/v1/data-sources/{dataSourceId} | |
| Returns a single data source instance | GET /api/v1/data-sources/{dataSourceId} | |
| Updates a data source instance | PUT /api/v1/data-sources/{dataSourceId} | |
| Returns the list of data source interfaces associated to a single data source instance | GET /api/v1/data-sources/{dataSourceId}/data-source-interfaces | |
| Associates a data source instance to a list of data source interfaces | POST /api/v1/data-sources/{dataSourceId}/data-source-interfaces | |
| Deletes a data source interface instance | DELETE /api/v1/data-source-interfaces/{dataSourceInterfaceId} | |
| Returns a single data source interface instance | GET /api/v1/data-source-interfaces/{dataSourceInterfaceId} | |
| Updates a data source interface instance | PUT /api/v1/data-source-interfaces/{dataSourceInterfaceId} | |
| Returns the list of data sources configured to use a single data source interface instance | GET /api/v1/data-source-interfaces/{dataSourceInterfaceId}/data-sources | |
| Associates a data source interface instance to a list of data sources | POST /api/v1/data-source-interfaces/{dataSourceInterfaceId}/data-sources | |
| Returns the list of current status of a data source instance for a particular interface | GET /api/v1/data-sources/{dataSourceId}/data-source-interfaces/ {dataSourceInterfaceId}/status | |
| Test the reachability of the data source over a particular data source interface | POST /api/v1/data-sources/{dataSourceId}/data-source-interfaces/ {dataSourceInterfaceId}/test | |
| Get Network Cards | GET /wavesuite/ha/api/v1/network-cards | These endpoints are removed from the NetworkSet API set in the WaveSuite Health & Analytics API. |
| Save Network Card | POST /wavesuite/ha/api/v1/network-cards | |
| Delete the Network Card | DELETE /wavesuite/ha/api/v1/network-cards/{cardId} | |
| Get Network Card | GET /wavesuite/ha/api/v1/network-cards/{cardId} | |
| Update an existing Network Card | PUT /wavesuite/ha/api/v1/network-cards/{cardId} | |
| Get Network Elements | GET /wavesuite/ha/api/v1/network-elements | |
| Save Network Element | POST /wavesuite/ha/api/v1/ network-elements | |
| Get Network Ports by Network Element ID | GET /wavesuite/ha/api/v1/ network-elements/{elementId}/network-ports | |
| Get Network Cards by Network Element ID | GET /wavesuite/ha/api/v1/network-elements/{elementId}/network-cards | |
| Get Network Connections by Network Element ID | GET /wavesuite/ha/api/v1/network-elements/{elementId}/network-connections | |
| Get Network Lightpaths by Network Element ID | GET /wavesuite/ha/api/v1/ network-elements/{elementId}/network-lightpaths | |
| Get Network External Links by Network Element ID | GET /wavesuite/ha/api/v1/ network-elements/{elementId}/network-external-links | |
| Delete the Network Element | DELETE /wavesuite/ha/api/v1/ network-elements/{elementId} | |
| Get Network Element | GET /wavesuite/ha/api/v1/ network-elements/{elementId} | |
| Update an existing Network Element | PUT /wavesuite/ha/api/v1/ network-elements/{elementId} | |
| Revert location configuration to a group of network elements | POST /wavesuite/ha/api/v1/ network-elements/revert-location-config/bulk | |
| Get Network Ports | GET /wavesuite/ha/api/v1/ network-ports | |
| Save Network Port | POST /wavesuite/ha/api/v1/ network-ports | |
| Delete the Network Port | DELETE /wavesuite/ha/api/v1/ network-ports/{portId} | |
| Get Network Port | GET /wavesuite/ha/api/v1/ network-ports/{portId} | |
| Update an existing Network Port | PUT /wavesuite/ha/api/v1/ network-ports/{portId} | |
| Get Network Connections by Network Port ID | GET /wavesuite/ha/api/v1/ network-ports/{portId}/network-connections | |
| Get Network Lightpaths by Network Port ID | GET /wavesuite/ha/api/v1/ network-ports/{portId}/network-lightpaths | |
| Get Network Connections | GET /wavesuite/ha/api/v1/ network-connections | |
| Save Network Connections | POST /wavesuite/ha/api/v1/ network-connections | |
| Delete the Network Connection | DELETE /wavesuite/ha/api/v1/ network-connections/{connectionId} | |
| Get Network Connection | GET /wavesuite/ha/api/v1/ network-connections/{connectionId} | |
| Update an existing Network Connection | PUT /wavesuite/ha/api/v1/ network-connections/{connectionId} | |
| Get Network Ports by Network Connection ID | GET /wavesuite/ha/api/v1/ network-connections/{connectionId}/network-ports | |
| Create or update the list of Network Ports associated to the Network Connection | POST /wavesuite/ha/api/v1/ network-connections/{connectionId}/network-ports | |
| Get Network Elements by Network Connection ID | GET /wavesuite/ha/api/v1/ network-connections/{connectionId}/network-elements | |
| Get Network External Links by Network Connection ID | GET /wavesuite/ha/api/v1/ network-connections/{connectionId} /network-external-links | |
| Get Network Lightpaths by Network Connection ID | GET /wavesuite/ha/api/v1/ network-connections/{connectionId}/network-lightpaths | |
| Create or update the list of Network Lightpaths associated to the Network Connection | POST /wavesuite/ha/api/v1/ network-connections/{connectionId}/network-lightpaths | |
| Get Network Lightpaths | GET /wavesuite/ha/api/v1/ network-lightpaths | |
| Save Network Lightpath | POST /wavesuite/ha/api/v1/network-lightpaths | |
| Delete the Network Lightpath | DELETE /wavesuite/ha/api/v1/network-lightpaths/{lightpathId} | |
| Get Network Lightpath | GET /wavesuite/ha/api/v1/ network-lightpaths/{lightpathId} | |
| Update an existing Network Lightpath | PUT /wavesuite/ha/api/v1/network-lightpaths/{lightpathId} | |
| Get Network Ports by Network Lightpath ID | GET /wavesuite/ha/api/v1/network-lightpaths/{lightpathId}/network-ports | |
| Get Network Connections by Network Lightpath ID | GET /wavesuite/ha/api/v1/ network-lightpaths/{lightpathId}/network-connections | |
| Get Network Elements by Network Lightpath ID | GET /wavesuite/ha/api/v1/network-lightpaths/{lightpathId}/network-elements | |
| Get Network External Links by Network Lightpath ID | GET /wavesuite/ha/api/v1/ network-lightpaths/{lightpathId}/network-external-links | |
| Create or update the list of Network External Links associated to the Network Lightpath | POST /wavesuite/ha/api/v1/network-lightpaths/{lightpathId} /network-external-links | |
| Get Network External Links | GET /wavesuite/ha/api/v1/network-external-links | |
| Save Network External Link | POST /wavesuite/ha/api/v1/network-external-links | |
| Delete the Network External Link | DELETE /wavesuite/ha/api/v1/network-external-links/{externalLinkId} | |
| Get Network External Link | GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId} | |
| Update an existing Network External Link | PUT /wavesuite/ha/api/v1/network-external-links/{externalLinkId} | |
| Get Network Lightpaths by Network External Link ID | GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId} /network-lightpaths |
| REST API | Swagger |
|---|---|
| Admin |
|
| Audit logs |
|
| Event notifications |
|
| H&A application |
|
To understand the execution of WaveSuite H&A workflows in detail, see How To WS-HA.
API diffs from Release 23.12 to Release 24.6
Admin API – What’s changed:
- basePath is changed from wavesuite/cp/admin to /wavesuite/ha/admin
Admin API – What’s deleted:
- Endpoints:
- POST /api/v1/authenticate
- POST /api/v1/logout
- GET /api/v1/user-account
- PUT /api/v1/user-account
- GET /api/v1/user-account/preferences
- PUT /api/v1/user-account/preferences
- GET /api/v1/users
- POST /api/v1/users
- POST /api/v1/users/bulk
- GET /api/v1/users{userId}
- PUT /api/v1/users{userId}
- DELETE /api/v1/users{userId}
- POST /api/v1/users{userId}/reset-password
- Definitions:
- AuthenticationRequest
- AuthenticationResponse
- Event
- NetworkInterface
- User
- UserPreferences
Audit Logs API – No changes
Event Notifications API – No changes
H&A API – What’s new:
- NoActivityUpdate parameter added to following endpoints:
- GET /wavesuite/ha/api/v1/alarm-statuses
- GET /wavesuite/ha/api/v1/alarm-statuses
- GET /wavesuite/ha/api/v1/kpis/cpu
- GET /wavesuite/ha/api/v1/kpis/disk
- GET /wavesuite/ha/api/v1/kpis/memory
- GET /wavesuite/ha/api/v1/kpis/network
- GET /wavesuite/ha/api/v1/kpis/{measurement}
- GET /wavesuite/ha/api/v1/kpis/{measurement}/summary
- GET /wavesuite/ha/api/v1/network-managers/{networkManagerId}/kpis/{measurement}
- Response 400 added to GET /wavesuite/ha/api/v1/kpis/{measurement}/grouping endpoint
- Endpoints:
- GET /wavesuite/ha/api/v1/license/status
- GET /wavesuite/ha/api/v1/user-account
- Definitions:
- EntityKpis
- LicenseStatus
- PaginatedEntityKpis
- PaginatedRawKpis
- User
- Enum values for code property of ModelError definition
- license_parse_expiration_date, NeTypeSnmpConfigMapping
- diversityGroupId and diversityGroupName properties added to the NetworkConnection, NetworkConnectionOverview definitions
- isNeTypeCurrent and isNeTypeVoltage properties added to the NetworkElementsOveriew definition
- Enum values added to the encodingType property of NetworkPort definition:
- 128QAM, 16QAM, 16QAM_250G, 16SQAM, 256QAM, 32QAM, 64QAM, 8QAM, BPSK, NRZ, PDM_QPSK, QPSK, SP-QPSK
- Enum values added to the phaseEncoding property for the NetworkPort definition:
- Absolute, Differential
- layerRate property added to the NetworkReferenceFecLimit definition
- message property added to the ReportRun definition
H&A API – What’s deleted:
- Endpoints:
- GET /wavesuite/ha/api/v1/network-element-gnmi-configs
- POST /wavesuite/ha/api/v1/network-element-gnmi-configs
- GET /wavesuite/ha/api/v1/network-element-gnmi-configs/{networkElementGnmiConfigId}
- PUT /wavesuite/ha/api/v1/network-element-gnmi-configs/{networkElementGnmiConfigId}
- DELETE /wavesuite/ha/api/v1/network-element-gnmi-configs/{networkElementGnmiConfigId}
- GET /wavesuite/ha/api/v1/network-element-pm-bin-configs
- POST /wavesuite/ha/api/v1/network-element-pm-bin-configs
- GET /wavesuite/ha/api/v1/network-element-pm-bin-configs/{networkElementPmBinConfigId}
- PUT /wavesuite/ha/api/v1/network-element-pm-bin-configs/{networkElementPmBinConfigId}
- DELETE /wavesuite/ha/api/v1/network-element-pm-bin-configs/{networkElementPmBinConfigId}
- GET /wavesuite/ha/api/v1/network-element-sftp-configs
- POST /wavesuite/ha/api/v1/network-element-sftp-configs
- GET /wavesuite/ha/api/v1/network-element-sftp-configs/{networkElementSftpConfigId}
- PUT /wavesuite/ha/api/v1/network-element-sftp-configs/{networkElementSftpConfigId}
- DELETE /wavesuite/ha/api/v1/network-element-sftp-configs/{networkElementSftpConfigId}
- GET /wavesuite/ha/api/v1/network-element-snmp-configs
- POST /wavesuite/ha/api/v1/network-element-snmp-configs
- GET /wavesuite/ha/api/v1/network-element-snmp-configs/{networkElementSnmpConfigId}
- PUT /wavesuite/ha/api/v1/network-element-snmp-configs/{networkElementSnmpConfigId}
- DELETE /wavesuite/ha/api/v1/network-element-snmp-configs/{networkElementSnmpConfigId}
- POST /wavesuite/ha/api/v1/network-elements/apply-gnmi-config/{gnmiConfigId}/bulk
- POST /wavesuite/ha/api/v1/network-elements/apply-pmbin-config/{pmBinConfigId}/bulk
- POST /wavesuite/ha/api/v1/network-elements/apply-sftp-config/{sftpConfigId}/bulk
- POST /wavesuite/ha/api/v1/network-elements/apply-snmp-config/{snmpConfigId}/bulk
- POST /wavesuite/ha/api/v1/network-elements/clear-gnmi-config/bulk
- POST /wavesuite/ha/api/v1/network-elements/clear-pmbin-config/bulk
- POST /wavesuite/ha/api/v1/network-elements/clear-sftp-config/bulk
- POST /wavesuite/ha/api/v1/network-elements/clear-snmp-config/bulk
- GET /wavesuite/ha/api/v1/network-elements/{elementId}/connectivity-state
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans
- POST /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans
- DELETE /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}
- DELETE /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}
- PUT /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}/baseline
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}/download
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}/report
- POST /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-scans/{scanId}/revert
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-schedules
- POST /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-schedules
- GET /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-schedules/{scheduleId}
- PUT /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-schedules/{scheduleId}
- DELETE /wavesuite/ha/api/v1/network-external-links/{externalLinkId}/otdr-schedules/{scheduleId}
- GET /wavesuite/ha/api/v1/otdr-definitions
- POST /wavesuite/ha/api/v1/otdr-definitions
- GET /wavesuite/ha/api/v1/otdr-definitions/{definitionId}
- PUT /wavesuite/ha/api/v1/otdr-definitions/{definitionId}
- DELETE /wavesuite/ha/api/v1/otdr-definitions/{definitionId}
- Definitions:
- EntityKpi, NeTypeGnmiConfigMapping, NeTypePmBinConfigMapping, NeTypeSftpConfigMapping, NetworkElementGnmiConfig, NetworkElementGnmiConfigPaginated, NetworkElementPmBinConfig, NetworkElementPmBinConfigPaginated, NetworkElementSftpConfig, NetworkElementSftpConfigPaginated, NetworkElementSnmpConfig, NetworkElementSnmpConfigPaginated, OtdrDefinition, OtdrDefinitionPaginated, OtdrEvent, OtdrReportUpdate, OtdrReportUpdateGenParams, OtdrReportUpdateKeyEvent, OtdrScanBaseline, OtdrScanOverview, OtdrScanOverviewPaginated, OtdrScanSchedule, OtdrScanScheduleOverview, OtdrScanScheduleOverviewPaginated, PortTypeAlarmProfileMapping, ProtocolConnectivityState, ProtocolConnectivityStateList, RawKpi
- Enum values for code property of ModelError definition
- otdr_definition_name_must_be_unique, otdr_definition_not_found, otdr_direction_is_invalid, otdr_port_not_found, otdr_scan_baseline_request_is_invalid, otdr_scan_invalid_direction_parameter_value, otdr_scan_invalid_file_already_existing, otdr_scan_invalid_file_missing_block, otdr_scan_invalid_format_parameter_value, otdr_scan_invalid_results_file, otdr_scan_invalid_state, otdr_scan_not_found, otdr_scan_schedule_in_progress_scan, otdr_scan_schedule_label_is_invalid, otdr_scan_schedule_missing_gnmi_configuration, otdr_scan_schedule_not_found, otdr_scan_schedule_one_shot_param_not_allowed, otdr_scan_schedule_recurring_enabled_timeframe_is_invalid, otdr_scan_schedule_recurring_params_missing, otdr_scan_schedule_recurring_params_not_allowed, pmbin_config_is_in_use, pmbin_config_name_must_be_unique, pmbin_config_not_found, sftp_config_auth_password_mandatory, sftp_config_community_string_mandatory, sftp_config_is_in_use, sftp_config_name_mandatory, sftp_config_name_must_be_unique, sftp_config_not_found, sftp_config_priv_password_mandatory, sftp_config_security_name_mandatory, snmp_config_auth_password_mandatory, snmp_config_community_string_mandatory, snmp_config_is_in_use, snmp_config_name_mandatory, snmp_config_name_must_be_unique, snmp_config_not_found, snmp_config_priv_password_mandatory, snmp_config_security_name_mandatory
- The following properties from the NetworkDomain definition:
- neGnmiConfigs
- nePmBinConfigs
- neSftpConfigs
- neSnmpConfigs
- The following properties from the NetworkElement and NetworkElementsOveriew definitions:
- networkElementGnmiConfigId
- networkElementPmBinConfigId
- networkElementSftpConfigId
- networkElementSnmpConfigId
- The connectivityState property from the NetworkElementsOveriew definition
- The following properties from the NetworkExteralLinkOverview definition:
- baselineAzOtdrScanId
- baselineZaOtdrScanId
- otdrCapable
- pmCountersEnabled
- otdrPortId property from the NetworkPort definition
- otdrPortId and otdrPortName properties from the NetworkPortOverview definition
- lineRate property is deprecated for NetworkReferenceFecLimit definition