Operation

get /otn/NBI/containedPotentialTPs/{nprNeId}/{ptpName}
containedPotentialTPs (containedPotentialTPs : /otn/NBI/containedPotentialTPs/{nprNeId}/{ptpName})
containedPotentialTPs

Path parameters

Name

IsRequired

Description

Enum

nprNeId required nprNeId ---
ptpName required ptpName ---

Return type
  • NbiTPBrowserResponse
  • Responses

    Response Messages

    Schema

    200success NbiTPBrowserResponse
    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 /otn/NBI/physicalPorts/{nprNeId}
    getAllPtps (getAllPtps : /otn/NBI/physicalPorts/{nprNeId})
    getAllPtps

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNeId required nprNeId ---

    Return type
  • NbiTPBrowserResponse
  • Responses

    Response Messages

    Schema

    200success NbiTPBrowserResponse
    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 /otn/NBI/Connection/{invariantId}/timeslots/available
    getAvailableTimeSlotsOfConnection (getAvailableTimeSlotsOfConnection : /otn/NBI/Connection/{invariantId}/timeslots/available)
    getAvailableTimeSlotsOfConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---

    Return type
  • NbiProvisionableResponse
  • Responses

    Response Messages

    Schema

    200success NbiProvisionableResponse
    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 /otn/NBI/Connection/getConnection/{invariantId}
    getConnection (getConnection : /otn/NBI/Connection/getConnection/{invariantId})
    getConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data ---

    Return type
  • NbiProvisionableResponse
  • Responses

    Response Messages

    Schema

    200success NbiProvisionableResponse
    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 /otn/NBI/containingTps/{nprNeId}/{ctpNativeName}
    getContainingTps (getContainingTps : /otn/NBI/containingTps/{nprNeId}/{ctpNativeName})
    getContainingTps

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNeId required nprNeId ---
    ctpNativeName required ctpNativeName ---

    Return type
  • NbiTPBrowserResponse
  • Responses

    Response Messages

    Schema

    200success NbiTPBrowserResponse
    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 /otn/NBI/Connection/modifyASAP/{invariantId}
    modifyConnection (modifyConnection : /otn/NBI/Connection/modifyASAP/{invariantId})
    modifyConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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 /otn/NBI/Connection/modifySNC/{invariantId}
    modifyConnection (modifyConnection : /otn/NBI/Connection/modifySNC/{invariantId})
    modifyConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data NbiModifySNCReq ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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 /otn/NBI/Connection/{invariantId}
    modifyConnection (modifyConnection : /otn/NBI/Connection/{invariantId})
    modifyConnection

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data NbiModifyParamReq ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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 /otn/NBI/Connection/ModifyLabel/{connId}
    modifyConnectionLabel (modifyConnectionLabel : /otn/NBI/Connection/ModifyLabel/{connId})
    modifyConnectionLabel

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    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 /otn/NBI/Connection/switchData/{connId}
    retrieveConnectionSwitchData (retrieveConnectionSwitchData : /otn/NBI/Connection/switchData/{connId})
    retrieveConnectionSwitchData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • NbiSwitchDataResponse
  • Responses

    Response Messages

    Schema

    200success NbiSwitchDataResponse
    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 /otn/NBI/Connection/routeTopoData/{connId}
    retrieveRouteTopoLinkData (retrieveRouteTopoLinkData : /otn/NBI/Connection/routeTopoData/{connId})
    retrieveRouteTopoLinkData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • NbiTopoResponse
  • Responses

    Response Messages

    Schema

    200success NbiTopoResponse
    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 /otn/NBI/Connection/{invariantId}/switchData
    retrieveSwitchData (retrieveSwitchData : /otn/NBI/Connection/{invariantId}/switchData)
    retrieveSwitchData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId ---

    Return type
  • NbiSwitchDataResponse
  • Responses

    Response Messages

    Schema

    200success NbiSwitchDataResponse
    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 :

    Collection

    Name

    Type

    Description

    Enum

    DeferredResult«OtnConnectionResponse»

    Name

    Type

    Description

    Enum

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

    HashMap«string,object»

    Name

    Type

    Description

    Enum

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    LcData

    Name

    Type

    Description

    Enum

    invariantInfraConnId String string --- ---
    timeSlot String string --- ---
    role String string --- ---

    NbiModifyParamReq

    Name

    Type

    Description

    Enum

    requestId String string --- ---
    userId String string --- ---
    password String string --- ---
    assuranceParameters Object object --- ---
    miscConnectionParameters Object object --- ---
    transmissionParameters Object object --- ---
    connectionParameters Object object --- ---

    NbiModifySNCReq

    Name

    Type

    Description

    Enum

    requestId String string --- ---
    userId String string --- ---
    password String string --- ---
    operation String string --- ---
    roleToBeOperated String string --- ---
    lcDataList array[LcData] LcData --- ---
    rollback Boolean boolean --- ---
    ignoreAlarm Boolean boolean --- ---

    NbiProvisionableResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    data StringBuffer StringBuffer --- ---
    netConn NetworkConnection NetworkConnection --- ---
    dataMap Object object --- ---

    NbiSwitchDataResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    invariantConnId String string --- ---
    connId String string --- ---
    listOfAsonIds Collection Collection --- ---

    NbiTopoResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    topoData array[Map«string,string»] Map«string,string» --- ---

    NbiTPBrowserResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    tpList array[NbiTPData] NbiTPData --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    NbiTPData

    Name

    Type

    Description

    Enum

    nwInterfaceType Integer integer --- ---
    nodeId Long long --- ---
    nodeName String string --- ---
    neId Long long --- ---
    neName String string --- ---
    ptpId Long long --- ---
    ptpName String string --- ---
    tpId Long long --- ---
    tpName String string --- ---
    tpDisplayLabel String string --- ---
    ptpLayerRate Integer integer --- ---
    layerRate Integer integer --- ---
    tpType Integer integer --- ---
    effectiveRate String string --- ---
    frequency String string --- ---
    clientSel String string --- ---
    xfpName String string --- ---
    directionality String string --- ---
    nbiInterfaceName String string --- ---
    tpUserLabel String string --- ---
    signalType String string --- ---
    availability String string --- ---
    nprneid Long long --- ---
    interfaceName String string --- ---
    cardName String string --- ---
    derivedNodeName String string --- ---
    networkInterfaceType Integer integer --- ---

    NetworkConnection

    Name

    Type

    Description

    Enum

    SwitchCapability String string --- ---
    id Long long --- ---
    userLabel String string --- ---
    objectClass String string --- ---
    name String string --- ---
    alias String string --- ---
    a1TPData TPData TPData --- ---
    z1TPData TPData TPData --- ---
    a2TPData TPData TPData --- ---
    z2TPData TPData TPData --- ---
    componentId1 Long long --- ---
    componentId2 Long long --- ---
    connRate Integer integer --- ---
    shape Integer integer --- ---
    dir Integer integer --- ---
    objectType String string --- ---
    operState String string --- ---
    almState String string --- ---
    serverAlmState String string --- ---
    alarmProfileEnabled String string --- ---
    connectionState Integer integer --- ---
    svcState Integer integer --- ---
    almMonState Integer integer --- ---
    connectionCategory Integer integer --- ---
    connectionType Integer integer --- ---
    protectionType Integer integer --- ---
    displayProtectionType Integer integer --- ---
    protectionRole Integer integer --- ---
    nprTlId Long long --- ---
    sdhConnectionId Long long --- ---
    sdhClientId Long long --- ---
    customerName String string --- ---
    isUsedInSdh Boolean boolean --- ---
    tcmStatus Integer integer --- ---
    tcmASAP String string --- ---
    effectiveRate String string --- ---
    createdBy Integer integer --- ---
    omspTrailId Long long --- ---
    omspConnectionName String string --- ---
    wtocm String string --- ---
    signalType String string --- ---
    usedTimeSlot String string --- ---
    containerType String string --- ---
    band String string --- ---
    reservedBy Integer integer --- ---
    spectrumWidth Long long --- ---
    tsCount Integer integer --- ---
    totalRecordCount Integer integer --- ---
    thirdPartyDesc String string --- ---
    thirdPartyName String string --- ---
    orderId Long long --- ---
    orderNumber String string --- ---
    orderType Integer integer --- ---
    orderState Integer integer --- ---
    orderStackId Long long --- ---
    receivedDate Long long --- ---
    ncGroupId Long long --- ---
    ncGroupName String string --- ---
    ncGroupType Integer integer --- ---
    groupState Integer integer --- ---
    groupEntityType Integer integer --- ---
    groupClass Integer integer --- ---
    vsClientId Long long --- ---
    vsClientState Integer integer --- ---
    asapId Long long --- ---
    connectionLevel Integer integer --- ---
    extendedParams HashMap«string,object» HashMap«string,object» --- ---
    connectionParams HashMap«string,string» HashMap«string,string» --- ---
    inconsistentConnInfo NetworkConnectionMismatch NetworkConnectionMismatch --- ---
    serverProtectionType String string --- ---
    serverConnectionCategory Integer integer --- ---
    serverConnId Long long --- ---
    serverConnectionRate String string --- ---
    allowAsonResources String string --- ---
    hasAsonResources String string --- ---
    lineGranularity Long long --- ---
    opsaRevertiveMode String string --- ---
    opsaWaitToRestoreTime String string --- ---
    singleFiberChannelPlan String string --- ---
    olcState String string --- ---
    externalEML String string --- ---
    notesText String string --- ---
    bandwidth String string --- ---
    gridtype String string --- ---
    freqOffset Integer integer --- ---
    associatednprtlid Integer integer --- ---
    dmValue String string --- ---
    dmValueProtection String string --- ---
    dmTimestamp String string --- ---
    dmStatus String string --- ---
    latency String string --- ---
    revertiveMode String string --- ---
    clientRevertiveMode String string --- ---
    sbnConnParamRevertiveMode String string --- ---
    isEline String string --- ---
    linkUtilThreshold String string --- ---
    profileId String string --- ---
    waveKeyType String string --- ---
    waveKeyConfig String string --- ---
    isYProtected String string --- ---
    frequencies String string --- ---
    pm24h String string --- ---
    pm15m String string --- ---
    nimEnabled String string --- ---
    linkUtilRatio Long long --- ---
    linkUtilProfile String string --- ---
    clientRouteState String string --- ---
    encoding String string --- ---
    sbnConnParamScId String string --- ---
    autoInService String string --- ---
    autoInServiceTimer String string --- ---
    scheduledJobs String string --- ---
    switchCapability String string --- ---
    otdrSupported Long long --- ---
    slteSupported Long long --- ---
    networkRevertiveMode String string --- ---
    otnObjectName String string --- ---
    objectId Double double --- ---
    implementingClassName String string --- ---
    objectIdClass Class«object» Class«object» --- ---

    NetworkConnectionMismatch

    Name

    Type

    Description

    Enum

    eventDate Date DateTime --- ---
    ackDate Date DateTime --- ---
    acknowledgedBy String string --- ---
    mismatchType String string --- ---

    OtnConnectionResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---
    connectionName String string --- ---
    connectionId Integer integer --- ---
    orderNumber String string --- ---
    orderId String string --- ---
    orderStep Integer integer --- ---
    id String string --- ---
    errorField String string --- ---
    errorValue String string --- ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageType String string --- [Info, Warning, Error]
    messageUnformatted String string --- ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageId String string --- ---
    messageParams array[String] string --- ---
    messageTime Long long --- ---
    message String string --- ---

    StringBuffer

    Name

    Type

    Description

    Enum

    TPData

    Name

    Type

    Description

    Enum

    nwInterfaceType Integer integer --- ---
    isCapableOfPmMonitoringPort Boolean boolean --- ---
    isTerminalLoopbackSupportedTp Boolean boolean --- ---
    isFacilityLoopbackSupportedTp Boolean boolean --- ---
    hasLoopback Boolean boolean --- ---
    nodeId Long long --- ---
    nodeName String string --- ---
    neId Long long --- ---
    neName String string --- ---
    ptpId Long long --- ---
    ptpName String string --- ---
    tpId Long long --- ---
    tpName String string --- ---
    tpDisplayLabel String string --- ---
    ptpLayerRate Integer integer --- ---
    layerRate Integer integer --- ---
    tpType Integer integer --- ---
    effectiveRate String string --- ---
    frequency String string --- ---
    clientSel String string --- ---
    xfpName String string --- ---
    displayEdgeOnNe String string --- ---
    directionality String string --- ---
    nbiInterfaceName String string --- ---
    tpUserLabel String string --- ---
    parentTpType Integer integer --- ---
    signalType String string --- ---
    neModel String string --- ---
    neSoftwareVersion String string --- ---
    almState String string --- ---
    baseLineValueOPT String string --- ---
    baseLineValueOPR String string --- ---
    transmitPower String string --- ---
    receivePower String string --- ---
    encoding String string --- ---
    waveShape String string --- ---
    primaryState String string --- ---
    secondaryState String string --- ---
    wtdUsageType String string --- ---
    wtdUsageTypeL String string --- ---
    ingressMeasType String string --- ---
    egressMeasType String string --- ---
    powerManagementType String string --- ---
    loopbackType String string --- ---
    phaseEncoding String string --- ---
    bandwidth String string --- ---
    oduKPort String string --- ---
    cardName String string --- ---
    cardMode String string --- ---
    cardInterworkingMode String string --- ---
    terminalLoopbackSupportedPort Boolean boolean --- ---
    facilityLoopbackSupportedPort Boolean boolean --- ---
    derivedNodeName String string --- ---
    networkInterfaceType Integer integer --- ---
    capableOfPmMonitoringPort Boolean boolean --- ---