Operation

post /esmService/satTemplate/createSATTemplate
creates sat template (createSATTemplate : /esmService/satTemplate/createSATTemplate)
creates sat template from UI data

Request body

Name

IsRequired

Description

Data Type

Enum

body required SAT template UI data SATTemplateDataHolder ---

Return type
  • Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Template Response Data Holder
    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/satTemplate/deleteSATTemplate
    deletes a sat template (deleteSATTemplate : /esmService/satTemplate/deleteSATTemplate)
    deletes a sat template based on UI request provided the SAT template is not in published state

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required SAT template UI data SATTemplateDataHolder ---

    Return type
  • Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Template Response Data Holder
    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/satTemplate/modifySATTemplate
    modifies existing sat template (modifySATTemplate : /esmService/satTemplate/modifySATTemplate)
    modifies sat template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required SAT template UI data SATTemplateDataHolder ---

    Return type
  • Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Template Response Data Holder
    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/satTemplate/publishSATTemplate
    published a new or existing sat template (publishSATTemplate : /esmService/satTemplate/publishSATTemplate)
    publishes sat template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required SAT template UI data SATTemplateDataHolder ---

    Return type
  • Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Template Response Data Holder
    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/satTemplate/unPublishSATTemplate
    unpublished a published sat template (unPublishSATTemplate : /esmService/satTemplate/unPublishSATTemplate)
    unpublishes sat template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required SAT template UI data SATTemplateDataHolder ---

    Return type
  • Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Template Response Data Holder
    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 :

    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 --- ---
    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 --- ---
    payloadType String string --- ---
    dataPattern String string --- ---
    etherType String string --- ---
    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 --- ---
    jobName String string --- ---
    jobDescription String string --- ---
    username String string --- ---
    triggerName String string --- ---
    deployNow String string --- ---
    triggerType String string --- ---
    expression String string --- ---
    timeOffset String string --- ---
    activate Boolean boolean --- ---

    Template Response Data Holder

    Name

    Type

    Description

    Enum

    message String string responseMessage ---
    msgCode String string responseMessage Code ---
    status String string responseMessageStatus ---
    parameters array[String] string responseParameters ---
    paramCount Integer integer responseParametersCount ---