Operation

get /otn/NBI/containedPotentialTPs/{nprNeId}/{ptpName}
to get all contained potential TP's for specified nprNeId and ptpName (containedPotentialTPs : /otn/NBI/containedPotentialTPs/{nprNeId}/{ptpName})
retuns all contained TP's for specified nprNeId and ptpName

Path parameters

Name

IsRequired

Description

Enum

nprNeId required nprNeId can be derived as id from '/data/npr/{table}'(table=nes) ---
ptpName required ptpName can be derived as ptpName from '/otn/NBI/physicalPorts/{nprNeId}' REST call ---

Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/containedPotentialTPs/12/11QPE24-1-10-C1

    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
    Example Response Data
    { "reqCompletionStatus": 11, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "tpList": [{ "nodeId": 0, "nodeName": null, "neId": 0, "neName": "siva3", "ptpId": 0, "ptpName": "11QPE24-1-10-C1", "tpId": 0, "tpName": "11QPE24-1-10-C1", "tpDisplayLabel": null, "ptpLayerRate": 20, "layerRate": 200, "tpType": 0, "effectiveRate": null, "frequency": null, "clientSel": null, "xfpName": null, "directionality": null, "nbiInterfaceName": "/dsr=1", "tpUserLabel": null, "nwInterfaceType": 0, "signalType": null, "availability": "0", "nprneid": 12, "networkInterfaceType": 0, "neportDisplayLabel": "siva3/11QPE24-1-10-C1", "derivedNodeName": "siva3" }], "successfulCompletion": true, "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllPtps : /otn/NBI/physicalPorts/{nprNeId}

  • Operation

    get /otn/NBI/physicalPorts/{nprNeId}
    to get all physical ports for given nprNeId (getAllPtps : /otn/NBI/physicalPorts/{nprNeId})
    returns all physical ports for given nprNeId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNeId required nprNeId can be derived as id from '/data/npr/{table}' (table=nes) REST call ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/physicalPorts/6

    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
    Example Response Data
    { "reqCompletionStatus": ?11, "requestId": ?0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": ?0, "moreToCome": false, "messages": [ ], "errcde": null, "errorParams": null, "tpList": [ { "nodeId": ?4, "nodeName": "NODE2_PHN", "neId": ?14, "neName": "NODE2_PHN", "ptpId": ?-1, "ptpName": "112SNA1-6-12-C1", "tpId": ?229, "tpName": "112SNA1-6-12-C1", "tpDisplayLabel": "112SNA1-6-12-C1", "ptpLayerRate": ?20, "layerRate": ?20, "tpType": ?0, "effectiveRate": null, "frequency": null, "clientSel": null, "xfpName": null, "directionality": "1", "nbiInterfaceName": "112SNA1-6-12-C1", "tpUserLabel": null, "nwInterfaceType": ?1, "signalType": null, "availability": null, "nprneid": ?6, "networkInterfaceType": ?1, "neportDisplayLabel": "NODE2_PHN/112SNA1-6-12-C1", "derivedNodeName": "NODE2_PHN" }, { "nodeId": ?4, "nodeName": "NODE2_PHN", "neId": ?14, "neName": "NODE2_PHN", "ptpId": ?-1, "ptpName": "112SNA1-6-12-L1", "tpId": ?103, "tpName": "112SNA1-6-12-L1", "tpDisplayLabel": "112SNA1-6-12-L1", "ptpLayerRate": ?20, "layerRate": ?20, "tpType": ?0, "effectiveRate": null, "frequency": null, "clientSel": null, "xfpName": null, "directionality": "1", "nbiInterfaceName": "112SNA1-6-12-L1", "tpUserLabel": null, "nwInterfaceType": ?1, "signalType": null, "availability": null, "nprneid": ?6, "networkInterfaceType": ?1, "neportDisplayLabel": "NODE2_PHN/112SNA1-6-12-L1", "derivedNodeName": "NODE2_PHN" } ], "successfulCompletion": true, "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /otn/NBI/Connection/{invariantId}/timeslots/available
    to retrieve available timeslots (getAvailableTimeSlotsOfConnection : /otn/NBI/Connection/{invariantId}/timeslots/available)
    to retrieve available timeslots for given invariant ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId can be fetched from '/data/otn/networkinventory/connectionstatus'REST call ---

    Return type
  • Nbi Provisionable Response
  • Responses

    Response Messages

    Schema

    200success Nbi Provisionable Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/Connection/1/timeslots/available

    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
    Example Response Data
    { "message": null, "status": "SUCCESS", "data": null, "netConn": null, "dataMap": { "availableTimeSlots": "/och=1" } }

    External Docs
    See Also :
  • getConnectionStatus : /data/otn/networkinventory/connectionstatus

  • Operation

    get /otn/NBI/containingTps/{nprNeId}/{ctpNativeName}
    to get all contained TP's for given nprNeId,ctpNativeName (getContainingTps : /otn/NBI/containingTps/{nprNeId}/{ctpNativeName})
    returns the contained TP for given nprNeId,ctpNativeName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNeId required nprNeId can be derived as id from '/data/npr/{table}'(table=nes) ---
    ctpNativeName required ctpNativeName can be derived as tpName from '/otn/NBI/physicalPorts/{nprNeId}' REST call ---

    Return type
  • Response
  • Responses

    Response Messages

    Schema

    200success Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/containingTps/12/11QPE24-1-10-C1

    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
    Example Response Data
    { "reqCompletionStatus": 11, "requestId": 0, "clientName": null, "clientLocation": null, "clientUser": null, "sessionId": "", "mdcId": null, "sequenceNum": 0, "moreToCome": false, "messages": [], "errcde": null, "errorParams": null, "tpList": [{ "nodeId": 11, "nodeName": "siva3", "neId": 26, "neName": "siva3", "ptpId": -1, "ptpName": null, "tpId": 42861, "tpName": "11QPE24-1-10-C1", "tpDisplayLabel": "11QPE24-1-10-C1", "ptpLayerRate": 0, "layerRate": 20, "tpType": 0, "effectiveRate": null, "frequency": null, "clientSel": null, "xfpName": null, "directionality": "1", "nbiInterfaceName": "11QPE24-1-10-C1", "tpUserLabel": null, "nwInterfaceType": 0, "signalType": null, "availability": null, "nprneid": 12, "networkInterfaceType": 0, "neportDisplayLabel": "siva3/11QPE24-1-10-C1", "derivedNodeName": "siva3" }], "successfulCompletion": true, "failedCompletion": false }

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllPtps : /otn/NBI/physicalPorts/{nprNeId}

  • Operation

    post /otn/NBI/Connection/ModifyLabel/{connId}
    to set user label (modifyConnectionLabel : /otn/NBI/Connection/ModifyLabel/{connId})
    to set user label for specified connection ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connection id can be retrieved as 'connId' from the REST call '/Connection/ModifyLabel/{connId}' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required data: is the payload data which have modified JSON object ---

    Return type
  • Otn connection Response
  • Responses

    Response Messages

    Schema

    200success Otn connection Response
    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}
    to retrieve the switchData by connection ID (retrieveConnectionSwitchData : /otn/NBI/Connection/switchData/{connId})
    Retrieve SwitchData for given connection Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • Nbi switch Data Response
  • Responses

    Response Messages

    Schema

    200success Nbi switch Data Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/Connection/switchData/1417

    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
    Example Response Data
    { message: null, status: "SUCCESS", invariantConnId: null, connId: "1417", pgswitchData: [ { nodeName: "DJ_NODE_PHN_100_56", nativeName: "11DPM12-24-7-C1", ObjectId: "232689", displayName: "11DPM12-24-7-C1", workingPortPTPDisplayName: "11DPM12-24-7-L1", workingPortType: "0", activePortCTPInterfaceName: "/odu0=1", pgRate: "200", protectionPortPTPDisplayName: "11DPM12-24-7-L2", protectionPortRef: "232623", workingPortCTPInterfaceName: "/odu0=1", reliablePortCTPInterfaceName: "/dsr=1", workingPortRef: "232661", protectionPortType: "0", meRef: "12", reliablePortType: "0", protectionGroupType: "PGT_SNCP", protectionPortCTPInterfaceName: "/odu0=1", activePortPTPDisplayName: "11DPM12-24-7-L1", switchReason: "SR_NO_REQUEST", activePortType: "0", reliablePortPTPDisplayName: "11DPM12-24-7-C1", activePortRef: "232661" }, { nodeName: "DJ_PHN_100_55", nativeName: "11DPM12-16-2-C1", ObjectId: "232398", displayName: "11DPM12-16-2-C1", workingPortPTPDisplayName: "11DPM12-16-2-L1", workingPortType: "0", activePortCTPInterfaceName: "/odu0=1", pgRate: "200", protectionPortPTPDisplayName: "11DPM12-16-2-L2", protectionPortRef: "232346", workingPortCTPInterfaceName: "/odu0=1", reliablePortCTPInterfaceName: "/dsr=1", workingPortRef: "232376", protectionPortType: "0", meRef: "10", reliablePortType: "0", protectionGroupType: "PGT_SNCP", protectionPortCTPInterfaceName: "/odu0=1", activePortPTPDisplayName: "11DPM12-16-2-L1", switchReason: "SR_NO_REQUEST", activePortType: "0", reliablePortPTPDisplayName: "11DPM12-16-2-C1", activePortRef: "232376" } ], listOfAsonIds: [ ] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /otn/NBI/Connection/routeTopoData/{connId}
    retrives the Route and Topo link for given Connection (retrieveRouteTopoLinkData : /otn/NBI/Connection/routeTopoData/{connId})
    get Route and toplinks for given connection Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be derived as Id from '/data/otn/connections'REST call ---

    Return type
  • Nbi Topological Response
  • Responses

    Response Messages

    Schema

    200success Nbi Topological Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/Connection/routeTopoData/127

    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
    Example Response Data
    { "message": null, "status": "SUCCESS", "topoData": [ { "Z1TpId": "33266", "A1TpDisplayLabel": "AHPHG-18-5-LINE", "Z1NeId": "27", "ALLPATHCOST": "20", "ConnectionRate": "30", "ALIAS": "130SCX10-OTS-01", "ImplSt": "ImplementationState_implemented", "OrderStackId": "126", "A2TpType": "0", "Z2TpInterfaceName": null, "ASONADMSTATE": "Not Applicable", "Z2NodeName": null, "OrderType": "2", "Z2NeId": "0", "Z2TpId": "0", "Z1NodeId": "10", "A2NodeName": null, "A1TpUserLabel": null, "Z2TpName": null, "A1NeName": "NODE-BA-01", "CREATIONTIME": "20160423084720.0Z", "NPRID": "60", "Z2TpUserLabel": null, "Z2TpDisplayLabel": null, "A1NeId": "34", "A2NeName": null, "A1TpId": "32288", "A2TpDisplayLabel": null, "A2NodeId": "0", "Z1TpType": "0", "INEFFECTDATE": "20160423084721.0Z", "OrderId": "215", "NAME": "130SCX10-OTS-01", "A1TpName": "AHPHG-18-5-LINE", "A2NeId": "0", "NCID": "98", "signalType": "notMeaningful", "Z1TpInterfaceName": "AHPHG-18-5-LINE", "ConnectionState": "9", "Z1TpDisplayLabel": "AHPHG-18-5-LINE", "A2TpId": "0", "OrderState": "2", "ConnectionShape": "simple", "A2TpUserLabel": null, "ConnectionCategory": "0", "Z2TpType": "0", "pm15MinuteCollectionType": "COLLECT", "A1NodeId": "12", "Z1NeName": "NODE-BA-02", "A2TpName": null, "SERVICESTATE": "Not In Service", "UserLabel": null, "LINKTYPE": "LEGACY", "Z1NodeName": "NODE-BA-02", "A1NodeName": "NODE-BA-01", "LATENCY": "0", "CustomerName": "None", "A1TpType": "0", "Z1TpUserLabel": null, "ALARMSTATUS": "Cleared", "pm24HourCollectionType": "COLLECT", "A1TpInterfaceName": "AHPHG-18-5-LINE", "ASONWTR": "60", "A2TpInterfaceName": null, "Z2NodeId": "0", "Z2NeName": null, "OPERATIONALSTATE": "Enabled", "ConnectionDirection": "CD_BID", "Z1TpName": "AHPHG-18-5-LINE" } ] }

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /otn/NBI/Connection/{invariantId}/switchData
    to retrieve the switchData by invariant ID (retrieveSwitchData : /otn/NBI/Connection/{invariantId}/switchData)
    to retrieve available timeslots for given invariant ID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    invariantId required invariantId can be fetched from '/data/otn/networkinventory/connectionstatus'REST call ---

    Return type
  • Nbi switch Data Response
  • Responses

    Response Messages

    Schema

    200success Nbi switch Data Response
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /otn/NBI/Connection/1/switchData

    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
    Example Response Data
    { "message": "RetrieveSwitchData on unprotected connection is invalid", "status": "FAILURE", "invariantConnId": "1", "pgswitchData": null, "listOfAsonIds": [ ] }

    External Docs
    See Also :
  • getConnectionStatus : /data/otn/networkinventory/connectionstatus

  • Collection

    Name

    Type

    Description

    Enum

    HashMap«string,object»

    Name

    Type

    Description

    Enum

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    LcData

    Name

    Type

    Description

    Enum

    invariantInfraConnId String string for server infra where operation to be performed ---
    timeSlot String string all timeslot values,not Range ---
    role String string working/protection ---

    NBI Modify Parameter Request

    Name

    Type

    Description

    Enum

    requestId String string Request Id ---
    userId String string User Id ---
    password String string Password ---
    assuranceParameters Object object Assurance Parameters ---
    miscConnectionParameters Object object Miscellaneous connection Parameters ---
    transmissionParameters Object object Transmission Parameters ---
    connectionParameters Object object Connection Parameters ---

    Nbi Provisionable Response

    Name

    Type

    Description

    Enum

    message String string Message will be set if there is failure with error Reason ---
    status String string Status(Succes/Failure) ---
    data StringBuffer StringBuffer Data ---
    netConn Network Connection Network Connection Network Connection(Infra/Service) ---
    dataMap Object object Data Map(to fill Data(Key/Value)) ---

    Nbi switch Data Response

    Name

    Type

    Description

    Enum

    message String string Message ---
    status String string Status ---
    invariantConnId String string Data ---
    connId String string ConnectionID ---
    listOfAsonIds Collection Collection List of Ason Id's ---

    Nbi Topological Response

    Name

    Type

    Description

    Enum

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

    NbiModifySNCRequest

    Name

    Type

    Description

    Enum

    requestId String string Request Id ---
    userId String string User ID ---
    password String string Password ---
    operation String string Operation(add Protection/Remove Protection/ Soft Reroute) ---
    roleToBeOperated String string Role to be Operated(To Specify if woking/protection is being operated on) ---
    lcDataList array[LcData] LcData Lc Data List ---
    rollback Boolean boolean True/False(if true-->OTN will Remove the connection if the connection modify failedif False--> it will leave the connection state as is along with failure) ---
    ignoreAlarm Boolean boolean ignore Alarm ---

    Network Connection

    Name

    Type

    Description

    Enum

    SwitchCapability String string --- ---
    id Long long --- ---
    userLabel String string --- ---
    objectClass String string --- ---
    name String string --- ---
    alias String string --- ---
    a1TPData TP Data TP Data --- ---
    z1TPData TP Data TP Data --- ---
    a2TPData TP Data TP Data --- ---
    z2TPData TP Data TP Data --- ---
    componentId1 Long long --- ---
    componentId2 Long long --- ---
    connRate Integer integer --- ---
    shape Integer integer --- ---
    dir Integer integer --- ---
    objectType String string Object Type ---
    operState String string Operational state ---
    almState String string Alaram State ---
    serverAlmState String string Server Alaram State ---
    alarmProfileEnabled String string Alaram Profile Enabled ---
    connectionState Integer integer Connection State ---
    svcState Integer integer Service State ---
    almMonState Integer integer Alaram monitoring State ---
    connectionCategory Integer integer connection Category ---
    connectionType Integer integer connection Type ---
    protectionType Integer integer Protection Type ---
    displayProtectionType Integer integer Display Protection Type ---
    protectionRole Integer integer Protection Role ---
    nprTlId Long long NPR TL Id ---
    sdhConnectionId Long long SDH connection Id ---
    sdhClientId Long long SDH client Id ---
    customerName String string Customer Name ---
    isUsedInSdh Boolean boolean Used in SDH(True/False) ---
    tcmStatus Integer integer Tcm status ---
    tcmASAP String string Tcm ASAP ---
    effectiveRate String string Effective Rate ---
    createdBy Integer integer Created by ---
    omspTrailId Long long OMSP trail Id ---
    omspConnectionName String string OMSP connection Name ---
    wtocm String string WTOCM ---
    signalType String string Signal Type ---
    usedTimeSlot String string Used Time Slots ---
    containerType String string Container ---
    band String string band ---
    reservedBy Integer integer --- ---
    spectrumWidth Long long --- ---
    tsCount Integer integer --- ---
    totalRecordCount Integer integer Total Record Count ---
    thirdPartyDesc String string --- ---
    thirdPartyName String string --- ---
    orderId Long long Order Id ---
    orderNumber String string Order Number ---
    orderType Integer integer Order Type ---
    orderState Integer integer Order State ---
    orderStackId Long long Order Stack Id ---
    receivedDate Long long Order Recieved Date ---
    ncGroupId Long long NC Group Id ---
    ncGroupName String string NC Group Name ---
    ncGroupType Integer integer NC Group Type ---
    groupState Integer integer NC Group State ---
    groupEntityType Integer integer Group Entity Type ---
    groupClass Integer integer Group Class ---
    vsClientId Long long VS Client Id ---
    vsClientState Integer integer VS Client State ---
    asapId Long long ASAP Id ---
    connectionLevel Integer integer Connection Level ---
    extendedParams HashMap«string,object» HashMap«string,object» Extended Params ---
    connectionParams HashMap«string,string» HashMap«string,string» Connection Params ---
    inconsistentConnInfo Network Connection Mismatch Network Connection Mismatch Inconsistent Connectionn Information ---
    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 AssociatedNprtlId ---
    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 Wave Key Type ---
    waveKeyConfig String string Wabe Key Configuration ---
    isYProtected String string Y protected(True/False) ---
    frequencies String string Frequencies ---
    pm24h String string PM 24h ---
    pm15m String string PM 15m ---
    nimEnabled String string NIM Enabled ---
    linkUtilRatio Long long % Channel Utilization Ratio, (autocalculated) ---
    linkUtilProfile String string Link Utilization Profile ID ---
    clientRouteState String string client Route State ---
    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» --- ---

    Network Connection Mismatch

    Name

    Type

    Description

    Enum

    eventDate Date DateTime Conntn Mismatch Event Date ---
    ackDate Date DateTime Acknowledgement Date ---
    acknowledgedBy String string Acknowledged by ---
    mismatchType String string Mismatch Type ---

    Otn connection Response

    Name

    Type

    Description

    Enum

    message String string Message ( localized message) ---
    messageId String string Message Id (ID of the localized message) ---
    messageSeverity String string Message Severity (will be empty when status is success and E when there is a failure) ---
    status String string Status [SUCCESS, FAILURE, IN_PROGRESS]
    connectionName String string Connection Name ---
    connectionId Integer integer Connection Id (Here Connection Id represents the group Id) ---
    orderNumber String string Order Number (number prefixed by the ordertype like A for Add,D for delete, DV for Discovered, VD for DbDelete,R for Rearrange, RR for Rearrange with reinstate etcThese ordertype shall be prefixed with additional I if it is integrated operations) ---
    orderId String string Order Id ( unique number generated by sequence) ---
    orderStep Integer integer Order Step ---
    id String string Request Id (Identifier of the request) ---
    errorField String string Error Field ( shall be the name of the incorrect attribute) ---
    errorValue String string Error Value ( shall be the value of the incorrect attribute) ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageUnformatted String string Message Unformatted ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageType String string Message Type [Info, Warning, Error]
    messageId String string Message Id ---
    messageParams array[String] string Message Params ---
    messageTime Long long Message Time ---
    message String string Message ---

    Response

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer A value which indicates completion status of the request ---
    requestId Long long Id generated for the Request passed ---
    clientName String string Indicates name of the client ---
    clientLocation String string Indicates location of the client ---
    clientUser String string Indicates the client User ---
    sessionId String string Session Id of the event ---
    mdcId String string MDC Id,if any ---
    sequenceNum Integer integer Indicates the sequence Number generated for the response ---
    moreToCome Boolean boolean Indicates with true/false if more responses are to come ---
    messages array[OtnI18nMessage] OtnI18nMessage Response Messages,if any from the response like an Info,Warning etc ---
    errcde String string Indicates error code,if any error generated ---
    errorParams array[Object] object Indicates different error parameters,if any error generated ---
    tpList array[TP Data] TP Data --- ---
    failedCompletion Boolean boolean Indicates response completion failed with true/false ---
    successfulCompletion Boolean boolean Indicates successful response completion with true/false ---
    timeout Long long --- ---
    nadString String string --- ---

    StringBuffer

    Name

    Type

    Description

    Enum

    TP Data

    Name

    Type

    Description

    Enum

    nwInterfaceType Integer integer --- ---
    isCapableOfPmMonitoringPort Boolean boolean --- ---
    isTerminalLoopbackSupportedTp Boolean boolean --- ---
    isFacilityLoopbackSupportedTp Boolean boolean --- ---
    hasLoopback Boolean boolean --- ---
    nodeId Long long Node Id ---
    nodeName String string Node Name ---
    neId Long long NE ID ---
    neName String string NE Name ---
    ptpId Long long Physical Topological Link Id ---
    ptpName String string Physical Topological link Name ---
    tpId Long long Topological Link Id ---
    tpName String string Topological Link Name ---
    tpDisplayLabel String string TP display Label ---
    ptpLayerRate Integer integer PTP layer Rate ---
    layerRate Integer integer Layer Rate ---
    tpType Integer integer TP Type ---
    effectiveRate String string Effective Rate ---
    frequency String string Frequency ---
    clientSel String string Client Port Selected ---
    xfpName String string OCS NE port Name ---
    displayEdgeOnNe String string Display Edge on NE ---
    directionality String string Directionality ---
    nbiInterfaceName String string NBI interface Name ---
    tpUserLabel String string TP User Label ---
    parentTpType Integer integer Parent TP type ---
    signalType String string Signal Type ---
    neModel String string NE Model ---
    neSoftwareVersion String string NE software Version ---
    almState String string --- ---
    baseLineValueOPT String string --- ---
    baseLineValueOPR String string --- ---
    transmitPower String string --- ---
    receivePower String string --- ---
    encoding String string Encoding ---
    waveShape String string Wave Shape ---
    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 Phase Encoding ---
    bandwidth String string --- ---
    oduKPort String string ODU-k Port ---
    cardName String string --- ---
    cardMode String string --- ---
    cardInterworkingMode String string --- ---
    derivedNodeName String string Derived Node Name ---
    terminalLoopbackSupportedPort Boolean boolean --- ---
    facilityLoopbackSupportedPort Boolean boolean --- ---
    networkInterfaceType Integer integer Network Interface Type ---
    capableOfPmMonitoringPort Boolean boolean --- ---