Operation
get /otn/NBI/containedPotentialTPs/{nprNeId}/{ptpName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nprNeId | required | nprNeId | --- |
| ptpName | required | ptpName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiTPBrowserResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /otn/NBI/physicalPorts/{nprNeId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nprNeId | required | nprNeId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiTPBrowserResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /otn/NBI/Connection/{invariantId}/timeslots/availablePath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiProvisionableResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
post /otn/NBI/Connection/getConnection/{invariantId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | data | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiProvisionableResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /otn/NBI/containingTps/{nprNeId}/{ctpNativeName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nprNeId | required | nprNeId | --- |
| ctpNativeName | required | ctpNativeName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiTPBrowserResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
post /otn/NBI/Connection/modifyASAP/{invariantId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | data | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnConnectionResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /otn/NBI/Connection/modifySNC/{invariantId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | data | NbiModifySNCReq |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnConnectionResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /otn/NBI/Connection/{invariantId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | data | NbiModifyParamReq |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnConnectionResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /otn/NBI/Connection/ModifyLabel/{connId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connId | required | connId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | data | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnConnectionResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /otn/NBI/Connection/switchData/{connId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connId | required | connId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiSwitchDataResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /otn/NBI/Connection/routeTopoData/{connId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connId | required | connId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiTopoResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /otn/NBI/Connection/{invariantId}/switchDataPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| invariantId | required | invariantId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NbiSwitchDataResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Collection
Name |
Type |
Description |
Enum |
|---|
HashMap«string,object»
Name |
Type |
Description |
Enum |
|---|
HashMap«string,string»
Name |
Type |
Description |
Enum |
|---|
NbiProvisionableResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| message | String string |
--- | --- |
| status | String string |
--- | --- |
| data | StringBuffer StringBuffer |
--- | --- |
| netConn | NetworkConnection NetworkConnection |
--- | --- |
| dataMap | Object object |
--- | --- |
NbiSwitchDataResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| message | String string |
--- | --- |
| status | String string |
--- | --- |
| invariantConnId | String string |
--- | --- |
| connId | String string |
--- | --- |
| listOfAsonIds | Collection Collection |
--- | --- |
NbiTopoResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| message | String string |
--- | --- |
| status | String string |
--- | --- |
| topoData | array[Map«string,string»] Map«string,string» |
--- | --- |
NbiTPBrowserResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqCompletionStatus | Integer integer |
--- | --- |
| requestId | Long long |
--- | --- |
| clientName | String string |
--- | --- |
| clientLocation | String string |
--- | --- |
| clientUser | String string |
--- | --- |
| sessionId | String string |
--- | --- |
| mdcId | String string |
--- | --- |
| sequenceNum | Integer integer |
--- | --- |
| moreToCome | Boolean boolean |
--- | --- |
| messages | array[OtnI18nMessage] OtnI18nMessage |
--- | --- |
| errcde | String string |
--- | --- |
| errorParams | array[Object] object |
--- | --- |
| tpList | array[NbiTPData] NbiTPData |
--- | --- |
| failedCompletion | Boolean boolean |
--- | --- |
| successfulCompletion | Boolean boolean |
--- | --- |
| timeout | Long long |
--- | --- |
| nadString | String string |
--- | --- |
NbiTPData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nwInterfaceType | Integer integer |
--- | --- |
| nodeId | Long long |
--- | --- |
| nodeName | String string |
--- | --- |
| neId | Long long |
--- | --- |
| neName | String string |
--- | --- |
| ptpId | Long long |
--- | --- |
| ptpName | String string |
--- | --- |
| tpId | Long long |
--- | --- |
| tpName | String string |
--- | --- |
| tpDisplayLabel | String string |
--- | --- |
| ptpLayerRate | Integer integer |
--- | --- |
| layerRate | Integer integer |
--- | --- |
| tpType | Integer integer |
--- | --- |
| effectiveRate | String string |
--- | --- |
| frequency | String string |
--- | --- |
| clientSel | String string |
--- | --- |
| xfpName | String string |
--- | --- |
| directionality | String string |
--- | --- |
| nbiInterfaceName | String string |
--- | --- |
| tpUserLabel | String string |
--- | --- |
| signalType | String string |
--- | --- |
| availability | String string |
--- | --- |
| nprneid | Long long |
--- | --- |
| interfaceName | String string |
--- | --- |
| cardName | String string |
--- | --- |
| derivedNodeName | String string |
--- | --- |
| networkInterfaceType | Integer integer |
--- | --- |
NetworkConnection
Name |
Type |
Description |
Enum |
|---|---|---|---|
| SwitchCapability | String string |
--- | --- |
| id | Long long |
--- | --- |
| userLabel | String string |
--- | --- |
| objectClass | String string |
--- | --- |
| name | String string |
--- | --- |
| alias | String string |
--- | --- |
| a1TPData | TPData TPData |
--- | --- |
| z1TPData | TPData TPData |
--- | --- |
| a2TPData | TPData TPData |
--- | --- |
| z2TPData | TPData TPData |
--- | --- |
| componentId1 | Long long |
--- | --- |
| componentId2 | Long long |
--- | --- |
| connRate | Integer integer |
--- | --- |
| shape | Integer integer |
--- | --- |
| dir | Integer integer |
--- | --- |
| objectType | String string |
--- | --- |
| operState | String string |
--- | --- |
| almState | String string |
--- | --- |
| serverAlmState | String string |
--- | --- |
| alarmProfileEnabled | String string |
--- | --- |
| connectionState | Integer integer |
--- | --- |
| svcState | Integer integer |
--- | --- |
| almMonState | Integer integer |
--- | --- |
| connectionCategory | Integer integer |
--- | --- |
| connectionType | Integer integer |
--- | --- |
| protectionType | Integer integer |
--- | --- |
| displayProtectionType | Integer integer |
--- | --- |
| protectionRole | Integer integer |
--- | --- |
| nprTlId | Long long |
--- | --- |
| sdhConnectionId | Long long |
--- | --- |
| sdhClientId | Long long |
--- | --- |
| customerName | String string |
--- | --- |
| isUsedInSdh | Boolean boolean |
--- | --- |
| tcmStatus | Integer integer |
--- | --- |
| tcmASAP | String string |
--- | --- |
| effectiveRate | String string |
--- | --- |
| createdBy | Integer integer |
--- | --- |
| omspTrailId | Long long |
--- | --- |
| omspConnectionName | String string |
--- | --- |
| wtocm | String string |
--- | --- |
| signalType | String string |
--- | --- |
| usedTimeSlot | String string |
--- | --- |
| containerType | String string |
--- | --- |
| band | String string |
--- | --- |
| reservedBy | Integer integer |
--- | --- |
| spectrumWidth | Long long |
--- | --- |
| tsCount | Integer integer |
--- | --- |
| totalRecordCount | Integer integer |
--- | --- |
| thirdPartyDesc | String string |
--- | --- |
| thirdPartyName | String string |
--- | --- |
| orderId | Long long |
--- | --- |
| orderNumber | String string |
--- | --- |
| orderType | Integer integer |
--- | --- |
| orderState | Integer integer |
--- | --- |
| orderStackId | Long long |
--- | --- |
| receivedDate | Long long |
--- | --- |
| ncGroupId | Long long |
--- | --- |
| ncGroupName | String string |
--- | --- |
| ncGroupType | Integer integer |
--- | --- |
| groupState | Integer integer |
--- | --- |
| groupEntityType | Integer integer |
--- | --- |
| groupClass | Integer integer |
--- | --- |
| vsClientId | Long long |
--- | --- |
| vsClientState | Integer integer |
--- | --- |
| asapId | Long long |
--- | --- |
| connectionLevel | Integer integer |
--- | --- |
| extendedParams | HashMap«string,object» HashMap«string,object» |
--- | --- |
| connectionParams | HashMap«string,string» HashMap«string,string» |
--- | --- |
| inconsistentConnInfo | NetworkConnectionMismatch NetworkConnectionMismatch |
--- | --- |
| serverProtectionType | String string |
--- | --- |
| serverConnectionCategory | Integer integer |
--- | --- |
| serverConnId | Long long |
--- | --- |
| serverConnectionRate | String string |
--- | --- |
| allowAsonResources | String string |
--- | --- |
| hasAsonResources | String string |
--- | --- |
| lineGranularity | Long long |
--- | --- |
| opsaRevertiveMode | String string |
--- | --- |
| opsaWaitToRestoreTime | String string |
--- | --- |
| singleFiberChannelPlan | String string |
--- | --- |
| olcState | String string |
--- | --- |
| externalEML | String string |
--- | --- |
| notesText | String string |
--- | --- |
| bandwidth | String string |
--- | --- |
| gridtype | String string |
--- | --- |
| freqOffset | Integer integer |
--- | --- |
| associatednprtlid | Integer integer |
--- | --- |
| dmValue | String string |
--- | --- |
| dmValueProtection | String string |
--- | --- |
| dmTimestamp | String string |
--- | --- |
| dmStatus | String string |
--- | --- |
| latency | String string |
--- | --- |
| revertiveMode | String string |
--- | --- |
| clientRevertiveMode | String string |
--- | --- |
| sbnConnParamRevertiveMode | String string |
--- | --- |
| isEline | String string |
--- | --- |
| linkUtilThreshold | String string |
--- | --- |
| profileId | String string |
--- | --- |
| waveKeyType | String string |
--- | --- |
| waveKeyConfig | String string |
--- | --- |
| isYProtected | String string |
--- | --- |
| frequencies | String string |
--- | --- |
| pm24h | String string |
--- | --- |
| pm15m | String string |
--- | --- |
| nimEnabled | String string |
--- | --- |
| linkUtilRatio | Long long |
--- | --- |
| linkUtilProfile | String string |
--- | --- |
| clientRouteState | String string |
--- | --- |
| encoding | String string |
--- | --- |
| sbnConnParamScId | String string |
--- | --- |
| autoInService | String string |
--- | --- |
| autoInServiceTimer | String string |
--- | --- |
| scheduledJobs | String string |
--- | --- |
| switchCapability | String string |
--- | --- |
| otdrSupported | Long long |
--- | --- |
| slteSupported | Long long |
--- | --- |
| networkRevertiveMode | String string |
--- | --- |
| otnObjectName | String string |
--- | --- |
| objectId | Double double |
--- | --- |
| implementingClassName | String string |
--- | --- |
| objectIdClass | Class«object» Class«object» |
--- | --- |
OtnConnectionResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| message | String string |
--- | --- |
| messageId | String string |
--- | --- |
| messageSeverity | String string |
--- | --- |
| status | String string |
--- | --- |
| connectionName | String string |
--- | --- |
| connectionId | Integer integer |
--- | --- |
| orderNumber | String string |
--- | --- |
| orderId | String string |
--- | --- |
| orderStep | Integer integer |
--- | --- |
| id | String string |
--- | --- |
| errorField | String string |
--- | --- |
| errorValue | String string |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
|---|---|---|---|
| messageType | String string |
--- | [Info, Warning, Error] |
| messageUnformatted | String string |
--- | --- |
| validPropertyResourceMessage | Boolean boolean |
--- | --- |
| messageId | String string |
--- | --- |
| messageParams | array[String] string |
--- | --- |
| messageTime | Long long |
--- | --- |
| message | String string |
--- | --- |
StringBuffer
Name |
Type |
Description |
Enum |
|---|
TPData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nwInterfaceType | Integer integer |
--- | --- |
| isCapableOfPmMonitoringPort | Boolean boolean |
--- | --- |
| isTerminalLoopbackSupportedTp | Boolean boolean |
--- | --- |
| isFacilityLoopbackSupportedTp | Boolean boolean |
--- | --- |
| hasLoopback | Boolean boolean |
--- | --- |
| nodeId | Long long |
--- | --- |
| nodeName | String string |
--- | --- |
| neId | Long long |
--- | --- |
| neName | String string |
--- | --- |
| ptpId | Long long |
--- | --- |
| ptpName | String string |
--- | --- |
| tpId | Long long |
--- | --- |
| tpName | String string |
--- | --- |
| tpDisplayLabel | String string |
--- | --- |
| ptpLayerRate | Integer integer |
--- | --- |
| layerRate | Integer integer |
--- | --- |
| tpType | Integer integer |
--- | --- |
| effectiveRate | String string |
--- | --- |
| frequency | String string |
--- | --- |
| clientSel | String string |
--- | --- |
| xfpName | String string |
--- | --- |
| displayEdgeOnNe | String string |
--- | --- |
| directionality | String string |
--- | --- |
| nbiInterfaceName | String string |
--- | --- |
| tpUserLabel | String string |
--- | --- |
| parentTpType | Integer integer |
--- | --- |
| signalType | String string |
--- | --- |
| neModel | String string |
--- | --- |
| neSoftwareVersion | String string |
--- | --- |
| almState | String string |
--- | --- |
| baseLineValueOPT | String string |
--- | --- |
| baseLineValueOPR | String string |
--- | --- |
| transmitPower | String string |
--- | --- |
| receivePower | String string |
--- | --- |
| encoding | String string |
--- | --- |
| waveShape | String string |
--- | --- |
| primaryState | String string |
--- | --- |
| secondaryState | String string |
--- | --- |
| wtdUsageType | String string |
--- | --- |
| wtdUsageTypeL | String string |
--- | --- |
| ingressMeasType | String string |
--- | --- |
| egressMeasType | String string |
--- | --- |
| powerManagementType | String string |
--- | --- |
| loopbackType | String string |
--- | --- |
| phaseEncoding | String string |
--- | --- |
| bandwidth | String string |
--- | --- |
| oduKPort | String string |
--- | --- |
| cardName | String string |
--- | --- |
| cardMode | String string |
--- | --- |
| cardInterworkingMode | String string |
--- | --- |
| terminalLoopbackSupportedPort | Boolean boolean |
--- | --- |
| facilityLoopbackSupportedPort | Boolean boolean |
--- | --- |
| derivedNodeName | String string |
--- | --- |
| networkInterfaceType | Integer integer |
--- | --- |
| capableOfPmMonitoringPort | Boolean boolean |
--- | --- |