Operation

post /esmService/packetSwitchTemplate/createPacketSwitchTemplate
creates packet switch template (createPacketSwitchTemplate : /esmService/packetSwitchTemplate/createPacketSwitchTemplate)
creates packet switch template from UI data

Request body

Name

IsRequired

Description

Data Type

Enum

body required packet switch ui data Packet Switch Template data holder ---

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

    {"templateName":"NewPacketSwitchTemplate","author":"alcatel","desc":"Packet Switch template description","templateState":"PUBLISHED","templatePath":"My Templates/Packet Switch Templates/","operationalMode":2,"preProvCliCmd":"","postProvCliCmd":""}

    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
    {"message":"Packet Switch template publish: success","msgCode":"PACKET_SWITCH_TMPL_002","status":"SUCCESS","parameters":["My Templates/Packet Switch Templates/NewPacketSwitchTemplate"],"paramCount":1}

    External Docs
    See Also :

    Operation

    post /esmService/packetSwitchTemplate/deletePacketSwitchTemplate
    delete Packet Switch template (deletePacketSwitchTemplate : /esmService/packetSwitchTemplate/deletePacketSwitchTemplate)
    delete Packet Switch template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required packet switch ui data Packet Switch Template data holder ---

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

    {"templateName":"NewPS","templatePath":"My Templates/Packet Switch Templates/"}

    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
    {"message":"Packet Switch template delete : success","msgCode":"PACKET_SWITCH_TMPL_003","status":"SUCCESS","parameters":["My Templates/Packet Switch Templates/NewPS"],"paramCount":1}

    External Docs
    See Also :

    Operation

    post /esmService/packetSwitchTemplate/modifyPacketSwitchTemplate
    modify packet switch template (modifyPacketSwitchTemplate : /esmService/packetSwitchTemplate/modifyPacketSwitchTemplate)
    modify packet switch template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required packet switch ui data Packet Switch Template data holder ---

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

    {"templateName":"NewPacketSwitchTemplate","author":"alcatelNew","desc":"Packet Switch template description modified","templateState":"UNPUBLISHED","templatePath":"My Templates/Packet Switch Templates/","operationalMode":2,"preProvCliCmd":"","postProvCliCmd":""}

    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
    {"message":"Packet Switch template modify : success","msgCode":"PACKET_SWITCH_TMPL_004","status":"SUCCESS","parameters":["My Templates/Packet Switch Templates/NewPacketSwitchTemplate"],"paramCount":1}

    External Docs
    See Also :

    Operation

    post /esmService/packetSwitchTemplate/publishPacketSwitchTemplate
    publish packet switch template (publishPacketSwitchTemplate : /esmService/packetSwitchTemplate/publishPacketSwitchTemplate)
    publish packet switch from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required packet switch ui data Packet Switch Template data holder ---

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

    {"templateName":"NewPacketSwitchTemplate","templateState":"UNPUBLISHED","templatePath":"My Templates/Packet Switch Templates/"}

    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
    {"message":"Packet Switch template Publish : success","msgCode":"PACKET_SWITCH_TMPL_002","status":"SUCCESS","parameters":["My Templates/Packet Switch Templates/NewPacketSwitchTemplate"],"paramCount":1}

    External Docs
    See Also :

    Operation

    post /esmService/packetSwitchTemplate/unpublishPacketSwitchTemplate
    unpublish packet switch template (unpublishPacketSwitchTemplate : /esmService/packetSwitchTemplate/unpublishPacketSwitchTemplate)
    unpublish packet switch template from UI data

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required packet switch ui data Packet Switch Template data holder ---

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

    {"templateName":"NewPS","templateState":"PUBLISHED","templatePath":"My Templates/Packet Switch Templates/"}

    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
    {"message":"Packet Switch template unPublish : success","msgCode":"PACKET_SWITCH_TMPL_003","status":"SUCCESS","parameters":["My Templates/Packet Switch Templates/NewPS"],"paramCount":1}

    External Docs
    See Also :

    Packet Switch Template data holder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId Request Header Request Header --- ---
    templatePath String string --- ---
    templateId Long long --- ---
    templateName String string --- ---
    templateType String string --- ---
    author String string --- ---
    desc String string --- ---
    templateState String string --- ---
    operationalMode Long long --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    activate Boolean boolean --- ---

    Request Header

    Name

    Type

    Description

    Enum

    reqId String string ReqId ---
    respBeanRef String string --- ---
    clientName String string ClientName ---
    selectiveSyncViaPolling 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 ---