Operation

get /routingDisplay/Eline/{id}
routingDisplay (ethLinksRoutingDisplayById : /routingDisplay/Eline/{id})
Routing display data holder for Carrier Ethernet Links

Path parameters

Name

IsRequired

Description

Enum

id required Link Id ---

Return type
  • RoutingDisplayDataHolder
  • Responses

    Response Messages

    Schema

    200success RoutingDisplayDataHolder
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /routingDisplay/saveEntityPos
    routingDisplay (saveRoutinggDisplayData : /routingDisplay/saveEntityPos)
    Routing display data holder for entity

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required RD Object Data RDSaveObjDataList ---

    Return type
  • RoutingDisplayDataHolder
  • Responses

    Response Messages

    Schema

    200success RoutingDisplayDataHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /routingDisplay/saveEntityPos

    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.
    • */*
    Example Response Data
    { "rdObjList":[ { "nodeId":"16", "nodeName":"TEST", "xPos":210, "yPos":166 }, { "nodeId":"13", "nodeName":"TEST", "xPos":477, "yPos":363 }, { "nodeId":"14", "nodeName":"TEST", "xPos":688, "yPos":156 } ], "entityId":"2", "entityType":"erp" }

    External Docs
    See Also :

    Operation

    get /routingDisplay/tunnel/{id}
    routingDisplay (tunnelRoutingDisplayById : /routingDisplay/tunnel/{id})
    Routing display data holder for Tunnel

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required Service Id ---

    Return type
  • RoutingDisplayDataHolder
  • Responses

    Response Messages

    Schema

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

    /routingDisplay/tunnel/3?request.preventCache=1468314305806

    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.
    • */*
    Example Response Data
    { "response":{ "req":null, "errorReason":null, "errorCode":null, "message":null, "cmdStatus":null, "opMsg":"", "msgCode":null, "parameters":[ ], "paramCount":0, "objectId":0, "jobName":"", "objectType":0 }, "items":null, "data":[ { "className":"10.41.56.90(11QCE12X-1-15)", "id":"21", "key":"21/10.41.56.90(11QCE12X-1-15)", "guiLabel":"10.41.56.90(11QCE12X-1-15)", "isICBSpokePort":false, "xPos":200.0, "yPos":100.0, "NeId":"21", "NeName":"10.41.56.90(11QCE12X-1-15)", "internalNeType":"", "NeType":"0", "belongsToCompositeNode":"false", "compositeNodeName":"10.41.56.90(11QCE12X-1-15)", "emlNeType":"0", "activityState":"12", "commsStatus":"CS_UP", "managementType":"0", "alarmSeverity":"0", "configDownloadStatus":"2", "swVersion":"", "nodeGridDim":"ND_2RowX3Col", "nprNeId":"-1", "nprComponentNeId":"NA", "connFrequency":"", "isOCS":"false", "isPHN":"false", "isPSD":"false", "isCurrentRouteRD":"false", "isGMREEnabled":"false", "size":{ "width":"0", "height":"0" }, "position":{ "col":"0", "row":"0" }, "title":"10.41.56.90(11QCE12X-1-15)<br>Tunnel Id : 1<br>Tunnel Name : Tunnel_ICB-1_LER_1<br>Node Id : 0.0.0.1<br>Global Id : 1<br>Destination Tunnel Id : 1<br>Destination Node Id : 0.0.0.2<br>Destination Global Id : 1<br>SDP Id(s): 1", "sdpExists":"true", "sdpId":"1", "sdpDesc":"", "sdpVsid":"21", "tunnelName":"10.41.56.90_1-15_10.41.56.90_1-16_5", "sdpInOut":"out", "lspExists":"true", "lspInOut":"in", "tunnelId":"1", "lspVsid":"21", "lspAlarm":"Cleared", "isVne":"false", "neType":"0", "neId":"21", "neName":"10.41.56.90(11QCE12X-1-15)", "icbspokePort":false }, { "className":"10.41.56.90(11QCE12X-1-16)", "id":"22", "key":"22/10.41.56.90(11QCE12X-1-16)", "guiLabel":"10.41.56.90(11QCE12X-1-16)", "isICBSpokePort":false, "xPos":647.0, "yPos":287.0, "NeId":"22", "NeName":"10.41.56.90(11QCE12X-1-16)", "internalNeType":"", "NeType":"0", "belongsToCompositeNode":"false", "compositeNodeName":"10.41.56.90(11QCE12X-1-16)", "emlNeType":"0", "activityState":"12", "commsStatus":"CS_UP", "managementType":"0", "alarmSeverity":"0", "configDownloadStatus":"2", "swVersion":"", "nodeGridDim":"ND_2RowX3Col", "nprNeId":"-1", "nprComponentNeId":"NA", "connFrequency":"", "isOCS":"false", "isPHN":"false", "isPSD":"false", "isCurrentRouteRD":"false", "isGMREEnabled":"false", "size":{ "width":"0", "height":"0" }, "position":{ "col":"1", "row":"0" }, "title":"10.41.56.90(11QCE12X-1-16)<br>Tunnel Id : 1<br>Tunnel Name : Tunnel_ICB-1_LER_1<br>Node Id : 0.0.0.2<br>Global Id : 1<br>Destination Tunnel Id : 1<br>Destination Node Id : 0.0.0.1<br>Destination Global Id : 1<br>SDP Id(s): 1", "sdpExists":"true", "sdpId":"1", "sdpDesc":"", "sdpVsid":"22", "tunnelName":"10.41.56.90_1-15_10.41.56.90_1-16_5", "sdpInOut":"in", "lspExists":"true", "lspInOut":"out", "tunnelId":"1", "lspVsid":"22", "lspAlarm":"Cleared", "isVne":"false", "neType":"0", "neId":"22", "neName":"10.41.56.90(11QCE12X-1-16)", "icbspokePort":false }, { "className":"link", "id":"81", "key":"81/link", "guiLabel":"1", "isICBSpokePort":false, "linkPriority":0, "linkConnectionId":81, "aNEId":21, "zNEId":22, "displayThickness":2, "serverConnectionId":0, "channelNum":-1, "connectionId":5, "orderId":0, "connectionAlias":"", "connectionName":"", "aPortName":"11QCE12X-1-15-X1", "zPortName":"11QCE12X-1-16-X1", "aPortId":"3968", "zPortId":"4022", "aNEName":"10.41.56.90", "zNEName":"10.41.56.90", "isInternal":"", "isIndirect":"", "srcActive":"NA", "sinkActive":"NA", "leftArrowStyle":"NORMAL", "rightArrowStyle":"NORMAL", "displayStyle":"solid", "manualFault":"No", "jklmTimeSlot":"", "frequency":"", "serverConnectionTechnology":"NA", "effectiveRate":"NA", "lccId":"81", "serverIndirectPathId":"-1", "serverConnectionName":"", "linkState":"3", "serverCommissioningStatus":"NA", "displayLinkState":"Cleared", "linkType":"1", "isCurrentRouteRD":"false", "position":{ "x":"0", "y":"0" }, "title":"10.41.56.90/11QCE12X-1-15-X1/11QCE12X-1-16-X1/OS-NULL<br> Link Associated :10.41.56.90/11QCE12X-1-15-X1/11QCE12X-1-16-X1/OS", "pathType":"Working", "activePathType":false, "tunnelId":-1, "aspokeSdpId":-1, "zspokeSdpId":-1, "icbspokePort":false }, { "className":"Tunnel Details", "isICBSpokePort":false, "managementState":"Commissioned", "serviceState":"In Service", "operationalState":"down", "tunnelId":"5", "tunnelName":"10.41.56.90_1-15_10.41.56.90_1-16_5", "icbspokePort":false }, { "className":"port", "id":"3968", "key":"PORT1", "guiLabel":"TEST PORT", "isICBSpokePort":false, "portId":"3968", "portName":"11QCE12X-1-15-X1", "nativeName":"11QCE12X-1-15-X1", "relativeName":"11QCE12X-1-15-X1", "portLabel":"11QCE12X-1-15-X1", "tpDisplayLabel":"11QCE12X-1-15-X1", "portRate":"Wdm_LayerRate_default", "layerRateId":"", "portType":"PTP", "portAlarmState":"Cleared", "lagLabel":"11QCE12X-1-15-X1", "sapName":"", "connId":-1, "physicalPortId":-1, "isInternal":"false", "neId":"21", "neName":"10.41.56.90", "neInterfaceName":"", "neType":"WdmBBOX_NE", "neModel":"", "neRelease":"", "isActive":"true", "asapStatus":"ASAPST_NONE", "roleForExternalLink":"EL_NA", "ingressVlanId":"", "egressVlanId":"", "ingressSVlanId":"", "egressSVlanId":"", "signalType":"", "portSide":"", "circuitPackName":"", "operationalMode":"NA", "displayEdgeOnNe":"", "directionality":"TD_BID", "has_loopback":"false", "portLoopbackType":"RELEASE", "has_matrixLoopbackForced":"false", "supportsTerminalLoopback":"false", "supportsMatrixLoopback":"false", "supportsLineLoopback":"false", "supportsFacilityLoopback":"false", "supportsForcedFacilityLoopback":"false", "supportsForcedTerminalLoopback":"false", "supportsForcedMatrixLoopback":"false", "isBlockPort":"false", "mepExists":"false", "mdId":"", "mepIndex":"", "maName":"", "rmepList":"", "mepAlarmState":"", "supportsPayloadLoopback":"false", "ptpName":"", "pgExists":"false", "isCurrentRouteRD":"false", "testCaseOnMepExist":"false", "testCaseOnMepDetails":"", "title":"Port Name : <br>Interface Name : I_11QCE12X-1-15-X1_NULL<br>VLAN Id : 0<br>In Label : 33<br>Out Label : 32<br>Path Type : Working", "packetSwitchNativeName":"", "position":{ "col":"2", "row":"0" }, "icbspokePort":false }, { "className":"port", "id":"4022", "key":"PORT1", "guiLabel":"TEST PORT", "isICBSpokePort":false, "portId":"4022", "portName":"11QCE12X-1-16-X1", "nativeName":"11QCE12X-1-16-X1", "relativeName":"11QCE12X-1-16-X1", "portLabel":"11QCE12X-1-16-X1", "tpDisplayLabel":"11QCE12X-1-16-X1", "portRate":"Wdm_LayerRate_default", "layerRateId":"", "portType":"PTP", "portAlarmState":"Cleared", "lagLabel":"11QCE12X-1-16-X1", "sapName":"", "connId":-1, "physicalPortId":-1, "isInternal":"false", "neId":"22", "neName":"10.41.56.90", "neInterfaceName":"", "neType":"WdmBBOX_NE", "neModel":"", "neRelease":"", "isActive":"true", "asapStatus":"ASAPST_NONE", "roleForExternalLink":"EL_NA", "ingressVlanId":"", "egressVlanId":"", "ingressSVlanId":"", "egressSVlanId":"", "signalType":"", "portSide":"", "circuitPackName":"", "operationalMode":"NA", "displayEdgeOnNe":"", "directionality":"TD_BID", "has_loopback":"false", "portLoopbackType":"RELEASE", "has_matrixLoopbackForced":"false", "supportsTerminalLoopback":"false", "supportsMatrixLoopback":"false", "supportsLineLoopback":"false", "supportsFacilityLoopback":"false", "supportsForcedFacilityLoopback":"false", "supportsForcedTerminalLoopback":"false", "supportsForcedMatrixLoopback":"false", "isBlockPort":"false", "mepExists":"false", "mdId":"", "mepIndex":"", "maName":"", "rmepList":"", "mepAlarmState":"", "supportsPayloadLoopback":"false", "ptpName":"", "pgExists":"false", "isCurrentRouteRD":"false", "testCaseOnMepExist":"false", "testCaseOnMepDetails":"", "title":"Port Name : <br>Interface Name : I_11QCE12X-1-16-X1_NULL<br>VLAN Id : 0<br>In Label : 32<br>Out Label : 33<br>Path Type : Working", "packetSwitchNativeName":"", "position":{ "col":"0", "row":"0" }, "icbspokePort":false } ] }

    External Docs
    See Also :

    RDSaveObjDataList

    Name

    Type

    Description

    Enum

    entityId Integer integer --- ---
    entityType String string --- ---
    rdObjList array[RDSaveObjectPositions] RDSaveObjectPositions --- ---

    RDSaveObjectPositions

    Name

    Type

    Description

    Enum

    nodeId Integer integer --- ---
    nodeName String string --- ---
    xPos Double double --- ---
    yPos Double double --- ---

    Request Header

    Name

    Type

    Description

    Enum

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

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---

    RoutingDisplayDataHolder

    Name

    Type

    Description

    Enum

    response Response Header Model Response Header Model Response wrapper for operation status ---
    items array[Object] object items ---
    data array[Object] object data ---