Operation
post /esmService/topoService/abortERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/allocateERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/dbDeleteERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/deAllocateERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/deleteERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/deleteERPScheduledRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/ForceDeployERPScheduledRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/lockERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/modifyERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ERPDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/modifyERPScheduledRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ERPDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/moveBackToAllocateERPScheduledRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/moveToAllocateERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/MoveToDeployERPScheduledRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/planERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ERPDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/schedDeployERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ERPDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/activateERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/deactivateERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | erpIdHolder | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/switchERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/topoService/testServiceTopoRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Responses
Response Messages |
Schema |
|---|---|
| 200 | --- |
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
*/*
External Docs
Operation
post /esmService/topoService/unlockERPRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
nERPIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Entry«string,ArrayList«int»»
Name |
Type |
Description |
Enum |
|---|---|---|---|
| key | array[Integer] integer |
--- | --- |
ERPDataRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| resp | nERPInstMapper nERPInstMapper |
--- | --- |
| oam | nOAMInstMapper nOAMInstMapper |
--- | --- |
| response | ResponseHeader ResponseHeader |
--- | --- |
| schedReqMapper | SchedReqMapper SchedReqMapper |
--- | --- |
N_MA_Data
Name |
Type |
Description |
Enum |
|---|---|---|---|
| maId | Long long |
--- | --- |
| format | String string |
--- | --- |
| maName | String string |
--- | --- |
| ccmInterval | Integer integer |
--- | --- |
| mhfCreation | String string |
--- | --- |
| mepData | N_MEP_Data N_MEP_Data |
--- | --- |
| remoteMepDataList | array[E_OAM_RemoteMepData] E_OAM_RemoteMepData |
--- | --- |
| manameTpId | array[Entry«string,ArrayList«int»»] Entry«string,ArrayList«int»» |
--- | --- |
N_MD_Data
Name |
Type |
Description |
Enum |
|---|---|---|---|
| mdId | Long long |
--- | --- |
| mdFormat | String string |
--- | --- |
| mdLevel | Integer integer |
--- | --- |
| maData | N_MA_Data N_MA_Data |
--- | --- |
| type | String string |
--- | [SERVICE, ERP, QOS, ERP_TEMPLATE, SERVICE_TEMPLATE, INVALID, LAG, MCLAG, MPLSTP_NPA_TEMPLATE, MPLSTP_NPA, MPLSTP_TUNNEL, MPLSTP_TUNNEL_TEMPLATE, MPLSTP_NPA_PACK, MPLSTP_CHANNEL, PACKET_SWITCH_TEMPLATE, PACKET_SWITCH, DEMARCATION, ETH_IBM_ERP, ELINE] |
| vsIdList | array[Integer] integer |
--- | --- |
| modifyReq | Boolean boolean |
--- | --- |
N_MEP_CCM_Data
Name |
Type |
Description |
Enum |
|---|
N_MEP_Data
Name |
Type |
Description |
Enum |
|---|---|---|---|
| upDirectionally | Boolean boolean |
--- | --- |
| interfaceType | Integer integer |
--- | --- |
| active | Boolean boolean |
--- | --- |
| controlMepEnabled | Boolean boolean |
--- | --- |
| lowestPriorityDeffect | Integer integer |
--- | --- |
| ccmEnable | Boolean boolean |
--- | --- |
| ccmPriority | Integer integer |
--- | --- |
| mepId | Long long |
--- | --- |
| aisData | N_MEP_AIS_Data N_MEP_AIS_Data |
--- | --- |
| ccmData | N_MEP_CCM_Data N_MEP_CCM_Data |
--- | --- |
| propagateHoldTime | Integer integer |
--- | --- |
| standbyMepShutdownEnabled | Boolean boolean |
--- | --- |
nERPId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| managementState | String string |
--- | --- |
| ringName | String string |
--- | --- |
| ringType | String string |
--- | --- |
| ringId | Long long |
--- | --- |
| ringAdminState | String string |
--- | --- |
| createTime | Long long |
--- | --- |
| description | String string |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| preProvCliCmd | String string |
--- | --- |
| postProvCliCmd | String string |
--- | --- |
nERPIdHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | RequestHeader RequestHeader |
--- | --- |
| req | nERPId nERPId |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| operationName | String string |
--- | --- |
| vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
nERPIdRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
| req | nERPId nERPId |
--- | --- |
| schedReqMapper | SchedReqMapper SchedReqMapper |
--- | --- |
nERPInstHolderMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | nRequestHeaderMapper nRequestHeaderMapper |
--- | --- |
| req | nERPInstMapper nERPInstMapper |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| oam | nOAMInstMapper nOAMInstMapper |
--- | --- |
| oamData | N_MD_Data N_MD_Data |
--- | --- |
| erpGraphHandler | Object object |
--- | --- |
| operationName | String string |
--- | --- |
| switchMap | nERPSwitchMapper nERPSwitchMapper |
--- | --- |
| holdTimeChange | Boolean boolean |
--- | --- |
| topologyChange | Boolean boolean |
--- | --- |
| userName | String string |
--- | --- |
| errorReason | String string |
--- | --- |
| cmdStatus | String string |
--- | --- |
| activate | Boolean boolean |
--- | --- |
nERPInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| ringName | String string |
--- | --- |
| ringOldName | String string |
--- | --- |
| ringType | String string |
--- | --- |
| author | String string |
--- | --- |
| ringDescription | String string |
--- | --- |
| reserveResource | Boolean boolean |
--- | --- |
| cvlanId | String string |
--- | --- |
| svlanId | String string |
--- | --- |
| ownerTPID | Integer integer |
--- | --- |
| ownerTPName | String string |
--- | --- |
| ownerNeName | String string |
--- | --- |
| neighbourTPID | Integer integer |
--- | --- |
| neighbourName | String string |
--- | --- |
| managementState | String string |
--- | --- |
| targetMgmtState | String string |
--- | --- |
| cfmData | Object object |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| sharedVpls | Integer integer |
--- | --- |
| erpRingId | Long long |
--- | --- |
| neDataList | array[nNEDataMapper] nNEDataMapper |
--- | --- |
| protectiondata | nProtectionParamsMapper nProtectionParamsMapper |
--- | --- |
| templateId | Integer integer |
--- | --- |
| subRingConfig | String string |
--- | --- |
| parentRingIds | String string |
--- | --- |
| propogateTopoChange | String string |
--- | --- |
| preProvCliCmd | String string |
--- | --- |
| postProvCliCmd | String string |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| maName | String string |
--- | --- |
| mdIndex | Long long |
--- | --- |
| maIndex | Long long |
--- | --- |
| linkType | String string |
--- | --- |
| transVsList | array[nTransVsDataMapper] nTransVsDataMapper |
--- | --- |
| transparentVsIdS | array[Integer] integer |
--- | --- |
| vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
nMAInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| remoteMepInstList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
| maName | String string |
--- | --- |
| maFormat | String string |
--- | --- |
| ccmInterval | String string |
--- | --- |
| mhfCreation | String string |
--- | --- |
| mep | nMEPInstMapper nMEPInstMapper |
--- | --- |
| remteMepList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
nMEPInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| upDirectionally | Boolean boolean |
--- | --- |
| interfaceType | String string |
--- | --- |
| active | Boolean boolean |
--- | --- |
| controlMepEnabled | Boolean boolean |
--- | --- |
| lowestPriorityDeffect | String string |
--- | --- |
| propagateHoldTime | Integer integer |
--- | --- |
| standbyMepShutdownEnabled | Boolean boolean |
--- | --- |
| ccm | nMepCCMInstMapper nMepCCMInstMapper |
--- | --- |
| ais | nMepAISInstMapper nMepAISInstMapper |
--- | --- |
nNEDataMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| ringId | Long long |
--- | --- |
| ringName | String string |
--- | --- |
| ringType | String string |
--- | --- |
| owner | Integer integer |
--- | --- |
| neighbour | Integer integer |
--- | --- |
| portRole | String string |
--- | --- |
| ringNodeHandle | Integer integer |
--- | --- |
| ringNode | String string |
--- | --- |
| ringPortHandle | Integer integer |
--- | --- |
| ringPort | String string |
--- | --- |
| ringPortPrimaryState | String string |
--- | --- |
| ringPortUserLabel | String string |
--- | --- |
| ringLinkHandle | Integer integer |
--- | --- |
| ringLink | String string |
--- | --- |
| farEndNodeHandle | Integer integer |
--- | --- |
| farEndNode | String string |
--- | --- |
| farEndPortHandle | Integer integer |
--- | --- |
| farEndPort | String string |
--- | --- |
| farEndPortPrimaryState | String string |
--- | --- |
| farEndPortUserLabel | String string |
--- | --- |
| ownerNEPort | String string |
--- | --- |
| ownerLink | String string |
--- | --- |
| linkState | Integer integer |
--- | --- |
| ringNodeVSID | Integer integer |
--- | --- |
| farEndNodeVSID | Integer integer |
--- | --- |
| cRingIdL | String string |
--- | --- |
| linkType | String string |
--- | --- |
| otnLinkId | Integer integer |
--- | --- |
| connectionRate | Integer integer |
--- | --- |
| internalConnId | Integer integer |
--- | --- |
| operationalState | String string |
--- | --- |
| operationState | String string |
--- | --- |
| ownerRPLLink | String string |
--- | --- |
| linkId | Integer integer |
--- | --- |
| linkStateUi | String string |
--- | --- |
| srcPacketSwitchName | String string |
--- | --- |
| srcPsId | Integer integer |
--- | --- |
| sinkPacketSwitchName | String string |
--- | --- |
| sinkPsId | Integer integer |
--- | --- |
| cirUnit | String string |
--- | --- |
| availableCir | String string |
--- | --- |
| consumedCir | String string |
--- | --- |
| linkRate | String string |
--- | --- |
| linkRateMbps | String string |
--- | --- |
| aPortOrLagDescription | String string |
--- | --- |
| zPortOrLagDescription | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| id | String string |
--- | --- |
| sinkVNE | Boolean boolean |
--- | --- |
| srcVNE | Boolean boolean |
--- | --- |
| vneInvolved | Boolean boolean |
--- | --- |
| ringWithTransNode | Boolean boolean |
--- | --- |
nOAMInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| templateName | String string |
--- | --- |
| mdLevel | Integer integer |
--- | --- |
| mdFormat | String string |
--- | --- |
| maInst | nMAInstMapper nMAInstMapper |
--- | --- |
| elementaryMepList | array[ElementaryMep] ElementaryMep |
--- | --- |
nProtectionParamsMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| revertive | Boolean boolean |
--- | --- |
| guardtime | Integer integer |
--- | --- |
| revertTime | Integer integer |
--- | --- |
| protectionSwitchState | String string |
--- | --- |
| templateId | Integer integer |
--- | --- |
| holdUpTime | Integer integer |
--- | --- |
| holdDownTime | Integer integer |
--- | --- |
| holdTimeType | String string |
--- | --- |
nTransVsDataMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| ringNode | String string |
--- | --- |
| ringPack | String string |
--- | --- |
| transNode | Boolean boolean |
--- | --- |
| ringLink | String string |
--- | --- |
| rplTransPort | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| id | String string |
--- | --- |
| srcOrSinkTPID | Integer integer |
--- | --- |
ResponseHeader
Name |
Type |
Description |
Enum |
|---|---|---|---|
| req | RequestHeader RequestHeader |
--- | --- |
| errorReason | String string |
--- | --- |
| errorCode | String string |
--- | --- |
| message | String string |
--- | --- |
| cmdStatus | String string |
--- | --- |
| opMsg | String string |
--- | --- |
| msgCode | String string |
--- | --- |
| parameters | array[String] string |
--- | --- |
| paramCount | Integer integer |
--- | --- |
| objectId | Integer integer |
--- | --- |
| jobName | String string |
--- | --- |
| objectType | Integer integer |
--- | --- |
SchedReqMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| jobName | String string |
--- | --- |
| jobDescription | String string |
--- | --- |
| trigger | SchedTriggerMapper SchedTriggerMapper |
--- | --- |
| username | String string |
--- | --- |
Void
Name |
Type |
Description |
Enum |
|---|