Operation

get /esmBrowser/topoTemplate/getERPTemplate/{context}
ErpTemplates (getERPTemplate : /esmBrowser/topoTemplate/getERPTemplate/{context})
This method fetches particular ERP Template details including cli details and oam details based on given Template Name

Path parameters

Name

IsRequired

Description

Enum

context required Name of the ERP template, with path. Use + as delimiter between the folder names in template path. ---

Return type
  • ERPTemplateHolder
  • Responses

    Response Messages

    Schema

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

    /esmBrowser/topoTemplate/getERPTemplate/Best Practices+ERP Template+ERP_Ring

    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
    <ERPTemplate> <author>alcatel</author> <createTime>0</createTime> <descr>Best Practices for ERP Ring</descr> <guardtime>5</guardtime> <modifyTime>0</modifyTime> <oamMaNAme>OAMerp</oamMaNAme> <oamMdId>1</oamMdId> <oamMdLevel>0</oamMdLevel> <oamTemplateName>OAM_FOR_ERP</oamTemplateName> <oamTemplatePath>Best Practices/OAM Template</oamTemplatePath> <postProvCliCmd/> <preProvCliCmd/> <propagateTopologyChange>0</propagateTopologyChange> <protID>0</protID> <revertTime>300</revertTime> <holdUpTime>3</holdUpTime> <holdDownTime>7</holdDownTime> <holdTimeType>seconds</holdTimeType> <revertive>true</revertive> <ringType>Ring</ringType> <templateID>0</templateID> <templateId>0</templateId> <templateName>ERP_Ring</templateName> <templatePath>Best Practices/ERP Template/</templatePath> <templateState>PUBLISHED</templateState> </ERPTemplate>

    External Docs
    See Also :

    Operation

    get /esmBrowser/topoTemplate/getERPTemplateById/{id}
    ErpTemplates (getERPTemplate : /esmBrowser/topoTemplate/getERPTemplateById/{id})
    This method fetches particular ERP Template details including cli details and oam details based on given Template id

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required Name of the ERP template, with path. Use + as delimiter between the folder names in template path. ---

    Return type
  • ERPTemplateHolder
  • Responses

    Response Messages

    Schema

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

    /oms1350/esmBrowser/topoTemplate/getERPTemplateById/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
    { "templateID": 0, "templateId": 0, "templateName": "ERP_Ring", "templatePath": "Best Practices/ERP Template/", "descr": "Best Practices for ERP Ring", "author": "alcatel", "ringType": "Ring", "templateState": "PUBLISHED", "createTime": 0, "modifyTime": 0, "revertive": true, "cvlanId": null, "svlanId": null, "guardtime": 5, "revertTime": 300, "holdUpTime": 0, "holdDownTime": 0, "holdTimeType": "seconds", "protectionSwitchState": null, "protID": 0, "preProvCliCmd": "", "postProvCliCmd": "", "oamTemplateName": "OAM_FOR_ERP", "oamMaNAme": "OAMerp", "oamTemplatePath": "Best Practices/OAM Template", "oamMdId": 1, "oamMdLevel": 0, "propagateTopologyChange": 0, "sharedVpls": 0, "oamtemplateMAHolders": [ { "templateName": "Best Practices/OAM Template/OAM_FOR_ERP", "maName": "OAMerp", "author": "alcatel", "description": "Best practice OAM for ERP", "oamSupported": "0", "maFormat": "ITU-ICC", "ccmInterval": "3.3ms", "mhfCreation": "null", "direction": "DOWN", "interfaceType": "Ring Path", "active": "true", "controlMep": "true", "lowestPriorityDefect": "MAC, Remote, Error, Xcon", "ccmEnable": "true", "ccmPriority": 7, "aisEnable": "false", "aisPriority": 7, "aisInterval": 60, "aisLevel": null, "aisLevel1": false, "aisLevel2": false, "aisLevel3": false, "aisLevel4": false, "aisLevel5": false, "aisLevel6": false, "aisLevel7": false, "id": 1, "mdId": 1 } ] }

    External Docs
    See Also :

    ERPTemplateHolder

    Name

    Type

    Description

    Enum

    templateID Integer integer ERP template Identifier ---
    templateId Integer integer ERP template Identifier ---
    templateName String string ERP template name ---
    templatePath String string ERP template path ---
    completeTemplateName String string --- ---
    descr String string Description ---
    author String string Author ---
    ringType String string ringType [Ring, Sub-Ring]
    templateState String string Template State [Published, UnPublished]
    createTime Long long Create time ---
    modifyTime Long long Modification time ---
    revertive Boolean boolean ERP protection type check ---
    cvlanId String string cvlanId ---
    svlanId String string svlanId ---
    guardtime Integer integer guard Time ---
    revertTime Integer integer Revert time ---
    holdUpTime Integer integer holdUpTime ---
    holdDownTime Integer integer holdDownTime ---
    holdTimeType String string holdTimeType [seconds, centiseconds]
    protectionSwitchState String string protectionSwitchState ---
    protID Integer integer Protection Id ---
    preProvCliCmd String string preProvCliCmd ---
    postProvCliCmd String string postProvCliCmd ---
    oamTemplateName String string OAM template name ---
    oamMaNAme String string MA name ---
    oamTemplatePath String string OamTemplatePath ---
    oamMdId Integer integer OamMdId ---
    oamMdLevel Integer integer OAM maintenance domain level [0, 1, 2, 3, 4, 5, 6, 7]
    propagateTopologyChange Integer integer This parameter is applicable only for Sub Rings. This parameter from the sub ring to the major ring. ---
    sharedVpls Integer integer sharedVpls ---