Operation

get /esmBrowser/GetEgressOperRateByTpId/{TpId}
GetEgressOperRateByTpId (getEgressOperRateByTpId : /esmBrowser/GetEgressOperRateByTpId/{TpId})
Gets rate Limit data for a given Service

Path parameters

Name

IsRequired

Description

Enum

tpId required Tp Id ---

Return type
  • systemValue
  • Responses

    Response Messages

    Schema

    200success systemValue
    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/xml

    External Docs
    See Also :

    Operation

    get /esmBrowser/getNextCVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink}
    getNextCVLanValueForLinkorErp (getNextCVLanValueForLinkorErp : /esmBrowser/getNextCVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink})
    get Next Service Labels

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eRPOrLinkId required ERPOrLinkId ---
    erpOrLink required erpOrLink ---

    Return type
  • systemValue
  • Responses

    Response Messages

    Schema

    200success systemValue
    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 /esmBrowser/getNextMaMask
    getNextMaMask (getNextMaMask : /esmBrowser/getNextMaMask)
    return Next MA Mask


    Return type
  • systemValue
  • Responses

    Response Messages

    Schema

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

    http://localhost:8080/oms1350/esmBrowser/getNextMaMask

    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/xml
    Example Response Data
    <SystemValueHolder> <systemValue>0030</systemValue> </SystemValueHolder>

    External Docs
    See Also :

    Operation

    get /esmBrowser/getNextMaMaskJson
    getNextMaMaskJson (getNextMaMaskJson : /esmBrowser/getNextMaMaskJson)
    return Next MA Mask


    Return type
  • systemValue
  • Responses

    Response Messages

    Schema

    200success systemValue
    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 /esmBrowser/getNextSVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink}
    getNextSVLanValueForLinkorErp (getNextSVLanValueForLinkorErp : /esmBrowser/getNextSVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink})
    get Next Service Labels

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eRPOrLinkId required ERPOrLinkId ---
    erpOrLink required erpOrLink ---

    Return type
  • systemValue
  • Responses

    Response Messages

    Schema

    200success systemValue
    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 /esmBrowser/getNextCVLANJSON/{vsIdList}/{prevVsIdList}/{prevAutoVal}
    getNextCVLANJSON (getNextSystemGenCVLANValueJson : /esmBrowser/getNextCVLANJSON/{vsIdList}/{prevVsIdList}/{prevAutoVal})
    get Next CVLAN

    Path parameters

    Name

    IsRequired

    Description

    Enum

    vsIdList required vsIdList ---
    prevVsIdList required prevVsIdList ---
    prevAutoVal required prevAutoVal ---

    Return type
  • systemValue
  • Responses

    Response Messages

    Schema

    200success systemValue
    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/xml

    External Docs
    See Also :

    Operation

    get /esmBrowser/tree/{context}
    treeNodeBrowser (getTree : /esmBrowser/tree/{context})
    This operation fetches tree Node Browser details.

    Here Context can be one of the two values
    1. Design
    2. Deploy
    If the context is Design,the templates will be retrieved as per Design -> Network Configuration filtering rules(Both published and unpublished templates)
    If the context is Deploy,the templates will be retrieved as per Deploy -> Network Configuration filtering rules(Only published templates).

    Path parameters

    Name

    IsRequired

    Description

    Enum

    context required Context can be one of the two values 1.Design 2.Deploy ---

    Return type
  • nodes
  • Responses

    Response Messages

    Schema

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

    http://localhost:8080/oms1350/esmBrowser/tree/Deploy?dojo.preventCache=1469009256362

    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
    { "identifier": "id", "label": "label", "items": [ { "id": "Features", "label": "Features", "children": [ { "id": "Features/Service", "label": "Service", "type": "SERVICE" }, { "id": "Features/ERP", "label": "ERP", "type": "ERP" }, { "id": "Features/OAM", "label": "OAM", "type": "OAM" }, { "id": "Features/LAG", "label": "LAG", "type": "LAG" }, { "id": "Features/MC-LAG", "label": "MC-LAG", "type": "MCLAG" } ] }, { "id": "Best Practices", "label": "Best Practices", "children": [ { "id": "Best Practices/QoS Templates", "label": "QoS Templates", "children": [ { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IP", "label": "ACCESSINGRESSQOS_IP", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_MAC", "label": "ACCESSINGRESSQOS_MAC", "type": "QOS" }, { "id": "Best Practices/QoS Templates/NETWORKPOLICY1", "label": "NETWORKPOLICY1", "type": "QOS" }, { "id": "Best Practices/QoS Templates/NETWORKPOLICY2", "label": "NETWORKPOLICY2", "type": "QOS" }, { "id": "Best Practices/QoS Templates/NetworkDefault6_0", "label": "NetworkDefault6_0", "type": "QOS" }, { "id": "Best Practices/QoS Templates/AccessDefault6_0", "label": "AccessDefault6_0", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPv6DSCP", "label": "ACCESSINGRESSQOS_IPv6DSCP", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPv6ANY", "label": "ACCESSINGRESSQOS_IPv6ANY", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPv4ANY", "label": "ACCESSINGRESSQOS_IPv4ANY", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPv6DSCP_2R3C-2", "label": "ACCESSINGRESSQOS_IPv6DSCP_2R3C-2", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPv6ANY_2R3C-2", "label": "ACCESSINGRESSQOS_IPv6ANY_2R3C-2", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IPANY_2R3C-2", "label": "ACCESSINGRESSQOS_IPANY_2R3C-2", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IP_2R3C-2", "label": "ACCESSINGRESSQOS_IP_2R3C-2", "type": "QOS" }, { "id": "Best Practices/QoS Templates/ACCESSINGRESSQOS_MAC_2R3C-2", "label": "ACCESSINGRESSQOS_MAC_2R3C-2", "type": "QOS" } ] }, { "id": "Best Practices/LAG Templates", "label": "LAG Templates", "children": [ { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ERP_OVER_LAG", "label": "LAG_USAGE_IN_ERP_OVER_LAG", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ELINE_EPL_SERVICES", "label": "LAG_USAGE_IN_ELINE_EPL_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ELINE_EVPL_SERVICES", "label": "LAG_USAGE_IN_ELINE_EVPL_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ELAN_EPLAN_SERVICES", "label": "LAG_USAGE_IN_ELAN_EPLAN_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ELAN_EVPLAN_SERVICES", "label": "LAG_USAGE_IN_ELAN_EVPLAN_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_MC-LAG_FOR_ELINE_EPL_SERVICES", "label": "LAG_USAGE_IN_MC-LAG_FOR_ELINE_EPL_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_MC-LAG_FOR_ELINE_EVPL_SERVICES", "label": "LAG_USAGE_IN_MC-LAG_FOR_ELINE_EVPL_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_MC-LAG_FOR_ELAN_EPLAN_SERVICES", "label": "LAG_USAGE_IN_MC-LAG_FOR_ELAN_EPLAN_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_MC-LAG_FOR_ELAN_EVPLAN_SERVICES", "label": "LAG_USAGE_IN_MC-LAG_FOR_ELAN_EVPLAN_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_EPTREE_SERVICES", "label": "LAG_USAGE_IN_EPTREE_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_EVPTREE_SERVICES", "label": "LAG_USAGE_IN_EVPTREE_SERVICES", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_SERVICE_ACCESS_QINQ", "label": "LAG_USAGE_IN_SERVICE_ACCESS_QINQ", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_MCLAG_ACCESS_QINQ", "label": "LAG_USAGE_IN_MCLAG_ACCESS_QINQ", "type": "LAG" }, { "id": "Best Practices/LAG Templates/LAG_USAGE_IN_ERP_OVER_LAG_1GbE", "label": "LAG_USAGE_IN_ERP_OVER_LAG_1GbE", "type": "LAG" } ] }, { "id": "Best Practices/MCLAG Templates", "label": "MCLAG Templates", "children": [ { "id": "Best Practices/MCLAG Templates/MC-LAG Template", "label": "MC-LAG Template", "type": "MCLAG" } ] }, { "id": "Best Practices/ERP Template", "label": "ERP Template", "children": [ { "id": "Best Practices/ERP Template/ERP_Ring", "label": "ERP_Ring", "type": "ERP" }, { "id": "Best Practices/ERP Template/ERP_SubRing", "label": "ERP_SubRing", "type": "ERP" } ] }, { "id": "Best Practices/OAM Template", "label": "OAM Template", "children": [ { "id": "Best Practices/OAM Template/OAM_FOR_ERP", "label": "OAM_FOR_ERP", "type": "OAM" } ] } ] }, { "id": "My Templates", "label": "My Templates", "children": [ { "id": "My Templates/Service Templates", "label": "Service Templates", "children": [ { "id": "My Templates/Service Templates/EPTREE", "label": "EPTREE", "type": "SERVICE" }, { "id": "My Templates/Service Templates/EVPL", "label": "EVPL", "type": "SERVICE" }, { "id": "My Templates/Service Templates/EVPLAN-1", "label": "EVPLAN-1", "type": "SERVICE" }, { "id": "My Templates/Service Templates/EPL", "label": "EPL", "type": "SERVICE" } ] }, { "id": "My Templates/ERP Templates", "label": "ERP Templates", "children": [ { "id": "My Templates/ERP Templates/test_erp", "label": "test_erp", "type": "ERP" }, { "id": "My Templates/ERP Templates/ERP_TEMPLATE", "label": "ERP_TEMPLATE", "type": "ERP" } ] }, { "id": "My Templates/LAG Templates", "label": "LAG Templates", "children": [ { "id": "My Templates/LAG Templates/NbiTest", "label": "NbiTest", "type": "LAG" } ] }, { "id": "My Templates/MCLAG Templates", "label": "MCLAG Templates", "children": [ { "id": "My Templates/MCLAG Templates/temp-mclag", "label": "temp-mclag", "type": "MCLAG" } ] }, { "id": "My Templates/QoS Templates", "label": "QoS Templates", "children": [ { "id": "My Templates/QoS Templates/DiscoveredQoS_Access1455095001515", "label": "DiscoveredQoS_Access1455095001515", "type": "QOS" }, { "id": "My Templates/QoS Templates/DiscoveredQoS_Access1455095005363", "label": "DiscoveredQoS_Access1455095005363", "type": "QOS" }, { "id": "My Templates/QoS Templates/DiscoveredQoS_Network1455094998032", "label": "DiscoveredQoS_Network1455094998032", "type": "QOS" }, { "id": "My Templates/QoS Templates/DiscoveredQoS_Access1455095000267", "label": "DiscoveredQoS_Access1455095000267", "type": "QOS" }, { "id": "My Templates/QoS Templates/DiscoveredQoS_Network1455095006848", "label": "DiscoveredQoS_Network1455095006848", "type": "QOS" } ] }, { "id": "My Templates/OAM Templates", "label": "OAM Templates", "children": [ { "id": "My Templates/OAM Templates/OAM-SERVICE-TEMPLATE", "label": "OAM-SERVICE-TEMPLATE", "type": "OAM" }, { "id": "My Templates/OAM Templates/oam_temp", "label": "oam_temp", "type": "OAM" } ] } ] } ] }

    External Docs
    See Also :

    MepDetails

    Name

    Type

    Description

    Enum

    mepId Integer integer mepId ---
    vsId Integer integer vsId ---
    transmittedCcms String string transmittedCcms [ ]
    ccmSeqErr String string ccmSeqErr [ ]
    lastErrCcmFailureFrame String string lastErrCcmFailureFrame [ ]
    lastXconCcmFailureFrame String string lastXconCcmFailureFrame [ ]
    highestPriorityDefect String string highestPriorityDefect [ ]
    maId Integer integer --- ---
    mdId Integer integer mdId ---
    maName String string maName [ ]
    nmlMacAddress String string nmlMacAddress [ ]
    macAddress String string macAddress [ ]
    packName String string packName [ ]
    mark String string mark [ ]
    neName String string neName [ ]
    commState Integer integer --- ---
    mepState String string mepState [ ]
    entityName String string entityName [ ]
    direction String string direction [ ]
    enitityPortPrimaryState String string --- ---
    monitoredObjSapSubType String string sap sub type [ ]
    remoteMepSapSubType String string --- ---
    entityType Integer integer Entity Type ---

    MepDetailsList

    Name

    Type

    Description

    Enum

    mepDetailsList array[MepDetails] MepDetails List ---

    Node

    Name

    Type

    Description

    Enum

    nodes

    Name

    Type

    Description

    Enum

    identifier String string identifier ---
    label String string label ---
    items array[Node] Node items ---

    systemValue

    Name

    Type

    Description

    Enum

    systemValue String string systemValue ---