Operation

post /data/otn/txTemplate/deleteTXtemplate
deleteTXtemplate (deleteTXtemplate : /data/otn/txTemplate/deleteTXtemplate)
deleteTXtemplate

Request body

Name

IsRequired

Description

Data Type

Enum

body optional httpSession HttpSession ---
body2 optional locale Locale ---
Query parameters

Name

IsRequired

Description

templatename required ---

Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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 /data/otn/Connection/Params
    getContextBasedTxParams (getContextBasedTxParams : /data/otn/Connection/Params)
    getContextBasedTxParams

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional connReq OtnConnectionRequest ---

    Return type
  • DeferredResult«OtnEndPointResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnEndPointResponse»
    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 /data/otn/Connection/pluggableModule
    getPluggableModuleType (getPluggableModuleType : /data/otn/Connection/pluggableModule)
    getPluggableModuleType

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional connReq OtnEndPointPluggableModuleReq ---

    Return type
  • DeferredResult«OtnPluggableModuleResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnPluggableModuleResponse»
    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 /data/otn/txtemplates/modify
    modifyTXTemplate (modifyTXTemplate : /data/otn/txtemplates/modify)
    modifyTXTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional description TXTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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

    get /data/otn/txTemplate
    retrieveTXTemplate (retrieveTXTemplate : /data/otn/txTemplate)
    retrieveTXTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional locale Locale ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    get /data/otn/txTemplateDetails
    retrieveTXTemplateDetails (retrieveTXTemplateDetails : /data/otn/txTemplateDetails)
    retrieveTXTemplateDetails

    Query parameters

    Name

    IsRequired

    Description

    templatename required ---
    templateid optional ---

    Return type
  • ConnectionInventoryResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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 /data/otn/txtemplates/saveas
    saveAsTXTemplate (saveAsTXTemplate : /data/otn/txtemplates/saveas)
    saveAsTXTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional description TXTemplateData ---

    Return type
  • DeferredResult«OtnSyncSwitchResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnSyncSwitchResponse»
    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;charset=UTF-8

    External Docs
    See Also :

    ConnectionInventoryResponse

    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 --- ---
    nextTasks array[String] string --- ---
    items array[Object] object --- ---
    data array[Object] object --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    DeferredResult«OtnEndPointResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnPluggableModuleResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«OtnSyncSwitchResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    HashMap

    Name

    Type

    Description

    Enum

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    OtnConnectionPortTP

    Name

    Type

    Description

    Enum

    portid Long long --- ---
    className String string --- ---
    label String string --- ---
    guiLabel String string --- ---
    key String string --- ---
    id Long long --- ---
    neId Long long --- ---
    neName String string --- ---
    neLabel String string --- ---
    neModel String string --- ---
    nodeName String string --- ---
    portName String string --- ---
    rate String string --- ---
    type String string --- ---
    cardName String string --- ---
    availability String string --- ---
    frequency String string --- ---
    rxFrequency String string --- ---
    oprMode String string --- ---
    frequencyType String string --- ---
    layerRate Integer integer --- ---
    direction Integer integer --- ---
    timeslot Integer integer --- ---
    alarmState Integer integer --- ---
    ptpId Long long --- ---
    ptpName String string --- ---
    ptpRate String string --- ---
    connectionId Long long --- ---
    connectionName String string --- ---
    connectionRate String string --- ---
    port String string --- ---
    portGrpMode String string --- ---
    odukPort String string --- ---
    portId Long long --- ---

    OtnConnectionRequest

    Name

    Type

    Description

    Enum

    encoding String string --- ---
    ASONRouted String string ASON Routed (Mandatory); True: Control Plane Connection(ASON), False: Managed Plane Connection; Enum True False ---
    Latency String string --- ---
    MRNTunnel String string MRN Tunnel(Mandatory); True: ASON-Logical Link Connection, False: for all other type of connections ; Enum True False ---
    ASONConnectionType String string ASON Connection Type(Mandatory) : noTunnel-Managed Plane Connection, UntermTunnel-Logical Link(ASON), TermTunnel-Control Plane Connection(ASON) Enum noTunnel UntermTunnel TermTunnel ---
    fromne1_AdditionalInfo HashMap«string,string» HashMap«string,string» --- ---
    transmissionmode String string --- ---
    LOSPropagation String string LOS Propagation (Mandatory) Enum AendOnly (A End Laser On) ZendOnly (Z End Laser On) BothAZ (Both A and Z End Laser On) NeitherAZ (Both A and Z End Laser Off) UseNEValue ---
    ssfDelayTimer String string --- ---
    ProvisionedBitRate String string --- ---
    ProvisionedBitRateDsr String string --- ---
    Odu4InterworkingMode String string --- ---
    PayloadTypeMismatchResponse String string --- ---
    mappingmode String string --- ---
    EncapsulationMode String string --- ---
    fromwkPort1XFP String string --- ---
    fromprotPort1XFP String string --- ---
    towkPort1XFP String string --- ---
    toprotPort1XFP String string --- ---
    otherFromprotPort1XFP String string --- ---
    otherToprotPort1XFP String string --- ---
    requestId Long long --- ---
    templateId Long long --- ---
    eventServerUrl String string --- ---
    eventChannel String string --- ---
    connshape String string --- ---
    customerName String string --- ---
    connectionname String string --- ---
    connectionalias String string --- ---
    serviceratetype String string --- ---
    servicerate String string --- ---
    trailrate String string --- ---
    bandwidth String string --- ---
    cirrate String string --- ---
    eirrate String string --- ---
    cbs String string --- ---
    ebs String string --- ---
    cevlan String string --- ---
    svlan String string --- ---
    protectiontype String string --- ---
    fec String string --- ---
    waveShape String string --- ---
    phaseEncoding String string --- ---
    lineModeProfile String string --- ---
    lopc String string --- ---
    allowAsonResources String string --- ---
    lBandFreq String string --- ---
    subsea String string --- ---
    ntwSliceId String string --- ---
    latencyConstraintPolicy String string --- ---
    latencyValue String string --- ---
    createdByAson String string --- ---
    restoration String string --- ---
    aendworkport String string --- ---
    rollBack Boolean boolean --- ---
    omsProtectionMode String string --- ---
    opticalImpairmentRouting String string --- ---
    fromne1 String string --- ---
    fromport1 String string --- ---
    fromne2 String string --- ---
    fromport2 String string --- ---
    tone1 String string --- ---
    toport1 String string --- ---
    tone2 String string --- ---
    toport2 String string --- ---
    fromPort1XFP String string --- ---
    fromPort2XFP String string --- ---
    toPort1XFP String string --- ---
    toPort2XFP String string --- ---
    otherFromPort1XFP String string --- ---
    otherFromPort2XFP String string --- ---
    otherToPort1XFP String string --- ---
    otherToPort2XFP String string --- ---
    fromporttype1 String string --- ---
    fromporttype2 String string --- ---
    toporttype1 String string --- ---
    toporttype2 String string --- ---
    tone1_AdditionalInfo HashMap HashMap --- ---
    fromport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    fromport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    toport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    toport2_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    port1timeslot String string --- ---
    port2timeslot String string --- ---
    port3timeslot String string --- ---
    port4timeslot String string --- ---
    routing String string --- ---
    orderstep String string --- ---
    routedisplay String string --- ---
    containerrate String string --- ---
    lineRate String string --- ---
    signalType String string --- ---
    clientSel String string --- ---
    a1ClientSel String string --- ---
    z1ClientSel String string --- ---
    a2ClientSel String string --- ---
    z2ClientSel String string --- ---
    xmnActualBitRate String string --- ---
    polarization String string --- ---
    odukAZSrcTrace String string --- ---
    odukZASrcTrace String string --- ---
    odukTraceMismatchDectMode String string --- ---
    odukTraceMismatchAction String string --- ---
    xmnAZClientClassificationMode String string --- ---
    xmnZAClientClassificationMode String string --- ---
    fecEnable String string --- ---
    asymInterwk String string --- ---
    encryptionState String string --- ---
    encryptionNextKey String string --- ---
    encryptionWKAT String string --- ---
    encryptionSwitchOverToNextKey String string --- ---
    payloadType String string --- ---
    apsEnable String string --- ---
    ssmSupport String string --- ---
    outQl String string --- ---
    timeSlotL1 String string --- ---
    spectrumWidth String string --- ---
    txParamData array[OtnConnTxParams] OtnConnTxParams --- ---
    tcmLevel String string --- ---
    waitForServerRestoration String string --- ---
    preferredRestorationMode String string --- ---
    reversionMode String string --- ---
    maxlatency String string --- ---
    defaultsetuppriority String string --- ---
    defaultpriority String string --- ---
    includecolorprofile String string --- ---
    excludecolorprofile String string --- ---
    scId String string --- ---
    softRevertiveSncpMode String string --- ---
    softRevertiveSncpTimeout String string --- ---
    clientprotectiontype String string --- ---
    clientSwitchMode String string --- ---
    clientholdofftime String string --- ---
    clientprotectedMethod String string --- ---
    clientprotectingMethod String string --- ---
    clientsignaldegrade String string --- ---
    clientwaittime String string --- ---
    clientrevertivemode String string --- ---
    nwkprotectiontype String string --- ---
    nwkSwitchMode String string --- ---
    nwkholdofftime String string --- ---
    nwkprotectedMethod String string --- ---
    nwkprotectingMethod String string --- ---
    nwksignaldegrade String string --- ---
    nwkwaittime String string --- ---
    nwkrevertivemode String string --- ---
    asonsubntwkprttype String string --- ---
    pm15min String string --- ---
    pmdata15 String string --- ---
    direction15 String string --- ---
    tpmonitor15 String string --- ---
    reportinfo15 String string --- ---
    pm24hr String string --- ---
    pmdata24 String string --- ---
    direction24 String string --- ---
    tpmonitor24 String string --- ---
    reportinfo24 String string --- ---
    nimEnabled String string --- ---
    linkUtilProfile String string --- ---
    alarmEnable String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    a1osnr String string --- ---
    a2osnr String string --- ---
    z1osnr String string --- ---
    z2osnr String string --- ---
    a1sigosnr String string --- ---
    z1sigosnr String string --- ---
    routingeffort String string --- ---
    routefrequency String string --- ---
    routefrequency2 String string --- ---
    ordersensitive String string --- ---
    otnRoutingConstraints array[OtnRoutingConstraints] OtnRoutingConstraints --- ---
    wavekeyConfig String string --- ---
    wavekeytype String string --- ---
    azwavekeypref String string --- ---
    zawavekeypref String string --- ---
    wavekeyassignment String string --- ---
    azwavekeypair String string --- ---
    zawavekeypair String string --- ---
    azwavekeyrekey String string --- ---
    zawavekeyrekey String string --- ---
    hassdx String string --- ---
    freq1 String string --- ---
    freq1azwavekeypair String string --- ---
    freq1zawavekeypair String string --- ---
    freq2 String string --- ---
    freq2azwavekeypair String string --- ---
    freq2zawavekeypair String string --- ---
    freq3 String string --- ---
    freq3azwavekeypair String string --- ---
    freq3zawavekeypair String string --- ---
    freq4 String string --- ---
    freq4azwavekeypair String string --- ---
    freq4zawavekeypair String string --- ---
    allowUncommissioned String string --- ---
    provisionwavekey String string --- ---
    connectionid Long long --- ---
    orderid Long long --- ---
    ordernumber String string --- ---
    rearrange String string --- ---
    reinstate String string --- ---
    operation String string --- ---
    hasopsb String string --- ---
    fromaside String string --- ---
    asidefromne String string --- ---
    asidefromport String string --- ---
    frombside String string --- ---
    bsidefromne String string --- ---
    bsidefromport String string --- ---
    toaside String string --- ---
    asidetone String string --- ---
    asidetoport String string --- ---
    tobside String string --- ---
    bsidetone String string --- ---
    bsidetoport String string --- ---
    opsbrevertivemode String string --- ---
    opsbrestoretime String string --- ---
    asidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    bsidefromport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    asidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    bsidetoport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    hasycable String string --- ---
    hasycable1 String string --- ---
    ycablefromne String string --- ---
    ycablefromprotne String string --- ---
    ycablefromwkport String string --- ---
    ycablefromprotPort String string --- ---
    ycablefromprotPort1 String string --- ---
    ycabletone String string --- ---
    ycabletoprotne String string --- ---
    ycabletowkport String string --- ---
    ycabletoprotport String string --- ---
    ycabletoprotport1 String string --- ---
    ycableswitchmode String string --- ---
    ycableprotectionmode String string --- ---
    ycableholdofftime String string --- ---
    ycablerevertivemode String string --- ---
    ycablerestoretime String string --- ---
    ycabletimeslot String string --- ---
    ycablesignaldegrade String string --- ---
    otherFromwkPort1XFP String string --- ---
    otherTowkPort1XFP String string --- ---
    ycablefromwkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycablefromprotPort_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletowkport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletoprotport_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycabletoprotport1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    ycablefromprotPort1_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    opsaRevertiveMode String string --- ---
    opsaWaitToRestore String string --- ---
    hasopsa String string --- ---
    serverAsonRouted String string --- ---
    encapsulationMode String string --- ---
    fromne1__AdditionalInfo HashMap HashMap --- ---
    encodingMode String string --- ---
    transmissionMode String string --- ---
    provisionedBitRate String string --- ---
    provisionedBitRateDsr String string --- ---
    odu4InterworkingMode String string --- ---
    payloadTypeMismatchResponse String string --- ---
    mappingMode String string --- ---
    routingtable array[OtnRoutingConstraints] OtnRoutingConstraints --- ---
    ycablefromprotport String string --- ---
    ycablefromwkPort1XFP String string --- ---
    ycablefromprotport1 String string --- ---
    ycablefromprotPort1XFP String string --- ---
    ycabletowkPort1XFP String string --- ---
    ycabletoprotPort1XFP String string --- ---
    otherFromProtPort1XFP String string --- ---
    otherToProtPort1XFP String string --- ---
    latency String string --- ---

    OtnConnTxParams

    Name

    Type

    Description

    Enum

    midCols array[String] string --- ---
    parameter String string --- ---
    name String string --- ---
    value String string --- ---
    currentValue String string --- ---
    discA String string --- ---
    discZ String string --- ---
    type String string --- ---
    editorArgs OtnTxParamEditorArgs OtnTxParamEditorArgs --- ---
    disabled Boolean boolean --- ---
    provisioningLayer String string --- ---

    OtnEndPointInfo

    Name

    Type

    Description

    Enum

    label String string --- ---
    name String string --- ---
    type String string --- ---
    value String string --- ---

    OtnEndPointInfoGroup

    Name

    Type

    Description

    Enum

    paramList array[OtnEndPointInfo] OtnEndPointInfo --- ---
    groupname String string --- ---

    OtnEndPointPluggableModuleReq

    Name

    Type

    Description

    Enum

    port_AdditionalInfo OtnConnectionPortTP OtnConnectionPortTP --- ---
    neName String string --- ---
    portName String string --- ---
    servicerate String string --- ---

    OtnEndPointResponse

    Name

    Type

    Description

    Enum

    groups array[OtnEndPointInfoGroup] OtnEndPointInfoGroup --- ---
    txParamTableData array[OtnTxParamTableFormat] OtnTxParamTableFormat --- ---

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

    OtnPluggableModuleResponse

    Name

    Type

    Description

    Enum

    plugModule String string --- ---

    OtnRoutingConstraints

    Name

    Type

    Description

    Enum

    id String string --- ---
    pk String string --- ---
    connid String string --- ---
    lccid String string --- ---
    name String string --- ---
    type String string --- ---
    col4 String string --- ---
    role String string --- ---
    aneid Integer integer --- ---
    aendName String string --- ---
    zneid Integer integer --- ---
    zendName String string --- ---
    lcnumber Integer integer --- ---
    dct Integer integer --- ---
    timeslot String string --- ---
    servername String string --- ---
    lcprotection String string --- ---
    layerrate String string --- ---
    frequency String string --- ---
    routeid String string --- ---
    portname1 String string --- ---
    portid1 String string --- ---
    portname2 String string --- ---
    portid2 String string --- ---
    nodeId String string --- ---
    nodeName String string --- ---
    regenIndex Integer integer --- ---
    connectionAvailability String string --- ---
    frequencyWithOffset String string --- ---
    logicalLinkConnId String string --- ---
    serverId String string --- ---

    OtnSyncSwitchResponse

    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 --- ---
    message String string --- ---
    timeout Long long --- ---
    nadString String string --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---

    OtnTxParamEditorArgs

    Name

    Type

    Description

    Enum

    options array[String] string --- ---
    maxlength Integer integer --- ---

    OtnTxParamTableFormat

    Name

    Type

    Description

    Enum

    midCols array[String] string --- ---
    parameter String string --- ---
    name String string --- ---
    currentValue String string --- ---
    type String string --- ---
    editorArgs OtnTxParamEditorArgs OtnTxParamEditorArgs --- ---
    provisioningLayer String string --- ---

    TXTemplateData

    Name

    Type

    Description

    Enum

    description String string --- ---
    createdDate String string --- ---
    userName String string --- ---
    templatename String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    txParamData String string --- ---