Operation

get /esmBrowser/oamTemplateBrowser/getAllOAMTemplates
AllOAMTemplates (getAllOAMTemplates : /esmBrowser/oamTemplateBrowser/getAllOAMTemplates)
This method gets all the OAM Template in published or unpublished state in order of modified time.This method in invoked to view all the templates created.


Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /oamTemplateBrowser/getAllOAMTemplates
    AllOAMTemplates (getAllOAMTemplates : /oamTemplateBrowser/getAllOAMTemplates)
    This method gets all the OAM Template in published or unpublished state in order of modified time.This method in invoked to view all the templates created.


    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

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

    /oamTemplateBrowser/getAllOAMTemplates

    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
    <OAMTemplateHolderList> <OAMTemplateHolders> <createTime>0</createTime> <id>2</id> <mdLevel>3</mdLevel> <modifyTime>0</modifyTime> <name>OAM_FOR_Service</name> <path>Best Practices/OAM Template</path> <state>PUBLISHED</state> </OAMTemplateHolders> </OAMTemplateHolderList>

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/getOAMTemplate/{name}
    OAMTemplate (getOAMTemplate : /esmBrowser/oamTemplateBrowser/getOAMTemplate/{name})
    This method fetches particular OAM Template details based on given Template Name

    Path parameters

    Name

    IsRequired

    Description

    Enum

    name required OAM Template name ---

    Return type
  • OAMTemplate
  • Responses

    Response Messages

    Schema

    200success OAMTemplate
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /oamTemplateBrowser/getOAMTemplate/{name}
    OAMTemplate (getOAMTemplate : /oamTemplateBrowser/getOAMTemplate/{name})
    This method fetches particular OAM Template details based on given Template Name

    Path parameters

    Name

    IsRequired

    Description

    Enum

    name required OAM Template name ---

    Return type
  • OAMTemplate
  • Responses

    Response Messages

    Schema

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

    /oamTemplateBrowser/getOAMTemplate/REST-OAM-LLF

    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
    <OAMTemplate> <author>Rest-Automator</author> <createTime>1449217522594</createTime> <descr>Rest Description</descr> <id>0</id> <mdLevel>0</mdLevel> <modifyTime>1449217522594</modifyTime> <name>REST-OAM-LLF</name> <oamSupported>OAM SERVICE</oamSupported> <path>My Templates/OAM Templates</path> <state>UNPUBLISHED</state> <templateState>UNPUBLISHED</templateState> </OAMTemplate>

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/GetOamMaDetailsFromTemplateAndMaName/{selectedTemplateName}/{selectedMaName}
    GetOamMaDetailsFromTemplateAndMaName (getOamMaDetailsFromTemplateAndMaName : /esmBrowser/oamTemplateBrowser/GetOamMaDetailsFromTemplateAndMaName/{selectedTemplateName}/{selectedMaName})
    This method fetches list of OAM details based on particular oam name and Ma Name

    Path parameters

    Name

    IsRequired

    Description

    Enum

    selectedTemplateName required Template Name ---
    selectedMaName required MA name ---

    Return type
  • OAMTemplateMAHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateMAHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/GetOamMaListFromTemplateName/{selectedTemplateName}
    OamMaListFromTemplateName (getOamMaListFromTemplateName : /esmBrowser/oamTemplateBrowser/GetOamMaListFromTemplateName/{selectedTemplateName})
    This method fetches MA list based on template name.Exception is thrown if tempalte name is not found

    Path parameters

    Name

    IsRequired

    Description

    Enum

    selectedTemplateName required TemplateName ---

    Return type
  • OAMTemplateMAHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateMAHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/GetPubTemplateListFromType/{oamTemplateType}
    GetPubTemplateListFromType (getPubTemplateListFromType : /esmBrowser/oamTemplateBrowser/GetPubTemplateListFromType/{oamTemplateType})
    This method fetches only published OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /oamTemplateBrowser/GetPubTemplateListFromType/{oamTemplateType}
    GetPubTemplateListFromType (getPubTemplateListFromType : /oamTemplateBrowser/GetPubTemplateListFromType/{oamTemplateType})
    This method fetches only published OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

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

    /oamTemplateBrowser/GetPubTemplateListFromType/ERP

    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
    <OAMTemplateHolderList> <OAMTemplateHolders> <author>alcatel</author> <createTime>0</createTime> <descr>Best practice OAM for Service</descr> <id>2</id> <mdFormat>NONE</mdFormat> <mdLevel>3</mdLevel> <modifyTime>0</modifyTime> <name>OAM_FOR_Service</name> <path>Best Practices/OAM Template</path> <state>PUBLISHED</state> </OAMTemplateHolders> </OAMTemplateHolderList>

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/GetPubTemplateListFromTypeJson/{oamTemplateType}
    GetPubTemplateListFromType (getPubTemplateListFromTypeJson : /esmBrowser/oamTemplateBrowser/GetPubTemplateListFromTypeJson/{oamTemplateType})
    This method fetches only published OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    get /oamTemplateBrowser/GetPubTemplateListFromTypeJson/{oamTemplateType}
    GetPubTemplateListFromType (getPubTemplateListFromTypeJson : /oamTemplateBrowser/GetPubTemplateListFromTypeJson/{oamTemplateType})
    This method fetches only published OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    get /esmBrowser/oamTemplateBrowser/GetTemplateListFromType/{oamTemplateType}
    GetTemplateListFromType (getTemplateListFromType : /esmBrowser/oamTemplateBrowser/GetTemplateListFromType/{oamTemplateType})
    This method fetches all published and unpublished OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    get /oamTemplateBrowser/GetTemplateListFromType/{oamTemplateType}
    GetTemplateListFromType (getTemplateListFromType : /oamTemplateBrowser/GetTemplateListFromType/{oamTemplateType})
    This method fetches all published and unpublished OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

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

    /oamTemplateBrowser/GetTemplateListFromType/ERP

    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
    <OAMTemplateHolderList> <OAMTemplateHolders> <author>alcatel</author> <createTime>0</createTime> <descr>Best practice OAM for Service</descr> <id>2</id> <mdFormat>NONE</mdFormat> <mdLevel>3</mdLevel> <modifyTime>0</modifyTime> <name>OAM_FOR_Service</name> <path>Best Practices/OAM Template</path> <state>PUBLISHED</state> </OAMTemplateHolders> </OAMTemplateHolderList>

    External Docs
    See Also :

    Operation

    get /esmBrowser/oamTemplateBrowser/GetTemplateListFromTypeJson/{oamTemplateType}
    GetTemplateListFromType (getTemplateListFromTypeJson : /esmBrowser/oamTemplateBrowser/GetTemplateListFromTypeJson/{oamTemplateType})
    This method fetches all published and unpublished OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    get /oamTemplateBrowser/GetTemplateListFromTypeJson/{oamTemplateType}
    GetTemplateListFromType (getTemplateListFromTypeJson : /oamTemplateBrowser/GetTemplateListFromTypeJson/{oamTemplateType})
    This method fetches all published and unpublished OAM template details based on oam type .If oam type is service then only oam related to service is fetched and if oam type is ERP then oam related to erp is fetched

    Path parameters

    Name

    IsRequired

    Description

    Enum

    oamTemplateType required oam Template Type [SERVICE, ERP]

    Return type
  • OAMTemplateHolderList
  • Responses

    Response Messages

    Schema

    200success OAMTemplateHolderList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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 :

    OAMTemplate

    Name

    Type

    Description

    Enum

    id Integer integer Id ---
    name String string Name ---
    author String string author ---
    descr String string descr ---
    state String string State [PUBLISHED, UNPUBLISHED]
    createTime Long long createTime ---
    modifyTime Long long modifyTime ---
    oamSupported String string oamSupported [Enable, disable]
    templateState String string State [PUBLISHED, UNPUBLISHED]
    mdLevel Integer integer OAM maintenance domain level [0, 1, 2, 3, 4, 5, 6, 7]
    path String string Path ---
    mdFormat String string OAM maintenance domain format [NONE]
    mhfCreation String string MHF Creation to be supported ---
    key String string --- ---
    className String string --- ---

    OAMTemplateHolderList

    Name

    Type

    Description

    Enum

    items array[OAMTemplate] OAMTemplate --- ---

    OAMTemplateMAHolderList

    Name

    Type

    Description

    Enum