Operation

post /carrierEthLinks/dbDeleteSOAMInstance
dbDeleteSOAMInstance (dbDeleteSOAMInstance : /carrierEthLinks/dbDeleteSOAMInstance)
dbDeleteSOAMInstance

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData OtnElineLinkTemplateHolder ---

Return type
  • N_ServiceDataRespHolder
  • Responses

    Response Messages

    Schema

    200success N_ServiceDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /carrierEthLinks/scheduledConfigureSoamOnOtnElineLink
    scheduledConfigureSoamOnOtnElineLink (scheduledConfigureSoamOnOtnElineLink : /carrierEthLinks/scheduledConfigureSoamOnOtnElineLink)
    scheduledConfigureSoamOnOtnElineLink

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData OtnElineLinkTemplateHolder ---

    Return type
  • N_ServiceDataRespHolder
  • Responses

    Response Messages

    Schema

    200success N_ServiceDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    E_OAM_RemoteMepData

    Name

    Type

    Description

    Enum

    vsId Integer integer --- ---
    eMaId Integer integer --- ---
    eMdId Integer integer --- ---
    remoteMepIds array[Integer] integer --- ---

    ElementaryMep

    Name

    Type

    Description

    Enum

    mepId Integer integer --- ---
    maId Integer integer --- ---
    mdId Integer integer --- ---
    vsId Integer integer --- ---
    macAddress String string --- ---
    neName String string --- ---

    Entry«string,ArrayList«int»»

    Name

    Type

    Description

    Enum

    key array[Integer] integer --- ---

    MplstpAttributesData

    Name

    Type

    Description

    Enum

    pwStatusSignalEnabled String string --- ---
    pwControlChannelEnabled String string --- ---
    pwAcknowledgementEnabled String string --- ---
    epStandbySignallingMaster String string --- ---
    epStandbySignallingSlave String string --- ---
    pwRefreshTimer Long long --- ---
    pwRequestTimer Long long --- ---
    pwRetryTimer Long long --- ---
    pwTimeoutMultiplier Long long --- ---
    epRevertTimer Long long --- ---
    epActiveHoldDelay Long long --- ---

    N_END_END_OAM_DATA

    Name

    Type

    Description

    Enum

    nmlServiceId Long long --- ---
    neId Long long --- ---
    tpId Long long --- ---
    cvLan Long long --- ---
    autoGenVlanId Long long --- ---
    mclagConfigHandle Long long --- ---
    oamData N_MD_Data N_MD_Data --- ---
    oamEnabled Boolean boolean --- ---
    prevOamEnabled Boolean boolean --- ---

    N_EthportMapper

    Name

    Type

    Description

    Enum

    neName String string --- ---
    portName String string --- ---
    portRole String string --- ---
    portType String string --- ---
    tpID Integer integer --- ---
    endpointType String string --- ---
    mclagId Integer integer --- ---
    vsId Integer integer --- ---
    shgId Long long --- ---
    shgName String string --- ---
    shgDescription String string --- ---
    hubAndSpoke String string --- ---
    accessCVLANEnabled Boolean boolean --- ---
    accessSVLANEnabled Boolean boolean --- ---
    accessCVLAN String string --- ---
    accessSVLAN String string --- ---
    fragmentType Integer integer --- ---

    N_LINK_OAM_DATA

    Name

    Type

    Description

    Enum

    nmlServiceId Long long --- ---
    aNeId Long long --- ---
    aTpId Long long --- ---
    zNeId Long long --- ---
    zTpId Long long --- ---
    linkId Long long --- ---
    vlanId Long long --- ---
    autoGenVlanId Long long --- ---
    oamData N_MD_Data N_MD_Data --- ---
    oamEnabled Boolean boolean --- ---
    prevOamEnabled Boolean boolean --- ---
    presetRemoteMEPID Integer integer --- ---

    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_AIS_Data

    Name

    Type

    Description

    Enum

    enabled Boolean boolean --- ---
    levels array[Integer] integer --- ---
    priority Integer integer --- ---
    interval Integer integer --- ---

    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 --- ---

    N_PolicyId

    Name

    Type

    Description

    Enum

    policyName String string --- ---
    policyType String string --- ---
    policyId Long long --- ---
    bestPractice Boolean boolean --- ---
    nServiceHandle String string --- ---
    policyScope Integer integer --- ---
    templateType Integer integer --- ---
    jobTaskId Long long --- ---
    cirPirUnitReqd Boolean boolean --- ---

    N_PortPolicyIdMapper

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    port N_EthportMapper N_EthportMapper --- ---
    policyId N_PolicyId N_PolicyId --- ---
    activate Boolean boolean --- ---

    N_ServiceDataRespHolder

    Name

    Type

    Description

    Enum

    responseId ResponseHeader ResponseHeader --- ---
    response N_ServiceInstMapper N_ServiceInstMapper --- ---

    N_ServiceInstMapper

    Name

    Type

    Description

    Enum

    networkingTechnology String string --- ---
    autoRouting Boolean boolean --- ---
    pwStandby Boolean boolean --- ---
    segmentType String string --- ---
    tunnelDataList array[ServiceTunnelUIData] ServiceTunnelUIData --- ---
    templatePolicyName String string --- ---
    objId Long long --- ---
    serviceType String string --- ---
    serviceName String string --- ---
    serviceOldName String string --- ---
    author String string --- ---
    description String string --- ---
    svcParams ServiceParams ServiceParams --- ---
    vneScriptDataList array[VNEScriptData] VNEScriptData --- ---
    customerName String string --- ---
    cvlanId String string --- ---
    svlanId String string --- ---
    eTreeType String string --- ---
    trunkSvlanId String string --- ---
    branchSvlanId String string --- ---
    additionalInfo Object object --- ---
    serviceTemplateId Long long --- ---
    nmlRingNameList array[String] string --- ---
    hubList array[Integer] integer --- ---
    nmlLinkDataList array[OtnInterfaceLinkUIData] OtnInterfaceLinkUIData --- ---
    portQos array[N_PortPolicyIdMapper] N_PortPolicyIdMapper --- ---
    managementState String string --- ---
    targetManagementState String string --- ---
    reserveResource Boolean boolean --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    shgName String string --- ---
    shgDescription String string --- ---
    repProf15m String string --- ---
    repProf24h String string --- ---
    tcaProfName String string --- ---
    tcaProfOldName String string --- ---
    mplstpAttributesData MplstpAttributesData MplstpAttributesData --- ---
    cacCheck Boolean boolean --- ---
    warningValidateOverride Boolean boolean --- ---

    nRequestHeaderMapper

    Name

    Type

    Description

    Enum

    reqId String string --- ---
    clientName String string --- ---

    OtnElineLinkTemplateHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    templateId Long long --- ---
    templateName String string --- ---
    templatePath String string --- ---
    descr String string --- ---
    linkName String string --- ---
    linkRate String string --- ---
    linkId Long long --- ---
    a1NeId Integer integer --- ---
    z1NeId Integer integer --- ---
    a1TpId Integer integer --- ---
    z1TpId Integer integer --- ---
    a1TpName String string --- ---
    z1TpName String string --- ---
    serviceState String string --- ---
    linkType Integer integer --- ---
    soamConfigured Boolean boolean --- ---
    maIndex Long long --- ---
    pmStartTime Long long --- ---
    managementState String string --- ---
    preOamConfigured Boolean boolean --- ---
    fromManagementState Integer integer --- ---
    toManagementState Integer integer --- ---
    consistencyState Integer integer --- ---
    remark String string --- ---
    oamData N_MD_Data N_MD_Data --- ---
    mdIndex Long long --- ---
    pmState Integer integer --- ---
    pmStateEnabled Boolean boolean --- ---
    repProf15m String string --- ---
    repProf24h String string --- ---
    tcaProfName String string --- ---
    tcaProfOldName String string --- ---
    scheduler SchedReqMapper SchedReqMapper --- ---
    schedServiceData SchedServiceData SchedServiceData --- ---
    reqId nRequestHeaderMapper nRequestHeaderMapper --- ---
    req RequestHeader RequestHeader --- ---
    jobTaskId Long long --- ---
    endToEndOamDataList array[N_END_END_OAM_DATA] N_END_END_OAM_DATA --- ---
    linkOamDataList array[N_LINK_OAM_DATA] N_LINK_OAM_DATA --- ---
    elementaryMepList array[ElementaryMep] ElementaryMep --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    activate Boolean boolean --- ---

    OtnInterfaceLinkUIData

    Name

    Type

    Description

    Enum

    transportType String string --- ---
    srcGlobalID Long long --- ---
    srcNPAID Long long --- ---
    srcNodeID String string --- ---
    srcIsNPAConfigured Boolean boolean --- ---
    srcPrimaryState String string --- ---
    srcUserLabel String string --- ---
    linkBandWidth String string --- ---
    sinkGlobalID Long long --- ---
    sinkNPAID Long long --- ---
    sinkNodeID String string --- ---
    sinkIsNPAConfigured Boolean boolean --- ---
    sinkPrimaryState String string --- ---
    sinkUserLabel String string --- ---
    srcVSID Integer integer --- ---
    sinkVSID Integer integer --- ---
    connectionRate Integer integer --- ---
    internalConnId Integer integer --- ---
    srcLagPortMembers array[String] string --- ---
    sinkLagPortMembers array[String] string --- ---
    srcPortOrLagDescription String string --- ---
    sinkPortOrLagDescription String string --- ---
    orderid Integer integer --- ---
    aNetworkTechType Integer integer --- ---
    zNetworkTechType Integer integer --- ---
    oduFlexRate String string --- ---
    tsCount String string --- ---
    aNeVersion String string --- ---
    zNeVersion String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    sinkVNE Boolean boolean --- ---
    srcVNE Boolean boolean --- ---

    RequestHeader

    Name

    Type

    Description

    Enum

    respBeanRef String string --- ---
    selectiveSyncViaPolling Boolean boolean --- ---
    clientName String string --- ---
    reqId String string --- ---

    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 --- ---
    username String string --- ---
    trigger SchedTriggerMapper SchedTriggerMapper --- ---

    SchedServiceData

    Name

    Type

    Description

    Enum

    jobName String string --- ---
    jobDesc String string --- ---
    userName String string --- ---
    trigger SchedTriggerData SchedTriggerData --- ---

    SchedTriggerData

    Name

    Type

    Description

    Enum

    name String string --- ---
    deployNow String string --- ---
    type String string --- ---
    expression String string --- ---
    timeOffset String string --- ---

    SchedTriggerMapper

    Name

    Type

    Description

    Enum

    name String string --- ---
    deployNow String string --- ---
    type String string --- ---
    expression String string --- ---
    timeOffset String string --- ---

    ServiceParams

    Name

    Type

    Description

    Enum

    llf Integer integer --- ---
    l2pt Integer integer --- ---
    lacp Integer integer --- ---
    l2cp Integer integer --- ---
    eplOp2TunnelEnabled Integer integer --- ---
    fragmentType Integer integer --- ---
    vlanRangeEnabled Integer integer --- ---
    cvlan String string --- ---

    ServiceTunnelUIData

    Name

    Type

    Description

    Enum

    tunnelName String string --- ---
    tunnelId Integer integer --- ---
    priority Integer integer --- ---
    orderId Integer integer --- ---
    aVsId Integer integer --- ---
    zVsId Integer integer --- ---
    autogenerated_AToZLabel Integer integer --- ---
    autogenerated_ZToALabel Integer integer --- ---
    aNEName String string --- ---
    zNEName String string --- ---
    lagAssn String string --- ---
    lagAssnVsId Integer integer --- ---
    mclagName String string --- ---
    mclagId Integer integer --- ---
    isICB Boolean boolean --- ---

    VNEScriptData

    Name

    Type

    Description

    Enum

    NENAME String string --- ---
    SCRIPTNAME String string --- ---