Operation

post /esmService/SAT/cleanupFailedSAT/
cleanupFailedSAT (cleanupFailedSAT : /esmService/SAT/cleanupFailedSAT/)
Cleans up entities from NE for failed Service Activation Test.

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData E_SATIdHolder ---

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

    post /esmService/SAT/deleteSAT/
    deleteSAT (deleteSAT : /esmService/SAT/deleteSAT/)
    Deletes the Profile, Acceptance Criteria and Payload entities for this SAT along with the Elementary SAT record from the VS.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData SATEProfileIdHolder ---

    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
    Example Request Data

    https://135.250.185.196:8443/oms1350/esmService/SAT/deleteSAT/

    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
    {"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"SAT_RUNSTATE_RUNNING_ERROR","parameters":[],"paramCount":0,"objectId":0,"jobName":"","objectType":0,"output":null},"rsp":null}

    External Docs
    See Also :

    Operation

    post /esmService/SAT/deploySAT/
    deploySAT (deploySAT : /esmService/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
    Example Request Data

    { "templateId": 1, "templateName": "SAT", "author": "alcatel", "desc": "Best practice template for SAT", "templateState": "PUBLISHED", "templatePath": "Best Practices/SAT Templates/", "createTime": 0, "modifyTime": 0, "colourAware": 0, "forwardingClass": "Best-Effort", "serviceName": "DND_TEST_SAT_LOOPBACK", "testPorfile": { "dot1pInprofile": 0, "dot1pOutprofile": 0, "cirRate": 1000, "cirRateUnits": "kbps", "pirRate": 500, "pirRatUnits": "kbps", "adaptationRule": "Closest", "frameSize": 1514, "hours": "00", "minites": "03", "seconds": "00" }, "payLoad": { "payloadType": "L2", "dataPattern": "0xa1b2c3d4e5f6", "etherType": "0x0800" }, "acceptanceCriteria": { "cirThreshold": 0, "cirThresholdUnits": "kbps", "pirThreshold": 0, "pirThresholdUnits": "kbps", "latencyRisingThreshold": "90", "latencyRisingThresholdIn": null, "latencyRisingThresholdOut": null, "jitterRisingThreshold": "5", "jitterRisingThresholdIn": null, "jiterRisingThresholdOut": null, "lossRisingThreshold": "1", "lossRisingThresholdIn": null, "lossRisingThresholdOut": null }, "portSelection": { "nearEndAccessPoint": "", "testHead": "", "nearEndLoopback": "", "nearEndSrcMacAddress": "", "nearEndDestAddress": "", "farEndAccessPoint": "", "farEndLoopback": "", "farEndSrcMacAddress": "", "farEndDestMacAddress": "" }, "schedServiceData": { "jobName": "Run_test_Wed May 10 2017 13:42:12UTC+5:30", "jobDesc": "", "username": "alcatel", "trigger": { "deployNow": "Yes", "expression": "", "name": "", "type": 0 } } }

    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
    { "responseId": { "req": null, "errorReason": "", "errorCode": null, "message": null, "cmdStatus": "Success", "opMsg": "", "msgCode": "SAT_EXECUTION_001", "parameters": [ "SAT" ], "paramCount": 1, "output": null } , "rsp": null }

    External Docs
    See Also :

    Operation

    post /esmService/SAT/stopSAT/
    stopSAT (stopSAT : /esmService/SAT/stopSAT/)
    Stops an in-progress Service Activation Test.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData E_SATIdHolder ---

    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
    Example Request Data

    {"schedServiceData":{"trigger":{"name":"SATCleanUp_ServiceName_SVC_MPLS_SAT_Wed Jul 05 2017 16:49:59 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""},"username":"alcatel","jobName":"SATCleanUp_ServiceName_SVC_MPLS_SAT_Wed Jul 05 2017 16:49:59 UTC+5:30","jobDescription":""},"serviceName":"SVC_MPLS_SAT","nmlServiceHandle":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
    {"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"JOBLIST_ERROR_0002","parameters":["SAT","Service","SVC_MPLS_SAT","SATCleanUp_ServiceName_SVC_MPLS_SAT_Wed Jul 05 2017 15:52:04 UTC+5:30"],"paramCount":4,"objectId":0,"jobName":"","objectType":0,"output":null},"rsp":null}

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

    E_SATIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    vsId Long long --- ---
    testName String string --- ---
    runId Long long --- ---
    nmlServiceHandle Long long --- ---
    profileId Long long --- ---
    nSatHandle Long long --- ---
    serviceName String string --- ---
    schedServiceData SchedServiceData SchedServiceData --- ---
    activate Boolean boolean --- ---

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

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

    SATEProfileIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    profileId Long long --- ---
    serviceName String string --- ---
    nmlServiceId Long long --- ---
    vsId Long long --- ---
    nSatHandle Long long --- ---
    schedServiceData SchedServiceData SchedServiceData --- ---
    activate Boolean boolean --- ---

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

    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]

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