Operation

post /esmService/topoTemplate/createERPTemplate
createERPTemplate (createERPTemplate : /esmService/topoTemplate/createERPTemplate)
This method creates ERP Template on click of save/saveAs button . Input data is Template Name , Author , Description , Template State ,Protection guard time , if it is revertive , revertive time,Propagate topology change .ERP Template creation will be successful if Template Name is unique. We can also create a new OAM Template

Request body

Name

IsRequired

Description

Data Type

Enum

body required ERP Template Data nERPTemplateDataHolder ---

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

    <ERPTemplateHolder> <reqId> <reqId>123</reqId> <respBeanRef>None</respBeanRef> <clientName>none</clientName> </reqId> <req> <ringType>Sub Ring</ringType> <sharedVpls>1</sharedVpls> <tempId> <templateName>AUTO-MAJOR-RING-1</templateName> <templatePath>My Templates/ERP Templates/</templatePath> </tempId> <descr>ERP with type Major Ring</descr> <author>Alcatel-lucent</author> <createTime>NA</createTime> <modifyTime>NA</modifyTime> <templateState>UNPUBLISHED</templateState> <protectiondata> <revertive>true</revertive> <guardtime>5</guardtime> <revertTime>300</revertTime> <protectionSwitchState>1</protectionSwitchState> <holdUpTime>3</holdUpTime> <holdDownTime>7</holdDownTime> <holdTimeType>seconds</holdTimeType> </protectiondata> <preProvCliCmd/> <postProvCliCmd/> </req> <oamTemplate> <Name>OAM_FOR_ERP</Name> <Path>Best Practices/OAM Template</Path> <id>0</id> <maName>OAMerp</maName> </oamTemplate> </ERPTemplateHolder>

    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
    <ServiceTemplateResponse> <message>ERP Template saved successfully</message> <msgCode>TMPL_001</msgCode> <paramCount>1</paramCount> <parameters>AUTO-MAJOR-RING-1</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>

    External Docs
    See Also :

    Operation

    post /esmService/topoTemplate/deleteERPTemplate
    deleteERPTemplate (deleteERPTemplate : /esmService/topoTemplate/deleteERPTemplate)
    This method deletes ERP Template on click of delete button. Associated cli are also deleted.Input data is Template name and if template name is not found in saved templates then exception is thrown.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ERP Template ID Data nERPTemplateIdHolder ---

    Return type
  • ERP Template Id Response Data Holder
  • Responses

    Response Messages

    Schema

    200success ERP Template Id Response Data Holder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <ERPTemplateIdHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateName>AUTO-MAJOR-RING-1</templateName> <templatePath>My Templates/ERP Templates/</templatePath> </req> </ERPTemplateIdHolder>

    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
    <ErpTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_DEL_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/ERP Templates/AUTO-MAJOR-RING-1</parameters> </responseId> </ErpTemplateIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/topoTemplate/modifyERPTemplate
    modifyERPTemplate (modifyERPTemplate : /esmService/topoTemplate/modifyERPTemplate)
    This method modifies the created ERP Template on click of save/saveAs button. Published Templates can not be modified . Input data is Template Name , Author , Description , Template State ,Protection guard time , if it is revertive , revertive time,Propagate topology change .ERP Template creation will be successful if Template Name is unique.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ERP Template Data nERPTemplateDataHolder ---

    Return type
  • ERP Template Id Response Data Holder
  • Responses

    Response Messages

    Schema

    200success ERP Template Id Response Data Holder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <ERPTemplateHolder> <reqId> <reqId>123</reqId> <respBeanRef>None</respBeanRef> <clientName>none</clientName> </reqId> <req> <ringType>Major Ring</ringType> <sharedVpls>1</sharedVpls> <tempId> <templateName>AUTO-MAJOR-RING-1</templateName> <templatePath>My Templates/ERP Templates/</templatePath> </tempId> <descr>ERP with type Major Ring MODIFY</descr> <author>Alcatel-lucent</author> <createTime>NA</createTime> <modifyTime>NA</modifyTime> <templateState>UNPUBLISHED</templateState> <protectiondata> <revertive>true</revertive> <guardtime>4</guardtime> <revertTime>295</revertTime> <protectionSwitchState>1</protectionSwitchState> <holdUpTime>3</holdUpTime> <holdDownTime>7</holdDownTime> <holdTimeType>seconds</holdTimeType> </protectiondata> <preProvCliCmd>NODE-K show card 11qce12x 1/10</preProvCliCmd> <postProvCliCmd/> </req> <oamTemplate> <Name>OAM_FOR_ERP</Name> <Path>Best Practices/OAM Template</Path> <id>0</id> <maName>OAMerp</maName> </oamTemplate> </ERPTemplateHolder>

    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
    <ErpTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_MODIFY_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/ERP Templates/AUTO-MAJOR-RING-1</parameters> </responseId> </ErpTemplateIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/topoTemplate/publishERPTemplate
    publishERPTemplate (publishERPTemplate : /esmService/topoTemplate/publishERPTemplate)
    This method publishes ERP Template on click of publish button .Oam template with input MdID is also published . Template state would be published .Input data is Template name and if template name is not found in saved templates then exception is thrown.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ERP Template State data nERPTemplateStateHolder ---

    Return type
  • ERP Template Id Response Data Holder
  • Responses

    Response Messages

    Schema

    200success ERP Template Id Response Data Holder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <ERPTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>AUTO-MAJOR-RING-1</templateName> <templatePath>My Templates/ERP Templates/</templatePath> </templateId> </req> </ERPTemplateStateHolder>

    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
    <ErpTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_PUBLISH_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/ERP Templates/AUTO-MAJOR-RING-1</parameters> </responseId> </ErpTemplateIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/topoTemplate/unpublishERPTemplate
    unpublishERPTemplate (unpublishERPTemplate : /esmService/topoTemplate/unpublishERPTemplate)
    This method unpublishes ERP Template on click of unpublish button .Oam template with input MdId are also unpublished.Template state would be unpublished .Input data is Template name and if template name is not found in saved templates then exception is thrown.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ERP Template state Data nERPTemplateStateHolder ---

    Return type
  • ERP Template Id Response Data Holder
  • Responses

    Response Messages

    Schema

    200success ERP Template Id Response Data Holder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <ERPTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>PUBLISHED</templateState> <templateId> <templateName>AUTO-MAJOR-RING-1</templateName> <templatePath>My Templates/ERP Templates/</templatePath> </templateId> </req> </ERPTemplateStateHolder>

    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
    <ErpTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_UNPUB_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/ERP Templates/AUTO-MAJOR-RING-1</parameters> </responseId> </ErpTemplateIdRespHolder>

    External Docs
    See Also :

    ERP Template data

    Name

    Type

    Description

    Enum

    templateId String string ERP template Identifier ---
    templateName String string ERP template name ---
    templatePath String string ERP template path ---

    ERP Template Id Response Data Holder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model Response wrapper for operation status ---
    rsp ERP Template data ERP Template data ERP Template data ---

    nERPTemplateData

    Name

    Type

    Description

    Enum

    tempId ERP Template data ERP Template data --- ---
    descr String string --- ---
    author String string --- ---
    protectiondata ProtectionParams ProtectionParams --- ---
    templateState String string --- ---
    createTime Long long --- ---
    modifyTime Long long --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    additionalInfo Object object --- ---
    ringType String string --- ---
    propagateTopolgyChange Integer integer --- ---
    sharedVpls Integer integer --- ---

    nERPTemplateDataHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId Request Header Request Header --- ---
    req nERPTemplateData nERPTemplateData --- ---
    oamTemplate nOAMTemplateId nOAMTemplateId --- ---
    activate Boolean boolean --- ---

    nERPTemplateIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId Request Header Request Header --- ---
    req ERP Template data ERP Template data --- ---
    activate Boolean boolean --- ---

    nERPTemplateState

    Name

    Type

    Description

    Enum

    templateId ERP Template data ERP Template data --- ---
    templateState String string --- ---

    nERPTemplateStateHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId Request Header Request Header --- ---
    req nERPTemplateState nERPTemplateState --- ---
    activate Boolean boolean --- ---

    nOAMTemplateId

    Name

    Type

    Description

    Enum

    id String string Id ---
    maName String string MaName ---
    demarcName String string Name ---
    demarcPath String string OamTemplatePath ---
    demarcId String string Id ---
    demarcMaName String string DemarcationMaName ---
    path String string OamTemplatePath ---
    name String string Name ---

    ProtectionParams

    Name

    Type

    Description

    Enum

    revertive Boolean boolean --- ---
    guardtime Integer integer --- ---
    revertTime Integer integer --- ---
    holdUpTime Integer integer holdUpTime ---
    holdDownTime Integer integer holdDownTime ---
    holdTimeType String string holdTimeType [seconds, centiseconds]
    protectionSwitchState String string --- ---
    additionalInfo Object object --- ---
    templateId Integer integer --- ---

    Request Header

    Name

    Type

    Description

    Enum

    respBeanRef String string --- ---
    selectiveSyncViaPolling Boolean boolean --- ---
    clientName String string ClientName ---
    reqId String string ReqId ---

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

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