Operation

post /oamTemplateService/createOAMTemplate
createOAMTemplate (createOAMTemplate : /oamTemplateService/createOAMTemplate)
This method creates OAM Template on click of save /save As button with validations like template name validation, unique template name,associated ma data list must not be empty, Ma name must be unique. MA and MEP details are also persisted. Input data is ttemplate name , author , description, oam supported, md format , md level, template state

Request body

Name

IsRequired

Description

Data Type

Enum

body required OAM template Data nOAMTemplateDataHolder ---

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

    <OAMTemplateHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <author>alcatel</author> <createTime/> <descr>OAM</descr> <mdData> <mdFormat>NONE</mdFormat> <mdlevel>0</mdlevel> <maDataList> <maData> <ccmInterval>10s</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>dfds</maName> <mep> <direction>UP</direction> <interfaceType>SAP</interfaceType> <active>false</active> <controlMep>false</controlMep> <lowestPriorityDefect>MAC, Remote, Error, Xcon</lowestPriorityDefect> <ccmEnable>false</ccmEnable> <ccmPriority>7</ccmPriority> <aisEnable>false</aisEnable> <aisInterval>60</aisInterval> <aisPriority>7</aisPriority> <aisLevelList/> </mep> <mhfCreation>0</mhfCreation> </maData> </maDataList> </mdData> <modifyTime/> <oamSupported>Service</oamSupported> <oamTemplate> <Name>CMKRestOAM</Name> <Path>My Templates/OAM Templates/</Path> <id/> <MaNames> <maName>dfds</maName> </MaNames> </oamTemplate> <state>unpublished</state> </req> </OAMTemplateHolder>

    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>OAM Template saved successfully</message> <msgCode>TMPL_001</msgCode> <paramCount>1</paramCount> <parameters>REST-OAM-LLF</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>

    External Docs
    See Also :

    Operation

    post /oamTemplateService/deleteOAMTemplate
    deleteOAMTemplate (deleteOAMTemplate : /oamTemplateService/deleteOAMTemplate)
    This method deletes OAM template on click on delete button. It fails when OAM is associated with ERP or service template

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required OAM template Data nOAMTemplateIdHolder ---

    Return type
  • OAM Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success OAM 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

    <OAMTemplateIdHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <Name>CMKRestOAM</Name> <Path>My Templates/OAM Templates/</Path> </req> </OAMTemplateIdHolder>

    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
    <OAMTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>OAM_SUCCESS_003</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/OAM Templates/REST-OAM-LLF</parameters> </responseId> </OAMTemplateIdRespHolder>

    External Docs
    See Also :

    Operation

    post /oamTemplateService/modifyOAMTemplate
    modifyOAMTemplate (modifyOAMTemplate : /oamTemplateService/modifyOAMTemplate)
    This method modifies OAM Template with validation like modified MA Name already exists.Input data is ttemplate name , author , description, oam supported, md format , md level, template state.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required OAM template Data nOAMTemplateDataHolder ---

    Return type
  • OAM Template Response Data Holder
  • Responses

    Response Messages

    Schema

    200success OAM 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

    <OAMTemplateHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <author>alcatel</author> <createTime/> <descr>OAMsdjfn</descr> <mdData> <mdFormat>NONE</mdFormat> <mdlevel>0</mdlevel> <maDataList> <maData> <ccmInterval>10s</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>dfds</maName> <mep> <direction>UP</direction> <interfaceType>SAP</interfaceType> <active>false</active> <controlMep>false</controlMep> <lowestPriorityDefect>MAC, Remote, Error, Xcon</lowestPriorityDefect> <ccmEnable>false</ccmEnable> <ccmPriority>7</ccmPriority> <aisEnable>false</aisEnable> <aisInterval>60</aisInterval> <aisPriority>7</aisPriority> <aisLevelList/> </mep> <mhfCreation>0</mhfCreation> </maData> </maDataList> </mdData> <modifyTime/> <oamSupported>Service</oamSupported> <oamTemplate> <Name>CMKRestOAM</Name> <Path>My Templates/OAM Templates/</Path> <id/> <MaNames> <maName>dfds</maName> </MaNames> </oamTemplate> <state>unpublished</state> </req> </OAMTemplateHolder>

    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
    <OAMTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <jobName/> <msgCode>OAM_SUCCESS_004</msgCode> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/OAM Templates/OAM_Generated_Test_Service_VNE-1</parameters> </responseId> </OAMTemplateIdRespHolder>

    External Docs
    See Also :

    nOAMMATemplateData

    Name

    Type

    Description

    Enum

    maFormat String string --- ---
    maName String string --- ---
    ccmInterval String string --- ---
    mhfCreation String string --- ---
    mep nOAMMEPTemplateData nOAMMEPTemplateData --- ---

    nOAMMDTemplateData

    Name

    Type

    Description

    Enum

    mdFormat String string --- ---
    mdlevel Integer integer --- ---
    maData array[nOAMMATemplateData] nOAMMATemplateData --- ---

    nOAMMEPTemplateData

    Name

    Type

    Description

    Enum

    direction String string --- ---
    interfaceType String string --- ---
    active String string --- ---
    controlMep String string --- ---
    lowestPriorityDefect String string --- ---
    ccmEnable String string --- ---
    ccmPriority Integer integer --- ---
    aisEnable String string --- ---
    aisInterval Integer integer --- ---
    aisLevel array[Integer] integer --- ---
    aisPriority Integer integer --- ---
    propagateHoldTime Integer integer --- ---
    standbyMepShutdownEnabled Boolean boolean --- ---

    nOAMTemplateData

    Name

    Type

    Description

    Enum

    oamTemplate nOAMTemplateId nOAMTemplateId --- ---
    author String string --- ---
    descr String string --- ---
    state String string --- ---
    createTime Long long --- ---
    modifyTime Long long --- ---
    oamSupported String string --- ---
    mdData nOAMMDTemplateData nOAMMDTemplateData --- ---

    nOAMTemplateDataHolder

    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 nOAMTemplateData nOAMTemplateData --- ---
    activate Boolean boolean --- ---

    nOAMTemplateId

    Name

    Type

    Description

    Enum

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

    nOAMTemplateIdHolder

    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 nOAMTemplateId nOAMTemplateId --- ---
    activate Boolean boolean --- ---

    OAM Template Response Data Holder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model response ---
    rsp nOAMTemplateId nOAMTemplateId nOAMTemplateId ---

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