Operation

get /data/otn/3RPorts
get3RPorts (get3RPorts : /data/otn/3RPorts)
get3RPorts

Query parameters

Name

IsRequired

Description

neName required ---
nodeName optional ---
nodeId optional ---
nprNodeId required ---
rate optional ---
isLBand optional ---
isMultiLayerService optional ---

Return type
  • DeferredResult«Otn3RPortInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn3RPortInventoryResponse»
    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/connection/3RPorts
    get3RPorts (get3RPorts : /data/otn/connection/3RPorts)
    get3RPorts

    Query parameters

    Name

    IsRequired

    Description

    neName required ---
    nodeName optional ---
    nodeId optional ---
    nprNodeId required ---
    rate optional ---
    isLBand optional ---
    isMultiLayerService optional ---

    Return type
  • DeferredResult«Otn3RPortInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«Otn3RPortInventoryResponse»
    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/connection/connectionTP
    getEligiblePorts (getEligiblePorts : /data/otn/connection/connectionTP)
    getEligiblePorts

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate optional ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • DeferredResult«OtnConnectionPortTPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionPortTPInventoryResponse»
    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/connection/unTermConnectionTP
    getEligiblePorts (getEligiblePorts : /data/otn/connection/unTermConnectionTP)
    getEligiblePorts

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate optional ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • DeferredResult«OtnConnectionPortTPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionPortTPInventoryResponse»
    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/connectionTP
    getEligiblePorts (getEligiblePorts : /data/otn/connectionTP)
    getEligiblePorts

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate optional ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • DeferredResult«OtnConnectionPortTPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionPortTPInventoryResponse»
    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/unTermConnectionTP
    getEligiblePorts (getEligiblePorts : /data/otn/unTermConnectionTP)
    getEligiblePorts

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    showallports optional ---
    isOPSB optional ---
    isYcable optional ---
    isLBand optional ---
    rate optional ---
    objectType optional ---
    supportingRates optional ---
    container optional ---
    unterminated optional ---
    channelized optional ---
    portLabel optional ---

    Return type
  • DeferredResult«OtnConnectionPortTPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionPortTPInventoryResponse»
    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/port/fiberChars
    getLossDataForPorts (getLossDataForPorts : /data/otn/port/fiberChars)
    getLossDataForPorts

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional layout Wlt2_Response ---
    Query parameters

    Name

    IsRequired

    Description

    portId required ---
    connId optional ---
    connType optional ---
    direction optional ---
    band optional ---
    currentRouteIdList optional ---

    Return type
  • DeferredResult«TPInventoryResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«TPInventoryResponse»
    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/ODUjCTP
    getPortTimeslots (getPortTimeslots : /data/otn/ODUjCTP)
    getPortTimeslots

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    neId required ---
    nprNodeId optional ---
    rate required ---
    port optional ---
    containerRate required ---
    tpName required ---
    showAllTimeslots optional ---

    Return type
  • DeferredResult«TPAvailableTimeSlotResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«TPAvailableTimeSlotResponse»
    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/connection/timeSlots
    getPortTimeslots (getPortTimeslots : /data/otn/connection/timeSlots)
    getPortTimeslots

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    neId required ---
    nprNodeId optional ---
    rate required ---
    port optional ---
    containerRate required ---
    tpName required ---
    showAllTimeslots optional ---

    Return type
  • DeferredResult«TPAvailableTimeSlotResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«TPAvailableTimeSlotResponse»
    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/timeSlots
    getPortTimeslots (getPortTimeslots : /data/otn/timeSlots)
    getPortTimeslots

    Query parameters

    Name

    IsRequired

    Description

    neName optional ---
    nodeName optional ---
    nodeId optional ---
    neId required ---
    nprNodeId optional ---
    rate required ---
    port optional ---
    containerRate required ---
    tpName required ---
    showAllTimeslots optional ---

    Return type
  • DeferredResult«TPAvailableTimeSlotResponse»
  • Responses

    Response Messages

    Schema

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

    DeferredResult«Otn3RPortInventoryResponse»

    Name

    Type

    Description

    Enum

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

    DeferredResult«OtnConnectionPortTPInventoryResponse»

    Name

    Type

    Description

    Enum

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

    DeferredResult«TPAvailableTimeSlotResponse»

    Name

    Type

    Description

    Enum

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

    DeferredResult«TPInventoryResponse»

    Name

    Type

    Description

    Enum

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

    Otn3RPort

    Name

    Type

    Description

    Enum

    port1id Long long --- ---
    port2id Long long --- ---
    className String string --- ---
    label String string --- ---
    guiLabel String string --- ---
    key String string --- ---
    id Long long --- ---
    neId Long long --- ---
    neName String string --- ---
    port1Name String string --- ---
    port2Name String string --- ---
    rate String string --- ---
    band String string --- ---
    port2Id Long long --- ---
    port1Id Long long --- ---

    Otn3RPortInventoryResponse

    Name

    Type

    Description

    Enum

    nextTasks array[String] string --- ---
    items array[Otn3RPort] Otn3RPort --- ---

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

    OtnConnectionPortTPInventoryResponse

    Name

    Type

    Description

    Enum

    nextTasks array[String] string --- ---
    items array[OtnConnectionPortTP] OtnConnectionPortTP --- ---

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

    TimeSlotTuple

    Name

    Type

    Description

    Enum

    className String string --- ---
    key String string --- ---
    id Long long --- ---
    timeSlot Integer integer --- ---
    availability String string --- ---
    odujNum String string --- ---

    TPAvailableTimeSlotResponse

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

    TPInventoryResponse

    Name

    Type

    Description

    Enum

    requestId Long long --- ---
    reqCompletionStatus Integer integer --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    clientName String string --- ---
    mdcId String string --- ---
    sessionId String string --- ---
    timeout Long long --- ---
    nadString String string --- ---

    Wlt2_Response

    Name

    Type

    Description

    Enum

    connectionName String string --- ---
    connectionId Long long --- ---
    rate String string --- ---
    isProtected Boolean boolean --- ---
    protectionType String string --- ---
    isAsonRouted Boolean boolean --- ---
    serviceAZ array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    serviceZA array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    protectAZ array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    protectZA array[Wlt2_SignalPathContainer] Wlt2_SignalPathContainer --- ---
    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---

    Wlt2_SignalPathContainer

    Name

    Type

    Description

    Enum

    isLinkOTS Boolean boolean --- ---
    otu Wlt2_SignalPathOTU Wlt2_SignalPathOTU --- ---
    isNE Boolean boolean --- ---
    ne Wlt2_SignalPathNE Wlt2_SignalPathNE --- ---
    isCurrentRouteOCH Boolean boolean --- ---

    Wlt2_SignalPathNE

    Name

    Type

    Description

    Enum

    neName String string --- ---
    neId Long long --- ---
    neModel String string --- ---
    isBBOX Boolean boolean --- ---
    isCommunicating Boolean boolean --- ---
    frequency String string --- ---
    tp array[Wlt2_SignalPathTP] Wlt2_SignalPathTP --- ---
    ncName String string --- ---
    ncId Long long --- ---
    errorMsg String string --- ---

    Wlt2_SignalPathOTU

    Name

    Type

    Description

    Enum

    otuTrailId Long long --- ---
    connectionName String string --- ---
    rate String string --- ---
    isProtected Boolean boolean --- ---
    protectionType String string --- ---
    provisionableWavekey String string --- ---
    connectionCategory Integer integer --- ---
    otuStartingNe String string --- ---
    frequency String string --- ---
    band String string --- ---
    currentRouteIdList String string --- ---
    oduNcId Long long --- ---

    Wlt2_SignalPathPower

    Name

    Type

    Description

    Enum

    hasMeasuredPower Boolean boolean --- ---
    measPower String string --- ---
    expectedPowerMeasure String string --- ---
    expectedPowerDeviation String string --- ---
    hasTotalPower Boolean boolean --- ---
    totalPower String string --- ---
    hasTotalPowerL Boolean boolean --- ---
    totalPowerL String string --- ---
    hasWavekeys Boolean boolean --- ---
    wavekey1 String string --- ---
    wavekey2 String string --- ---
    powerManagementType String string --- ---
    osnrValue String string --- ---
    onsrValue String string --- ---
    gain String string --- ---
    channelId String string --- ---
    frequency String string --- ---

    Wlt2_SignalPathTP

    Name

    Type

    Description

    Enum

    isWtocmPowerMeasurementType Boolean boolean --- ---
    isWtocmPowerMeasurementTypeL Boolean boolean --- ---
    tpId Long long --- ---
    ctpId Long long --- ---
    tpName String string --- ---
    ctpName String string --- ---
    rate String string --- ---
    tpShortName String string --- ---
    xfpName String string --- ---
    cardName String string --- ---
    direction String string --- ---
    power Wlt2_SignalPathPower Wlt2_SignalPathPower --- ---
    nprTlId Long long --- ---
    wtdUsageType String string --- ---
    wtdUsageTypeL String string --- ---
    wtdMeasurementType String string --- ---
    powerManagementType String string --- ---
    minGain String string --- ---
    maxGain String string --- ---
    hasMeasurablePower Boolean boolean --- ---
    adjResult String string --- ---
    wtocmPowerMeasurementTypeL Boolean boolean --- ---
    wtocmPowerMeasurementType Boolean boolean --- ---