Operation
post /data/otn/insertNode/{id}/confirmCPBImplPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OtnInsertNodeResp
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /data/otn/connection/{id}/clientsInfoForPhyPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/clientsInfoForPhyPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connection/{id}/clientsInfoListForPhyPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/clientsInfoListForPhyPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connectionList/{ids}/clientsInfoForPhyPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| ids | required | connection ids can be obtained from '/data/otn/connections' REST call as id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[Entry«int,ConnectionInventoryResponse»]
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
post /data/otn/physicalLink/{id}/dbdeletePath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/insertNode/{jobid}/connIdPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| jobid | required | job id can be obtained from esmJob list /oms1350/esmBrowser/jobList/GetJobListJ | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /data/otn/connection/{id}/InsertNodeConnInfoPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OtnInsertNodeNewDataResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/InsertNodeConnInfoPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OtnInsertNodeNewDataResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/insertNode/{connID}/jobIdPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connID | required | NRP id of the connection | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/moveTraffic/{connID}/jobIdPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connID | required | NRP id of the connection | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/networkTransformData/{jobid}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| jobid | required | job id can be obtained from esmJob list /oms1350/esmBrowser/jobList/GetJobListJ | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
InsertNodeData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/omsIdsForOtsIds/{otsIds}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| otsIds | required | ots id can be obtained from /data/npr/physicalConns | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[Entry«string,Map«string,long»»]
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/insertNode/{nodeID}/physicalLinksPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nodeID | required | node id can be obtained from the rest call | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| rate | optional | rate is to get OTS/OCS physical connections |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/connection/{id}/protectedConnsOfOTSPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/protectedConnsOfOTSPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connection/{id}/protectedConnsForReleaseSwitchPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/protectedConnsForReleaseSwitchPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/removeNode/{physicalLinkIds}/jobIdPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| physicalLinkIds | required | Comma separated list of Physical Link Ids | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/removeNode/{physicalLinkIds}/statusPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| physicalLinkIds | required | Comma separated list of Physical Link Ids | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
INwTransfEvent
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/insertNode/{connID}/statusPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| connID | required | Physical Link ID | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
INwTransfEvent
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/connection/{id}/unprotectedConnsOfOTSPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
get /data/otn/connections/{id}/unprotectedConnsOfOTSPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
Operation
post /data/otn/physicalLinks/{id}/moveTrafficPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
| body2 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
| actionName | optional | action name is moveTraffic, insertNode or removeNode. This is to identify if move traffic is done as part of Insert Node operation or not. |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnInsertNodeDeferredResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/insertNode/{id}/preparePath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | InsertNodeUserSelection |
--- |
| body2 | optional | request | ServletWebRequest |
--- |
| body3 | optional | httpSession | HttpSession |
--- |
| body4 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnInsertNodeDeferredResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/removeNodeRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | RemoveNodeUserSelection |
--- |
| body2 | optional | httpSession | HttpSession |
--- |
| body3 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| actionName | required | connection id can be obtained from '/data/otn/removeNode' REST call as actionName |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnInsertNodeDeferredResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/insertNode/{id}/proceedPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | InsertNodeUserSelection |
--- |
| body2 | optional | request | ServletWebRequest |
--- |
| body3 | optional | httpSession | HttpSession |
--- |
| body4 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
| otsDomain | optional | action name is cpinsertnode, insertNode. This is to identify if Insert Node is done as part of Insert Node operation or not. |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnInsertNodeDeferredResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/insertNode/{id}/rollbackPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | InsertNodeUserSelection |
--- |
| body2 | optional | request | ServletWebRequest |
--- |
| body3 | optional | httpSession | HttpSession |
--- |
| body4 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| connName | optional | connection name obtained from '/data/otn/connection' REST call as connName |
| jobHandle | optional | jobHandle is to get the details based on jobId if the actual connection is deleted / launching from jobs list. jobHandle can be retrieved from esm joblist /oms1350/esmBrowser/jobList/GetJobListJ |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
DeferredResult«OtnInsertNodeDeferredResponse»
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/physicalLinks/{id}/asonrollbacktransformPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/physicalLinks/{id}/wdmrollbacktransformPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/physicalLinks/{id}/asontransformPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/physicalLinks/{id}/transformPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/physicalLinks/{id}/wdmtransformPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | connection id can be obtained from '/data/otn/connections' REST call as id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
String
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/insertNode/validateConnsRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | InsertNodeUserSelection |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| otsDomain | optional | otsDomain |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
InsertNodeUserSelection
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /data/otn/insertNode/{jobId}/checkProceedConfirmationPath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| jobId | required | job id can be obtained from esmJob list /oms1350/esmBrowser/jobList/GetJobListJ | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Boolean
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
ConnectionInventoryResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqCompletionStatus | Integer integer |
A value which indicates completion status of the request | --- |
| requestId | Long long |
Id generated for the Request passed | --- |
| clientName | String string |
Indicates name of the client | --- |
| clientLocation | String string |
Indicates location of the client | --- |
| clientUser | String string |
Indicates the client User | --- |
| sessionId | String string |
Session Id of the event | --- |
| mdcId | String string |
MDC Id,if any | --- |
| sequenceNum | Integer integer |
Indicates the sequence Number generated for the response | --- |
| moreToCome | Boolean boolean |
Indicates with true/false if more responses are to come | --- |
| messages | array[OtnI18nMessage] OtnI18nMessage |
Response Messages,if any from the response like an Info,Warning etc | --- |
| errcde | String string |
Indicates error code,if any error generated | --- |
| errorParams | array[Object] object |
Indicates different error parameters,if any error generated | --- |
| nextTasks | array[String] string |
Next Tasks : Example = {CommandDeployer, RouteDisplay, Alarms} | --- |
| items | array[Object] object |
Items | --- |
| data | array[Object] object |
data | --- |
| failedCompletion | Boolean boolean |
Indicates response completion failed with true/false | --- |
| successfulCompletion | Boolean boolean |
Indicates successful response completion with true/false | --- |
| timeout | Long long |
--- | --- |
| nadString | String string |
--- | --- |
ConnectionObject
Name |
Type |
Description |
Enum |
|---|---|---|---|
| label | String string |
--- | --- |
| TCMEnabled | String string |
--- | --- |
| TCMASAPEnabled | String string |
--- | --- |
| aPortLabel | String string |
--- | --- |
| zPortLabel | String string |
--- | --- |
| TCMPMCollection15m | String string |
--- | --- |
| TCMPMCollection24h | String string |
--- | --- |
| isMainActiveL1CP | String string |
--- | --- |
| isSpareActiveL1CP | String string |
--- | --- |
| isAssignedPortOnNe | Boolean boolean |
--- | --- |
| npaUserLabel | String string |
--- | --- |
| lineModeProfile | String string |
--- | --- |
| className | String string |
ClassName | --- |
| id | String string |
id | --- |
| key | String string |
Key | --- |
| guiLabel | String string |
GuiLabel | --- |
| parentId | String string |
ParentId | --- |
| hasChildren | String string |
HasChildren | --- |
| connectionId | String string |
--- | --- |
| vsClientState | String string |
--- | --- |
| vsClientId | Long long |
--- | --- |
| connectionType | String string |
--- | --- |
| receivedDate | String string |
--- | --- |
| eventDate | String string |
--- | --- |
| orderId | String string |
--- | --- |
| groupOrderId | String string |
--- | --- |
| groupOrderType | String string |
--- | --- |
| groupOrderName | String string |
--- | --- |
| connectionName | String string |
--- | --- |
| omspConnectionName | String string |
--- | --- |
| connectionAlias | String string |
--- | --- |
| connectionAlias2 | String string |
--- | --- |
| orderStep | String string |
--- | --- |
| stepState | String string |
--- | --- |
| orderType | String string |
--- | --- |
| layerRate | String string |
--- | --- |
| tpPrimaryRate | String string |
--- | --- |
| effectiveRate | String string |
--- | --- |
| protectionType | String string |
--- | --- |
| displayProtectionType | String string |
--- | --- |
| protectionRole | String string |
--- | --- |
| state | String string |
--- | --- |
| operationalState | String string |
--- | --- |
| category | String string |
--- | --- |
| alarmEnabling | String string |
--- | --- |
| alarmState | String string |
--- | --- |
| alarmSeverity | String string |
--- | --- |
| serverAlmState | String string |
--- | --- |
| nmlASAPName | String string |
--- | --- |
| frequency | String string |
--- | --- |
| orderNumber | String string |
--- | --- |
| customerName | String string |
--- | --- |
| serviceState | String string |
--- | --- |
| provisionableWavekey | String string |
--- | --- |
| a1NeName | String string |
--- | --- |
| a1PortName | String string |
--- | --- |
| z1NeName | String string |
--- | --- |
| z1PortName | String string |
--- | --- |
| a2NeName | String string |
--- | --- |
| a2PortName | String string |
--- | --- |
| z2NeName | String string |
--- | --- |
| z2PortName | String string |
--- | --- |
| a1NodeName | String string |
--- | --- |
| z1NodeName | String string |
--- | --- |
| a2NodeName | String string |
--- | --- |
| z2NodeName | String string |
--- | --- |
| aNodeId | Long long |
--- | --- |
| zNodeId | Long long |
--- | --- |
| a2NodeId | Long long |
--- | --- |
| z2NodeId | Long long |
--- | --- |
| aPortId | Long long |
--- | --- |
| zPortId | Long long |
--- | --- |
| a2PortId | Long long |
--- | --- |
| z2PortId | Long long |
--- | --- |
| azConnectionEndPorts | array[Object] object |
--- | --- |
| a1NodeAndPort | String string |
--- | --- |
| z1NodeAndPort | String string |
--- | --- |
| a2NodeAndPort | String string |
--- | --- |
| z2NodeAndPort | String string |
--- | --- |
| nccId | String string |
--- | --- |
| pm24hour | String string |
--- | --- |
| pm15min | String string |
--- | --- |
| nimEnabled | String string |
--- | --- |
| linkUtilProfile | String string |
--- | --- |
| linkUtilRatio | Long long |
--- | --- |
| linkUtilThreshold | String string |
--- | --- |
| availableCapacity | String string |
--- | --- |
| isPMSupported | String string |
--- | --- |
| hasRouteComponent | String string |
--- | --- |
| isOpticalRouteAvailable | String string |
--- | --- |
| hasOpticalLayer | String string |
--- | --- |
| hasUncommissionedServerPhysicalConnections | String string |
--- | --- |
| connectionDirection | String string |
--- | --- |
| commissioningStatus | String string |
--- | --- |
| isRD | String string |
--- | --- |
| is3rdPartyLink | String string |
--- | --- |
| thirdPartyName | String string |
--- | --- |
| thirdPartyDesc | String string |
--- | --- |
| nprTlId | String string |
--- | --- |
| sdhConnectionId | String string |
--- | --- |
| sdhClientId | String string |
--- | --- |
| isUsedInSdh | String string |
--- | --- |
| fdn | String string |
--- | --- |
| mismatchType | String string |
--- | --- |
| clientRouteState | String string |
--- | --- |
| createdBy | String string |
--- | --- |
| mostRecentNote | String string |
--- | --- |
| endpoints | Integer integer |
--- | --- |
| inconsistentMismatchType | String string |
--- | --- |
| inconsistentAcknowledgedBy | String string |
--- | --- |
| inconsistentEventDate | String string |
--- | --- |
| inconsistentAckDate | String string |
--- | --- |
| size | HashMap«string,string» HashMap«string,string» |
--- | --- |
| position | HashMap«string,string» HashMap«string,string» |
--- | --- |
| assignedPortAddress | String string |
--- | --- |
| assignedPortNeName | String string |
--- | --- |
| tpId | String string |
--- | --- |
| isL0 | String string |
--- | --- |
| isL1 | String string |
--- | --- |
| isL0CRRD | String string |
--- | --- |
| isCurrentRouteRD | String string |
--- | --- |
| trailConnectionIdL0CR | String string |
--- | --- |
| tpEffectiveRate | String string |
--- | --- |
| timeSlots_numTotal | String string |
--- | --- |
| timeSlots_numUsed | String string |
--- | --- |
| timeSlots_numRsvd | String string |
--- | --- |
| timeSlots_numFree | String string |
--- | --- |
| timeSlots | array[PayloadSlotObject] PayloadSlotObject |
--- | --- |
| serverConnId | Long long |
--- | --- |
| serverConnectionCategory | String string |
--- | --- |
| serverProtectionType | String string |
--- | --- |
| serverConnectionRate | String string |
--- | --- |
| portType | String string |
--- | --- |
| edgeHoRelation | String string |
--- | --- |
| portPrimaryState | String string |
--- | --- |
| portSecondaryState | String string |
--- | --- |
| connId | Long long |
--- | --- |
| isSlteSupported | String string |
--- | --- |
| isOtdrSupported | String string |
--- | --- |
| allowAsonResources | String string |
--- | --- |
| switchCapability | String string |
--- | --- |
| scId | String string |
--- | --- |
| band | String string |
--- | --- |
| tsCount | String string |
--- | --- |
| bandwidth | String string |
--- | --- |
| gridtype | String string |
--- | --- |
| associatednprtlid | Integer integer |
--- | --- |
| protectionSummaryStatus | String string |
--- | --- |
| inconsistentPgInfo | String string |
--- | --- |
| aSwitchLocation | String string |
--- | --- |
| aSwitchReason | String string |
--- | --- |
| zSwitchLocation | String string |
--- | --- |
| zSwitchReason | String string |
--- | --- |
| networkHoldOffTime | String string |
--- | --- |
| networkProtectedProtectionMethod | String string |
--- | --- |
| networkProtectingProtectionMethod | String string |
--- | --- |
| networkProtectionType | String string |
--- | --- |
| networkReversionMode | String string |
--- | --- |
| networkSignalDegrade | String string |
--- | --- |
| networkWaitToRestoreTime | String string |
--- | --- |
| networkSwitchMode | String string |
--- | --- |
| clientHoldOffTime | String string |
--- | --- |
| clientProtectedProtectionMethod | String string |
--- | --- |
| clientProtectingProtectionMethod | String string |
--- | --- |
| clientProtectionType | String string |
--- | --- |
| clientReversionMode | String string |
--- | --- |
| clientSignalDegrade | String string |
--- | --- |
| clientWaitToRestoreTime | String string |
--- | --- |
| clientSwitchMode | String string |
--- | --- |
| encoding | String string |
--- | --- |
| autoInService | String string |
--- | --- |
| autoInServiceTimer | String string |
--- | --- |
| omsClientId | String string |
--- | --- |
| omsClientName | String string |
--- | --- |
| isDarkFiberAssociated | String string |
--- | --- |
| fiberAscStatus | String string |
--- | --- |
| isOtdrExternalSupported | String string |
--- | --- |
| otdrSummary | String string |
--- | --- |
| lineGranularity | Long long |
--- | --- |
| containerType | String string |
--- | --- |
| opsaRevertiveMode | String string |
--- | --- |
| opsaWaitToRestoreTime | String string |
--- | --- |
| opsbRevertiveMode | String string |
--- | --- |
| opsbWaitToRestoreTime | String string |
--- | --- |
| baseLineValueOPT | String string |
--- | --- |
| baseLineValueOPR | String string |
--- | --- |
| transmitPower | String string |
--- | --- |
| receivePower | String string |
--- | --- |
| singleFiberChannelPlan | String string |
--- | --- |
| olcState | String string |
--- | --- |
| neModel | String string |
--- | --- |
| switchableLayer | String string |
--- | --- |
| externalEML | String string |
--- | --- |
| spectrumWidth | String string |
--- | --- |
| dmValue | Long long |
--- | --- |
| dmValueProtection | Long long |
--- | --- |
| dmTimestamp | String string |
--- | --- |
| dmStatus | String string |
--- | --- |
| revertiveMode | String string |
--- | --- |
| isEline | String string |
--- | --- |
| scheduledJobs | String string |
--- | --- |
| lineModeProfileDescription | String string |
--- | --- |
| linkSpan | String string |
--- | --- |
| discrepancy | Integer integer |
--- | --- |
| invariantConnID | String string |
--- | --- |
| reversionGroupName | String string |
--- | --- |
| noofCarrier | String string |
--- | --- |
| otSigTunnelId | String string |
--- | --- |
| mainActiveL1CP | String string |
--- | --- |
| spareActiveL1CP | String string |
--- | --- |
| lineModeProfileId | String string |
--- | --- |
Entry«int,ConnectionInventoryResponse»
Name |
Type |
Description |
Enum |
|---|---|---|---|
| key | ConnectionInventoryResponse ConnectionInventoryResponse |
--- | --- |
Entry«string,long»
Name |
Type |
Description |
Enum |
|---|---|---|---|
| key | Long long |
--- | --- |
Entry«string,Map«string,long»»
Name |
Type |
Description |
Enum |
|---|---|---|---|
| key | array[Entry«string,long»] Entry«string,long» |
--- | --- |
HashMap«string,string»
Name |
Type |
Description |
Enum |
|---|
InsertNodeData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nwTransfType | String string |
--- | [insertNode, removeNode, bulkMoveTraffic] |
| oldPhysicalLinkNcId | Long long |
--- | --- |
| oldPhysicalLinkName | String string |
--- | --- |
| progressState | String string |
--- | [NotStarted, InProgress, Partial, Failed, Completed, NA] |
| oldPhysicalLinkNprId | Long long |
--- | --- |
| originalA1Tp | Long long |
--- | --- |
| originalZ1Tp | Long long |
--- | --- |
| originalA2Tp | Long long |
--- | --- |
| originalZ2Tp | Long long |
--- | --- |
| originalA1TpName | String string |
--- | --- |
| originalZ1TpName | String string |
--- | --- |
| originalA2TpName | String string |
--- | --- |
| originalZ2TpName | String string |
--- | --- |
| aNodeHandle | Long long |
--- | --- |
| aNodeName | String string |
--- | --- |
| aNodeNprNeId | Long long |
--- | --- |
| aNodeNprCompNeId | Long long |
--- | --- |
| zNodeHandle | Long long |
--- | --- |
| zNodeName | String string |
--- | --- |
| zNodeNprNeId | Long long |
--- | --- |
| zNodeNprCompNeId | Long long |
--- | --- |
| otsDomain | String string |
--- | --- |
| newNodeLinkList | array[InsertNodeNewNodeLinkInfo] InsertNodeNewNodeLinkInfo |
--- | --- |
| removedPhysicalLinkIds | array[Long] long |
--- | --- |
| removedPhysicalLinkNames | array[String] string |
--- | --- |
| originalAEndPorts | array[OtnInsertNodePort] OtnInsertNodePort |
--- | --- |
| originalZEndPorts | array[OtnInsertNodePort] OtnInsertNodePort |
--- | --- |
InsertNodeUserSelection
Name |
Type |
Description |
Enum |
|---|---|---|---|
| fromNode | String string |
--- | --- |
| toNodeName | String string |
--- | --- |
| fromNodeName | String string |
--- | --- |
| fromPort | String string |
--- | --- |
| response | String string |
--- | --- |
| otsSelected | String string |
--- | --- |
| toPort | String string |
--- | --- |
| nodesSelected | String string |
--- | --- |
| toNode | String string |
--- | --- |
INwTransfEvent
Name |
Type |
Description |
Enum |
|---|---|---|---|
| mainStepState | String string |
--- | [NotStarted, InProgress, Partial, Failed, Completed, NA] |
| mainStep | String string |
--- | --- |
| stepState | String string |
--- | [NotStarted, InProgress, Partial, Failed, Completed, NA] |
| jobHandle | Long long |
--- | --- |
| transformType | String string |
--- | [insertNode, removeNode, bulkMoveTraffic] |
| step | String string |
--- | [INITIALIZED, PREPARE_STEP_VALIDATE, PREPARE_STEP_SET_OLCSTATE, PREPARE_STEP_REMOVE_NOMINAL_ROUTE, PREPARE_STEP_LOCK_OMS_LINK, PREPARE_STEP_UNASSIGN_NPA_LINK_DELETE_SNPP, PREPARE_STEP_UNASSIGN_NPA_LINK, PREPARE_STEP_LINK_TRANSFORM_PORTS_SNML, PREPARE_STEP_LINK_TRANSFORM_PORTS_WDM, ROLLBACK_STEP_LINK_TRANSFORM_PORTS_SNML, ROLLBACK_STEP_LINK_TRANSFORM_PORTS_WDM, ROLLBACK_ASSIGN_NPA_LINK_CREATE_SNPP, ROLLBACK_ASSIGN_NPA_LINK, ROLLBACK_UNLOCK_NPA_LINK, ROLLBACK_MODIFY_SNCS_WITH_OLD_ROUTE, ROLLBACK_OLCSTATE, DEPLOY_STEP_VALIDATE, DEPLOY_STEP_ASSIGN_NEW_LINKS_TO_NPA, DEPLOY_STEP_MODIFY_SNC, DEPLOY_STEP_COMPLETE_LINK_TRANSFORM] |
OtnI18nMessage
Name |
Type |
Description |
Enum |
|---|---|---|---|
| messageTime | Long long |
Message Time | --- |
| messageType | String string |
Message Type | [Info, Warning, Error] |
| messageUnformatted | String string |
Message Unformatted | --- |
| validPropertyResourceMessage | Boolean boolean |
--- | --- |
| messageId | String string |
Message Id | --- |
| messageParams | array[String] string |
Message Params | --- |
| message | String string |
Message | --- |
OtnInsertNodeNewDataResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| physicalConnId | String string |
--- | --- |
| physicalConnName | String string |
--- | --- |
| newPhysicalConnId1 | String string |
--- | --- |
| newPhysicalConnName1 | String string |
--- | --- |
| newPhysicalConnId2 | String string |
--- | --- |
| newPhysicalConnName2 | String string |
--- | --- |
| originalFromNode | String string |
--- | --- |
| originalFromNodeId | String string |
--- | --- |
| originalToNode | String string |
--- | --- |
| originalToNodeId | String string |
--- | --- |
| originalFromPorts | array[String] string |
--- | --- |
| originalToPorts | array[String] string |
--- | --- |
| nodeId | String string |
--- | --- |
| nodeName | String string |
--- | --- |
| aSidePortNames | array[String] string |
--- | --- |
| zSidePortNames | array[String] string |
--- | --- |
| nodeInfo | array[NodeInfo] NodeInfo |
--- | --- |
| otsInfo | array[ConnectionObject] ConnectionObject |
--- | --- |
| otsIdList | String string |
--- | --- |
| nodeIdList | String string |
--- | --- |
| message | String string |
--- | --- |
PayloadSlotObject
Name |
Type |
Description |
Enum |
|---|---|---|---|
| label | String string |
--- | --- |
| className | String string |
ClassName | --- |
| id | String string |
id | --- |
| key | String string |
Key | --- |
| guiLabel | String string |
GuiLabel | --- |
| parentId | String string |
ParentId | --- |
| hasChildren | String string |
HasChildren | --- |
| state | String string |
--- | --- |
| isCenterFrequencyForFlexGrid | String string |
--- | --- |
| effRate | String string |
--- | --- |
| objRef | BaseObject BaseObject |
--- | --- |