Operation

post /oamTemplateService/createOAMTemplate
createOAMTemplate (createOAMTemplate : /oamTemplateService/createOAMTemplate)
createOAMTemplate

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData nOAMTemplateDataHolder ---

Return type
  • ServiceTemplateResponse
  • Responses

    Response Messages

    Schema

    200success ServiceTemplateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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

    post /oamTemplateService/deleteOAMTemplate
    deleteOAMTemplate (deleteOAMTemplate : /oamTemplateService/deleteOAMTemplate)
    deleteOAMTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nOAMTemplateIdHolder ---

    Return type
  • OAMTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success OAMTemplateIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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

    post /oamTemplateService/modifyOAMTemplate
    modifyOAMTemplate (modifyOAMTemplate : /oamTemplateService/modifyOAMTemplate)
    modifyOAMTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nOAMTemplateDataHolder ---

    Return type
  • OAMTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success OAMTemplateIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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 :

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

    nOAMTemplateId

    Name

    Type

    Description

    Enum

    path String string --- ---
    maName String string --- ---
    demarcPath String string --- ---
    demarcId String string --- ---
    demarcMaName String string --- ---
    name String string --- ---
    id String string --- ---
    demarcName String string --- ---

    nOAMTemplateIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId RequestHeader RequestHeader --- ---
    req nOAMTemplateId nOAMTemplateId --- ---
    activate Boolean boolean --- ---

    OAMTemplateIdRespHolder

    Name

    Type

    Description

    Enum

    responseId ResponseHeader ResponseHeader --- ---
    rsp nOAMTemplateId nOAMTemplateId --- ---

    RequestHeader

    Name

    Type

    Description

    Enum

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

    ResponseHeader

    Name

    Type

    Description

    Enum

    req RequestHeader RequestHeader --- ---
    errorReason String string --- ---
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string --- ---
    opMsg String string --- ---
    msgCode String string --- ---
    parameters array[String] string --- ---
    paramCount Integer integer --- ---
    objectId Integer integer --- ---
    jobName String string --- ---
    objectType Integer integer --- ---

    ServiceTemplateResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    msgCode String string --- ---
    status String string --- ---
    parameters array[String] string --- ---
    paramCount Integer integer --- ---