Operation

post /esmBrowser/SAT/deploySAT/
deploySAT (deploySAT : /esmBrowser/SAT/deploySAT/)
Deployes Service Actovation Test.SAT can only be deploy now, deploy later is not supported,

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData SATTemplateDataHolder ---

Return type
  • ServiceIdResponseHolderModel
  • Responses

    Response Messages

    Schema

    200success ServiceIdResponseHolderModel
    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 /esmBrowser/SAT/getAllAvailablePortForLoopback/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback}
    This method is used to get the list of ports which can be used for loopback (getAllAvailablePortForLoopback : /esmBrowser/SAT/getAllAvailablePortForLoopback/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback})
    To get the list of ports which can be used for loopback

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nENAME required NE Name ---
    pACKNAME required PACKNAME ---
    excludeTpidList required Exclude TPID list ---
    forLoopback required true or false ---
    virtualTpName required Exclude TPID Name - Virtual ---

    Return type
  • PortDetailsList
  • Responses

    Response Messages

    Schema

    200success PortDetailsList
    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/SAT/getAllAvailablePortForTestHeadCreation/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback}
    This method is used to get the list of ports which can be used as Test Head for Service Activation Test (getAllAvailablePortForTestHeadCreation : /esmBrowser/SAT/getAllAvailablePortForTestHeadCreation/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback})
    To get the list of ports which can be used as Test Head for Service Activation Test

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nENAME required NE Name ---
    pACKNAME required PACKNAME ---
    excludeTpidList required Exclude TPID list ---
    forLoopback required true or false ---
    virtualTpName required Exclude TPID Name - Virtual ---

    Return type
  • PortDetailsList
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllAvailablePortForTestHeadCreation/10.100.65.155/11QCE12X-1-5/-1/true

    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
    {"portDetails":[{"portName":"10.100.65.155/11QCE12X-1-5-C10","tpId":858,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0e","id":"858","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C11","tpId":856,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0f","id":"856","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C12","tpId":854,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:10","id":"854","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C13","tpId":847,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:11","id":"847","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C14","tpId":848,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:12","id":"848","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C15","tpId":850,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:13","id":"850","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C16","tpId":851,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:14","id":"851","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C17","tpId":840,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:15","id":"840","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C18","tpId":843,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:16","id":"843","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C19","tpId":845,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:17","id":"845","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C2","tpId":841,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:06","id":"841","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C20","tpId":866,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:18","id":"866","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C22","tpId":868,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:1a","id":"868","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C4","tpId":846,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:08","id":"846","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C5","tpId":844,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:09","id":"844","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C6","tpId":855,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0a","id":"855","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C7","tpId":853,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0b","id":"853","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C9","tpId":857,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0d","id":"857","portPrimaryState":null}],"items":[{"portName":"10.100.65.155/11QCE12X-1-5-C10","tpId":858,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0e","id":"858","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C11","tpId":856,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0f","id":"856","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C12","tpId":854,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:10","id":"854","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C13","tpId":847,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:11","id":"847","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C14","tpId":848,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:12","id":"848","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C15","tpId":850,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:13","id":"850","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C16","tpId":851,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:14","id":"851","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C17","tpId":840,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:15","id":"840","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C18","tpId":843,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:16","id":"843","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C19","tpId":845,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:17","id":"845","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C2","tpId":841,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:06","id":"841","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C20","tpId":866,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:18","id":"866","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C22","tpId":868,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:1a","id":"868","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C4","tpId":846,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:08","id":"846","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C5","tpId":844,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:09","id":"844","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C6","tpId":855,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0a","id":"855","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C7","tpId":853,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0b","id":"853","portPrimaryState":null},{"portName":"10.100.65.155/11QCE12X-1-5-C9","tpId":857,"autoNeg":null,"duplexMode":null,"neId":null,"portRate":null,"neVersion":null,"portState":"Not In Service","portMacAddress":"00:80:21:01:05:0d","id":"857","portPrimaryState":null}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATAcceptanceCriteriaByProfileIdAndVSID/{profileId}/{vsId}
    This method is used to get the list of payloads associated to a profile and a VS. (getAllSATAcceptanceCriteriaByProfileIdAndVSID : /esmBrowser/SAT/getAllSATAcceptanceCriteriaByProfileIdAndVSID/{profileId}/{vsId})
    This method is used to get the list of payloads associated to a profile and a VS.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileId required profileId ---
    vsId required vsId ---

    Return type
  • SATAcceptanceCriteriaUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllSATAcceptanceCriteriaByProfileIdAndVSID/7/12

    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
    {"acList":[{"cirThreshold":0,"cirThresholdUnits":null,"pirThreshold":0,"pirThresholdUnits":null,"latencyRisingThreshold":"90","latencyRisingThresholdIn":null,"latencyRisingThresholdOut":null,"jitterRisingThreshold":"5","jitterRisingThresholdIn":null,"jiterRisingThresholdOut":null,"lossRisingThreshold":"1","lossRisingThresholdIn":null,"lossRisingThresholdOut":null,"satACID":1,"satAsscdProfileId":7,"satVsId":12,"id":"1","key":"AcceptanceCriteria/1","className":"AcceptanceCriteria"}],"items":[{"cirThreshold":0,"cirThresholdUnits":null,"pirThreshold":0,"pirThresholdUnits":null,"latencyRisingThreshold":"90","latencyRisingThresholdIn":null,"latencyRisingThresholdOut":null,"jitterRisingThreshold":"5","jitterRisingThresholdIn":null,"jiterRisingThresholdOut":null,"lossRisingThreshold":"1","lossRisingThresholdIn":null,"lossRisingThresholdOut":null,"satACID":1,"satAsscdProfileId":7,"satVsId":12,"id":"1","key":"AcceptanceCriteria/1","className":"AcceptanceCriteria"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATDetailsfromServiceId/{svcId}
    This method is used to get the details of SAT in 360 tab. (getAllSATDetailsfromServiceId : /esmBrowser/SAT/getAllSATDetailsfromServiceId/{svcId})
    This method is used to get the details in 360 tab

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcId required svcId ---

    Return type
  • SATDetailsUIData
  • Responses

    Response Messages

    Schema

    200success SATDetailsUIData
    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/SAT/getAllSATDetailsfromServiceName/{svcName}
    This method is used to get the details of SAT in 360 tab. (getAllSATDetailsfromServiceName : /esmBrowser/SAT/getAllSATDetailsfromServiceName/{svcName})
    This method is used to get the details in 360 tab

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcName required svcName ---

    Return type
  • SATDetailsUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllSATDetailsfromServiceName/Kini_MPLS_SAT

    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
    {"satDetailsUIList":[{"satSvcName":"Kini_MPLS_SAT","satName":"SAT-Kini_MPLS_SAT-1498806626260","satDesc":"Best practice template for SAT","satcreateTime":0,"satAuth":"alcatel","satColorAware":0,"satForwClass":"Best-Effort","satProfId":1,"satPayldId":1,"satAccCrtId":1,"satrunState":"COMPLETED","satnmlSvcId":6,"satnmlTestId":34,"satRunId":1,"hours":null,"minites":null,"seconds":null,"id":"0","key":"SATDetailsUI/0","className":"SATDetailsUI"}],"items":[{"satSvcName":"Kini_MPLS_SAT","satName":"SAT-Kini_MPLS_SAT-1498806626260","satDesc":"Best practice template for SAT","satcreateTime":0,"satAuth":"alcatel","satColorAware":0,"satForwClass":"Best-Effort","satProfId":1,"satPayldId":1,"satAccCrtId":1,"satrunState":"COMPLETED","satnmlSvcId":6,"satnmlTestId":34,"satRunId":1,"hours":null,"minites":null,"seconds":null,"id":"0","key":"SATDetailsUI/0","className":"SATDetailsUI"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATPayloadByProfileIdAndVSID/{profileId}/{vsId}
    This method is used to get the list of payloads associated to a profile and a VS. (getAllSATPayloadByProfileIdAndVSID : /esmBrowser/SAT/getAllSATPayloadByProfileIdAndVSID/{profileId}/{vsId})
    This method is used to get the list of payloads associated to a profile and a VS.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileId required profileId ---
    vsId required vsId ---

    Return type
  • SATFramePayloadUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllSATPayloadByProfileIdAndVSID/7/12

    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
    {"payloadList":[{"payloadType":"l2","dataPattern":"0xa1b2c3d4e5f6","etherType":"L2","satPayloadId":1,"satAsscdProfileId":7,"satVsId":12,"id":"1","key":"PayLoad/1","className":"PayLoad"}],"items":[{"payloadType":"l2","dataPattern":"0xa1b2c3d4e5f6","etherType":"L2","satPayloadId":1,"satAsscdProfileId":7,"satVsId":12,"id":"1","key":"PayLoad/1","className":"PayLoad"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATPortselectionNEFEBySatName/{satName}
    This method is used to get the details of port selection associated to SAT Name. (getAllSATPortselectionNEFEBySatName : /esmBrowser/SAT/getAllSATPortselectionNEFEBySatName/{satName})
    This method is used to get the details of port selection associated to SAT Name.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    satName required satName ---

    Return type
  • SATPortSelectionUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllSATPortselectionNEFEBySatName/SAT-Kini_MPLS_SAT-1498806626260

    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
    {"satportsUIList":[{"satAccEndpntNE":"10.100.65.155/11QCE12X-1-4-C11","satTestHead":"10.100.65.155/11QCE12X-1-4-C18","satLoopBackNE":"10.100.65.155/11QCE12X-1-4-C3","satSrcMacAddrsNE":"00:80:21:01:04:07","satDestMacAddrsNE":"00:80:21:01:04:07","satAccEndpntFE":"10.100.65.145/11QCE12X-1-4-C21","satLoopBackFE":"10.100.65.145/11QCE12X-1-4-C3","satSrcMacAddrsFE":"00:80:21:01:04:07","satDestMacAddrsFE":"00:80:21:01:04:07","id":null,"key":"SATPortsUI/null","className":"SATPortsUI"}],"items":[{"satAccEndpntNE":"10.100.65.155/11QCE12X-1-4-C11","satTestHead":"10.100.65.155/11QCE12X-1-4-C18","satLoopBackNE":"10.100.65.155/11QCE12X-1-4-C3","satSrcMacAddrsNE":"00:80:21:01:04:07","satDestMacAddrsNE":"00:80:21:01:04:07","satAccEndpntFE":"10.100.65.145/11QCE12X-1-4-C21","satLoopBackFE":"10.100.65.145/11QCE12X-1-4-C3","satSrcMacAddrsFE":"00:80:21:01:04:07","satDestMacAddrsFE":"00:80:21:01:04:07","id":null,"key":"SATPortsUI/null","className":"SATPortsUI"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATProfilesByServiceId/{svcId}
    This method is used to get the list of profiles associated to the Service. (getAllSATProfilesByServiceId : /esmBrowser/SAT/getAllSATProfilesByServiceId/{svcId})
    This method is used to get the list of profiles associated to the Service.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcId required svcId ---

    Return type
  • SATTestHeadProfileUIData
  • Responses

    Response Messages

    Schema

    200success SATTestHeadProfileUIData
    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/SAT/getAllSATProfilesByServiceName/{svcName}
    This method is used to get the list of profiles associated to the Service. (getAllSATProfilesByServiceName : /esmBrowser/SAT/getAllSATProfilesByServiceName/{svcName})
    This method is used to get the list of profiles associated to the Service.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcName required svcName ---

    Return type
  • SATTestHeadProfileUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.70.35:8443/oms1350/esmBrowser/SAT/getAllSATProfilesByServiceName/SAT-PB-1

    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
    {"profileList":[{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":100,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":5,"satVsId":34,"timeDurationStr":"0:30:0","id":"5","key":"TestProfile/5","className":"TestProfileService","satProfileIdUI":5},{"dot1pInprofile":1,"dot1pOutprofile":2,"cirRate":100,"cirRateUnits":null,"pirRate":500,"pirRatUnits":null,"adaptationRule":"Closest","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":2,"satVsId":34,"timeDurationStr":"00:03:00","id":"2","key":"TestProfile/2","className":"TestProfileService","satProfileIdUI":2},{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":100,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":4,"satVsId":34,"timeDurationStr":"0:3:0","id":"4","key":"TestProfile/4","className":"TestProfileService","satProfileIdUI":4},{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":1000,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":512,"hours":null,"minites":null,"seconds":null,"satProfileId":1,"satVsId":33,"timeDurationStr":"0:30:0","id":"1","key":"TestProfile/1","className":"TestProfileService","satProfileIdUI":1},{"dot1pInprofile":1,"dot1pOutprofile":2,"cirRate":100,"cirRateUnits":null,"pirRate":500,"pirRatUnits":null,"adaptationRule":"Closest","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":1,"satVsId":34,"timeDurationStr":"00:03:00","id":"1","key":"TestProfile/1","className":"TestProfileService","satProfileIdUI":1}],"items":[{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":100,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":5,"satVsId":34,"timeDurationStr":"0:30:0","id":"5","key":"TestProfile/5","className":"TestProfileService","satProfileIdUI":5},{"dot1pInprofile":1,"dot1pOutprofile":2,"cirRate":100,"cirRateUnits":null,"pirRate":500,"pirRatUnits":null,"adaptationRule":"Closest","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":2,"satVsId":34,"timeDurationStr":"00:03:00","id":"2","key":"TestProfile/2","className":"TestProfileService","satProfileIdUI":2},{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":100,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":4,"satVsId":34,"timeDurationStr":"0:3:0","id":"4","key":"TestProfile/4","className":"TestProfileService","satProfileIdUI":4},{"dot1pInprofile":0,"dot1pOutprofile":0,"cirRate":1000,"cirRateUnits":null,"pirRate":0,"pirRatUnits":null,"adaptationRule":"Min","frameSize":512,"hours":null,"minites":null,"seconds":null,"satProfileId":1,"satVsId":33,"timeDurationStr":"0:30:0","id":"1","key":"TestProfile/1","className":"TestProfileService","satProfileIdUI":1},{"dot1pInprofile":1,"dot1pOutprofile":2,"cirRate":100,"cirRateUnits":null,"pirRate":500,"pirRatUnits":null,"adaptationRule":"Closest","frameSize":1514,"hours":null,"minites":null,"seconds":null,"satProfileId":1,"satVsId":34,"timeDurationStr":"00:03:00","id":"1","key":"TestProfile/1","className":"TestProfileService","satProfileIdUI":1}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATProfilesByVSID/{vsId}
    This method is used to get the list of profiles associated to the VS. (getAllSATProfilesByVSID : /esmBrowser/SAT/getAllSATProfilesByVSID/{vsId})
    This method is used to get the list of profiles associated to the VS.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    vsId required vsId ---

    Return type
  • SATTestHeadProfileUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getAllSATProfilesByVSID/11

    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
    { "profileList": [ {"dot1pInprofile":0, "dot1pOutprofile":0, "cirRate":100, "cirRateUnits":null, "pirRate":500, "pirRatUnits":null, "adaptationRule":"Closest", "frameSize":1514, "hours":null, "minites":null, "seconds":null, "satProfileId":1, "satVsId":11, "timeDurationStr":"00:05:00", "id":"1", "key":"TestProfile/1", "className":"TestProfile", "satProfileIdUI":1 } ], "items": [ { "dot1pInprofile":0, "dot1pOutprofile":0, "cirRate":100, "cirRateUnits":null, "pirRate":500, "pirRatUnits":null, "adaptationRule":"Closest", "frameSize":1514, "hours":null, "minites":null, "seconds":null, "satProfileId":1, "satVsId":11, "timeDurationStr":"00:05:00", "id":"1", "key":"TestProfile/1", "className":"TestProfile", "satProfileIdUI":1 } ] }

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getAllSATresultsFromServiceId/{svcId}
    This method is used to get the all SAT results in 360 tab associated with Service Id (getAllSATresultsFromServiceId : /esmBrowser/SAT/getAllSATresultsFromServiceId/{svcId})
    This method is used to get the all SAT results in 360 tab associated with Service Id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcId required svcId ---

    Return type
  • SATResultUIData
  • Responses

    Response Messages

    Schema

    200success SATResultUIData
    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/SAT/getAllSATresultsFromServiceName/{svcName}
    This method is used to get the all SAT results in 360 tab associated with Service Name (getAllSATresultsFromServiceName : /esmBrowser/SAT/getAllSATresultsFromServiceName/{svcName})
    This method is used to get the all SAT results in 360 tab associated with Service Name

    Path parameters

    Name

    IsRequired

    Description

    Enum

    svcName required svcName ---

    Return type
  • SATResultUIData
  • Responses

    Response Messages

    Schema

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

    https://135.250.70.35:8443/oms1350/esmBrowser/SAT/getAllSATresultsFromServiceName/SAT-PB-1

    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
    {"items":[{"rtestName":"Discovery-Test","rprofId":5,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 10:17:09","rendTime":"2018/03/23 10:27:14","rAvgTime":"606","rStoped":"No","rCompletd":"Yes","rinjected":146612.0,"rreceived":146627.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"1000","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"SAT-PB-1-1522134179307","rprofId":2,"rpayId":1,"rACId":1,"rstartTime":"2018/03/27 07:24:38","rendTime":"2018/03/27 07:27:43","rAvgTime":"185","rStoped":"No","rCompletd":"Yes","rinjected":8691813.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"None","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"Discovery-PB-SAT","rprofId":4,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 05:45:22","rendTime":"2018/03/23 05:46:09","rAvgTime":"47","rStoped":"Yes","rCompletd":"Yes","rinjected":403.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"-1","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"Discovery-Test","rprofId":1,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 10:17:09","rendTime":"2018/03/23 10:27:14","rAvgTime":"606","rStoped":"No","rCompletd":"Yes","rinjected":146612.0,"rreceived":146627.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"1000","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"SAT-PB-1-1522066307798","rprofId":1,"rpayId":1,"rACId":1,"rstartTime":"2018/03/26 12:33:31","rendTime":"2018/03/26 12:36:37","rAvgTime":"185","rStoped":"No","rCompletd":"Yes","rinjected":8683479.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"None","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"Yes","id":null,"key":null,"className":"SATResults"}],"satresultsList":[{"rtestName":"Discovery-Test","rprofId":5,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 10:17:09","rendTime":"2018/03/23 10:27:14","rAvgTime":"606","rStoped":"No","rCompletd":"Yes","rinjected":146612.0,"rreceived":146627.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"1000","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"SAT-PB-1-1522134179307","rprofId":2,"rpayId":1,"rACId":1,"rstartTime":"2018/03/27 07:24:38","rendTime":"2018/03/27 07:27:43","rAvgTime":"185","rStoped":"No","rCompletd":"Yes","rinjected":8691813.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"None","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"Discovery-PB-SAT","rprofId":4,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 05:45:22","rendTime":"2018/03/23 05:46:09","rAvgTime":"47","rStoped":"Yes","rCompletd":"Yes","rinjected":403.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"-1","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"Discovery-Test","rprofId":1,"rpayId":1,"rACId":1,"rstartTime":"2018/03/23 10:17:09","rendTime":"2018/03/23 10:27:14","rAvgTime":"606","rStoped":"No","rCompletd":"Yes","rinjected":146612.0,"rreceived":146627.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"1000","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"","forwardingClass":"Best-Effort","colorAwareTest":"No","id":null,"key":null,"className":"SATResults"},{"rtestName":"SAT-PB-1-1522066307798","rprofId":1,"rpayId":1,"rACId":1,"rstartTime":"2018/03/26 12:33:31","rendTime":"2018/03/26 12:36:37","rAvgTime":"185","rStoped":"No","rCompletd":"Yes","rinjected":8683479.0,"rreceived":0.0,"rmin":0,"rmax":0,"ravg":0,"rjitter":0,"rconfig":null,"roper":null,"rmeasued":"None","rflrnconfig":0,"rflrmeasured":-1,"rflraccptd":"Fail","rlatnconfig":0,"rlatnmeasured":0,"rlataccptd":"Fail","rjitterconfig":0,"rjittermeasured":0,"rjitteraccptd":"Fail","sapIdName":"1\\4\\C7:2031","forwardingClass":"Best-Effort","colorAwareTest":"Yes","id":null,"key":null,"className":"SATResults"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/GetSATAssnDetailsByProfileIdAndVsId/{profileId}/{vsId}
    This method is used to get the list of SATs associated to a profile and a VS. (getSATAssnDetailsByProfileIdAndVsId : /esmBrowser/SAT/GetSATAssnDetailsByProfileIdAndVsId/{profileId}/{vsId})
    This method is used to get the list of SATs associated to a profile and a VS.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    profileId required profileId ---
    vsId required vsId ---

    Return type
  • SATUIDataList
  • Responses

    Response Messages

    Schema

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

    https://135.250.70.44:8443/oms1350/esmBrowser/SAT/GetSATAssnDetailsByProfileIdAndVsId/1/52

    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
    {"satList":[{"nmlTestId":0,"testName":"service_T-1522230665754","author":"alcatel","description":"Best practice template for SAT","forwardingClass":"Best-Effort","isColorAware":"0","remark":"--","createTime":null,"lastUpdateTime":null,"vsId":0,"runId":1,"satProfileId":1,"satPayloadId":1,"satACID":1,"satSAPID":0,"satSAPName":"1/3/C10:2020","runState":"COMPLETED","objectScope":"1","nmlServiceId":11,"asscdServiceName":"service_Test_01","id":"0","key":"SATUIData/0","className":"SATUIData","satProfileIdUI":1}],"items":[{"nmlTestId":0,"testName":"service_T-1522230665754","author":"alcatel","description":"Best practice template for SAT","forwardingClass":"Best-Effort","isColorAware":"0","remark":"--","createTime":null,"lastUpdateTime":null,"vsId":0,"runId":1,"satProfileId":1,"satPayloadId":1,"satACID":1,"satSAPID":0,"satSAPName":"1/3/C10:2020","runState":"COMPLETED","objectScope":"1","nmlServiceId":11,"asscdServiceName":"service_Test_01","id":"0","key":"SATUIData/0","className":"SATUIData","satProfileIdUI":1}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getSatDetailsForTemplate/{satName}
    This method is used to get the details of port selection associated to SAT Name. (getSatDetailsForTemplate : /esmBrowser/SAT/getSatDetailsForTemplate/{satName})
    This method is used to get the details of port selection associated to SAT Name.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    satName required satName ---

    Return type
  • SATPortSelectionUIData
  • Responses

    Response Messages

    Schema

    200success SATPortSelectionUIData
    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/SAT/getServiceEndPointForSAT/{serviceName}/{selectedPort}
    This shows the list of service end points which can be chosen for Service Activation Test (getServiceEndPointForSAT : /esmBrowser/SAT/getServiceEndPointForSAT/{serviceName}/{selectedPort})
    To get Service end points for SAT

    Path parameters

    Name

    IsRequired

    Description

    Enum

    serviceName required Service Name ---
    selectedPort required Selected Port Name in NENAME/PORTNAME format ---

    Return type
  • ServiceEndPointsList
  • Responses

    Response Messages

    Schema

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

    https://135.250.185.196:8443/oms1350/esmBrowser/SAT/getServiceEndPointForSAT/PB_SAT_DND_1/859

    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
    {"tplist":[{"encapType":null,"portRate":null,"vsId":0,"noOfServicesDeployed":0,"remainingDeployableServiceCount":0,"vsName":null,"endpointType":0,"mclagid":0,"shgCreated":false,"shgId":0,"shgName":null,"shgDescription":null,"hubSpoke":null,"ingrsEMLVALUE":null,"egrsEMLVALUE":null,"primaryState":null,"userLabel":"","vne":false,"physicalporttype":null,"tpid":787,"tpnativename":"10.100.65.145/11QCE12X-1-5-C8","nename":"10.100.65.145"}]}

    External Docs
    See Also :

    Operation

    get /esmBrowser/SAT/getServiceNetworkPortForSAT/{serviceName}/{NENAME}/{PACKNAME}
    This shows the list of service uplink ports which can be chosen for Loopback (getServiceNetworkPortForSAT : /esmBrowser/SAT/getServiceNetworkPortForSAT/{serviceName}/{NENAME}/{PACKNAME})
    This shows the list of service uplink ports which can be chosen for Loopback

    Path parameters

    Name

    IsRequired

    Description

    Enum

    serviceName required Service Name ---
    nENAME required NENAME ---
    pACKNAME required PACKNAME ---

    Return type
  • PortDetailsList
  • Responses

    Response Messages

    Schema

    200success PortDetailsList
    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/SAT/isSATonAServiceWithLagOrMacLagEp/{serviceName}
    This API returns true if sat on which we were to deploy a service has a lag or mclag as endpoint (isSATonAServiceWithLagOrMacLagEp : /esmBrowser/SAT/isSATonAServiceWithLagOrMacLagEp/{serviceName})
    This API returns true if sat on which we were to deploy a service has a lag or mclag as endpoint

    Path parameters

    Name

    IsRequired

    Description

    Enum

    serviceName required Service Name ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

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

    AcceptanceCriteria

    Name

    Type

    Description

    Enum

    cirThreshold Long long --- ---
    cirThresholdUnits String string --- ---
    pirThreshold Long long --- ---
    pirThresholdUnits String string --- ---
    latencyRisingThreshold String string --- ---
    latencyRisingThresholdIn String string --- ---
    latencyRisingThresholdOut String string --- ---
    jitterRisingThreshold String string --- ---
    jitterRisingThresholdIn String string --- ---
    jiterRisingThresholdOut String string --- ---
    lossRisingThreshold String string --- ---
    lossRisingThresholdIn String string --- ---
    lossRisingThresholdOut String string --- ---
    satACID Long long --- ---
    satAsscdProfileId Long long --- ---
    satVsId Long long --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    N_SHGData

    Name

    Type

    Description

    Enum

    name String string Split Horizon Group Name ---
    description String string Split Horizon Group Description ---
    shgHandle Long long Split Horizon Group Handle ---
    vsid Integer integer Vitual Switch Identifier ---
    rootEndpoints array[Integer] integer RootEndPoints ---
    leafEndpoints array[Integer] integer LeafEndPoints ---

    PayLoad

    Name

    Type

    Description

    Enum

    payloadType String string --- ---
    dataPattern String string --- ---
    etherType String string --- ---
    satPayloadId Long long --- ---
    satAsscdProfileId Long long --- ---
    satVsId Long long --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    PortDetails

    Name

    Type

    Description

    Enum

    portName String string PortName ---
    tpId Integer integer TpId ---
    autoNeg String string Auto-negotiation value [No, Limited]
    duplexMode String string DuplexMode [Full]
    neId Integer integer NEId ---
    portRate String string Port Rate [1 GBE or 10 GBE]
    neVersion String string NeVersion ---
    portState String string Port State ---
    portMacAddress String string PortMacAddress ---
    id String string --- ---
    portPrimaryState String string Port Primary State ---
    priority Integer integer --- ---

    PortDetailsList

    Name

    Type

    Description

    Enum

    portDetails array[PortDetails] PortDetails NE port Data wrapper model list ---
    items array[PortDetails] PortDetails --- ---

    PortSelection

    Name

    Type

    Description

    Enum

    nearEndAccessPoint String string --- ---
    testHead String string --- ---
    nearEndLoopback String string --- ---
    nearEndSrcMacAddress String string --- ---
    nearEndDestAddress String string --- ---
    farEndAccessPoint String string --- ---
    farEndLoopback String string --- ---
    farEndSrcMacAddress String string --- ---
    farEndDestMacAddress String string --- ---

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

    SATAcceptanceCriteriaUIData

    Name

    Type

    Description

    Enum

    acList array[AcceptanceCriteria] AcceptanceCriteria --- ---
    items array[AcceptanceCriteria] AcceptanceCriteria --- ---

    SATDetailsUI

    Name

    Type

    Description

    Enum

    satSvcName String string --- ---
    satName String string --- ---
    satDesc String string --- ---
    satcreateTime Long long --- ---
    satAuth String string --- ---
    satColorAware String string --- ---
    satForwClass String string --- ---
    satProfId Long long --- ---
    satPayldId Long long --- ---
    satAccCrtId Long long --- ---
    satrunState String string --- ---
    satnmlSvcId Long long --- ---
    satnmlTestId Long long --- ---
    satRunId Integer integer --- ---
    vsId Long long --- ---
    hours String string --- ---
    minites String string --- ---
    seconds String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    SATDetailsUIData

    Name

    Type

    Description

    Enum

    satDetailsUIList array[SATDetailsUI] SATDetailsUI --- ---
    items array[SATDetailsUI] SATDetailsUI --- ---

    SATFramePayloadUIData

    Name

    Type

    Description

    Enum

    payloadList array[PayLoad] PayLoad --- ---
    items array[PayLoad] PayLoad --- ---

    SATPortSelectionUIData

    Name

    Type

    Description

    Enum

    items array[SATPortsUI] SATPortsUI --- ---

    SATPortsUI

    Name

    Type

    Description

    Enum

    satAccEndpntNE String string --- ---
    satTestHead String string --- ---
    satLoopBackNE String string --- ---
    satSrcMacAddrsNE String string --- ---
    satDestMacAddrsNE String string --- ---
    satAccEndpntFE String string --- ---
    satLoopBackFE String string --- ---
    satSrcMacAddrsFE String string --- ---
    satDestMacAddrsFE String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    SATResults

    Name

    Type

    Description

    Enum

    rtestName String string --- ---
    rprofId Long long --- ---
    rpayId Long long --- ---
    rACId Long long --- ---
    rstartTime String string --- ---
    rendTime String string --- ---
    rAvgTime String string --- ---
    rStoped String string --- ---
    rCompletd String string --- ---
    rinjected Double double --- ---
    rreceived Double double --- ---
    rmin Long long --- ---
    rmax Long long --- ---
    ravg Long long --- ---
    rjitter Integer integer --- ---
    rconfig String string --- ---
    roper String string --- ---
    rmeasued String string --- ---
    rflrnconfig Integer integer --- ---
    rflrmeasured Integer integer --- ---
    rflraccptd String string --- ---
    rlatnconfig Integer integer --- ---
    rlatnmeasured Long long --- ---
    rlataccptd String string --- ---
    rjitterconfig Integer integer --- ---
    rjittermeasured Integer integer --- ---
    rjitteraccptd String string --- ---
    sapIdName String string --- ---
    forwardingClass String string --- ---
    colorAwareTest String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    SATResultUIData

    Name

    Type

    Description

    Enum

    items array[SATResults] SATResults --- ---

    SATTemplateDataHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    id Long long --- ---
    templateId Long long --- ---
    templateName String string --- ---
    author String string --- ---
    desc String string --- ---
    templateState String string --- ---
    templatePath String string --- ---
    createTime Long long --- ---
    modifyTime Long long --- ---
    colourAware Integer integer --- ---
    forwardingClass String string --- ---
    serviceName String string --- ---
    testPorfile TestProfile TestProfile --- ---
    payLoad PayLoad PayLoad --- ---
    acceptanceCriteria AcceptanceCriteria AcceptanceCriteria --- ---
    portSelection PortSelection PortSelection --- ---
    schedServiceData SchedServiceData SchedServiceData --- ---
    activate Boolean boolean --- ---

    SATTestHeadProfileUIData

    Name

    Type

    Description

    Enum

    profileList array[TestProfile] TestProfile --- ---
    items array[TestProfile] TestProfile --- ---

    SATUIData

    Name

    Type

    Description

    Enum

    nmlTestId Long long --- ---
    testName String string --- ---
    author String string --- ---
    description String string --- ---
    forwardingClass String string --- ---
    isColorAware String string --- ---
    remark String string --- ---
    createTime String string --- ---
    lastUpdateTime String string --- ---
    vsId Long long --- ---
    runId Long long --- ---
    satProfileId Long long --- ---
    satPayloadId Long long --- ---
    satACID Long long --- ---
    satSAPID Long long --- ---
    satSAPName String string --- ---
    runState String string --- ---
    objectScope String string --- ---
    nmlServiceId Long long --- ---
    asscdServiceName String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    satProfileIdUI Long long --- ---

    SATUIDataList

    Name

    Type

    Description

    Enum

    satList array[SATUIData] SATUIData --- ---
    items array[SATUIData] SATUIData --- ---

    SchedServiceData

    Name

    Type

    Description

    Enum

    jobName String string --- ---
    jobDesc String string --- ---
    userName String string --- ---
    trigger SchedTriggerData SchedTriggerData --- ---

    SchedTriggerData

    Name

    Type

    Description

    Enum

    name String string --- ---
    deployNow String string --- ---
    type String string --- ---
    expression String string --- ---
    timeOffset String string --- ---

    Service UI Data model

    Name

    Type

    Description

    Enum

    managementState String string Current management state of the service ---
    toManagementState String string The target management state of the service ---
    serviceName String string Unique name for the service ---
    serviceDescr String string Description for the service ---
    serviceType String string Service type [EPL, EVPL, EPLAN, EVPLAN, EPTREE, EVPTREE]
    serviceState String string Service state [In service, Out of service, Not in service, Inconsistent, partial, unknown , --]
    serviceId Long long Service Identifier ---
    jobTaskId Long long JobTaskId ---
    pmState Integer integer pmState ---
    shgData N_SHGData N_SHGData shgData ---
    eTreeType Integer integer --- ---
    svcParams ServiceParams ServiceParams service parameters ---
    networkTechnology Integer integer --- ---
    switchOperationName String string Switch Operation Name [SWITCH, CLEARSWITCH]
    targetPseudowire String string Target Pseudowire name [PRIMARY, STANDBY_1, STANDBY_2, STANDBY_3, STANDBY_4]

    ServiceEndPoints

    Name

    Type

    Description

    Enum

    encapType String string Encapsulation Type [Null, QinQ, Dot1Q]
    ethManPort String string --- ---
    portRate String string PortRate ---
    vsId Integer integer vsId ---
    noOfServicesDeployed Integer integer getNoOfServicesDeployed ---
    remainingDeployableServiceCount Integer integer getRemainingDeployableServiceCount ---
    vsName String string Vitrual switch name ---
    endpointType Integer integer EndPointType ---
    mclagid Long long MclagId ---
    mclagName String string --- ---
    shgCreated Boolean boolean --- ---
    shgId Integer integer Split Horizon Group Identifier ---
    shgName String string Split Horizon Group Name ---
    shgDescription String string Split Horizon Group Description ---
    hubSpoke String string --- ---
    ingrsEMLVALUE String string IngrsEMLVALUE ---
    egrsEMLVALUE String string EgrsEMLVALUE ---
    primaryState String string Primary State of the port [In Service, In Service- AINS , Out of Service, Out Of Service-Autonomous, Out Of Service - Auto and Mgmt, Maintenance]
    userLabel String string --- ---
    portDescription String string Description of the port ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    vne Boolean boolean Check if the vs is VNE ---
    packetSwitch Boolean boolean --- ---
    macAddress String string --- ---
    neVersionR12 Boolean boolean --- ---

    ServiceEndPointsList

    Name

    Type

    Description

    Enum

    items array[ServiceEndPoints] ServiceEndPoints --- ---

    ServiceIdResponseHolderModel

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model Response wrapper for operation status ---
    rsp Service UI Data model Service UI Data model Wrapper for different attribute values that were used for the service ---

    ServiceParams

    Name

    Type

    Description

    Enum

    llf Integer integer LLF Enabled/Disabled [0, 1]
    l2pt Integer integer L2PT Enabled/Disabled [0, 1]
    lacp Integer integer LAPT Enabled/Disabled [0, 1]
    l2cp Integer integer L2CP Enabled/Disabled [0, 1]
    eplOp2TunnelEnabled Integer integer EPL Option 2 Tunnel Enabled/Disabled [0, 1]
    fragmentType Integer integer Fragment Type [0, 1]
    vlanRangeEnabled Integer integer VLAN Range Enabled/Disabled [0, 1]
    cvlan String string CVLAN Value ---

    TestProfile

    Name

    Type

    Description

    Enum

    dot1pInprofile Integer integer --- ---
    dot1pOutprofile Integer integer --- ---
    cirRate Long long --- ---
    cirRateUnits String string --- ---
    pirRate Long long --- ---
    pirRatUnits String string --- ---
    adaptationRule String string --- ---
    frameSize Integer integer --- ---
    hours String string --- ---
    minites String string --- ---
    seconds String string --- ---
    satProfileId Long long --- ---
    satVsId Long long --- ---
    timeDurationStr String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    satProfileIdUI Long long --- ---