Operation

post /esmService/svcTemplate/createServiceTemplate
createServiceTemplate (createServiceTemplate : /esmService/svcTemplate/createServiceTemplate)
createServiceTemplate

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData nSvcTemplateDataHolder ---

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 /esmService/svcTemplate/deleteServiceTemplate
    deleteServiceTemplate (deleteServiceTemplate : /esmService/svcTemplate/deleteServiceTemplate)
    deleteServiceTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nSvcTemplateIdHolder ---

    Return type
  • SvcTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success SvcTemplateIdRespHolder
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /esmService/svcTemplate/modifyServiceTemplate
    modifyServiceTemplate (modifyServiceTemplate : /esmService/svcTemplate/modifyServiceTemplate)
    modifyServiceTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nSvcTemplateDataHolder ---

    Return type
  • SvcTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success SvcTemplateIdRespHolder
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /esmService/svcTemplate/publishServiceTemplate
    publishServiceTemplate (publishServiceTemplate : /esmService/svcTemplate/publishServiceTemplate)
    publishServiceTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nSvcTemplateStateHolder ---

    Return type
  • SvcTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success SvcTemplateIdRespHolder
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /esmService/svcTemplate/saveServiceTemplate
    saveServiceTemplate (saveServiceTemplate : /esmService/svcTemplate/saveServiceTemplate)
    saveServiceTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req nSvcTemplateWithServiceInfoDataHolder ---

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

    post /esmService/svcTemplate/unpublishServiceTemplate
    unpublishServiceTemplate (unpublishServiceTemplate : /esmService/svcTemplate/unpublishServiceTemplate)
    unpublishServiceTemplate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData nSvcTemplateStateHolder ---

    Return type
  • SvcTemplateIdRespHolder
  • Responses

    Response Messages

    Schema

    200success SvcTemplateIdRespHolder
    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.
    • */*

    External Docs
    See Also :

    N_AbstractPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---

    N_AccessEgressPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    accessEgressData Object object --- ---
    queueData array[N_QueueData] N_QueueData --- ---
    accessEgressFCData array[N_FCData] N_FCData --- ---
    remarkingpolicyInstMapper N_PolicyInstPostMapper N_PolicyInstPostMapper --- ---
    remarkingpolicyInst N_PolicyInst N_PolicyInst --- ---

    N_AccessIngressPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    changedParam array[String] string --- ---
    accessIngresData Object object --- ---
    accessIngressMatchCriterion array[N_TrafficMatchData] N_TrafficMatchData --- ---
    accessIngressMeter array[N_MeteringData] N_MeteringData --- ---
    accessCosMeter array[N_CosMeterData] N_CosMeterData --- ---

    N_CosMeterData

    Name

    Type

    Description

    Enum

    cosId Long long --- ---
    cosParams Object object --- ---
    changedParam array[String] string --- ---

    N_EgressPortSchedulerPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    portSchedulerData Object object --- ---
    changedParam array[String] string --- ---

    N_EgressQueuePolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    queueData array[N_SlopingQueueData] N_SlopingQueueData --- ---

    N_FCData

    Name

    Type

    Description

    Enum

    profileId Long long --- ---
    profileData Object object --- ---
    changedParam array[String] string --- ---

    N_MeteringData

    Name

    Type

    Description

    Enum

    meterId Long long --- ---
    changedParam array[String] string --- ---
    changedParameters array[String] string --- ---
    meteringParams Object object --- ---

    N_MplsLspExpData

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---

    N_NetworkEgressData

    Name

    Type

    Description

    Enum

    networkEgressData Object object --- ---
    remarkingpolicyInstMapper N_PolicyInstPostMapper N_PolicyInstPostMapper --- ---
    remarkingpolicyInst N_PolicyInst N_PolicyInst --- ---
    networkEgressFCData array[N_FCData] N_FCData --- ---

    N_NetworkIngressData

    Name

    Type

    Description

    Enum

    networkIngressData Object object --- ---
    changedParam array[String] string --- ---
    mplsLspExpPolicyInstMapper N_PolicyInstPostMapper N_PolicyInstPostMapper --- ---
    mplsLspExppolicyInst N_PolicyInst N_PolicyInst --- ---
    networkIngressFCData array[N_FCData] N_FCData --- ---
    networkIngressMeter array[N_MeteringData] N_MeteringData --- ---
    networkCosMeter array[N_CosMeterData] N_CosMeterData --- ---

    N_NetworkQoSPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    networkIngressParams N_NetworkIngressData N_NetworkIngressData --- ---
    networkEgressParams N_NetworkEgressData N_NetworkEgressData --- ---
    changedParam array[String] string --- ---

    N_NetworkQueuePolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    queueData array[N_QueueData] N_QueueData --- ---

    N_PolicyInst

    Name

    Type

    Description

    Enum

    policyID Long long --- ---
    policyName String string --- ---
    policyPath String string --- ---
    policyDescription String string --- ---
    bestPractice Boolean boolean --- ---
    policyType String string --- ---
    state String string --- ---
    author String string --- ---
    policyScope Integer integer --- ---
    servicePolicyType Integer integer --- ---
    policyRecordType Integer integer --- ---
    tpid Integer integer --- ---
    oldPolicyId Integer integer --- ---
    interfaceId Integer integer --- ---
    handle Integer integer --- ---
    policyList array[N_AbstractPolicy] N_AbstractPolicy --- ---
    additionalInfo Object object --- ---
    changedParams array[String] string --- ---
    internalPolicy Boolean boolean --- ---
    policyModified Boolean boolean --- ---
    cirPirAdminUnitReqd Boolean boolean --- ---
    policyChanged Boolean boolean --- ---

    N_PolicyInstPostMapper

    Name

    Type

    Description

    Enum

    policyID Long long --- ---
    policyName String string --- ---
    policyPath String string --- ---
    policyDescription String string --- ---
    bestPractice Boolean boolean --- ---
    policyType String string --- ---
    state String string --- ---
    author String string --- ---
    servicePolicyType Integer integer --- ---
    tpid Integer integer --- ---
    interfaceId Integer integer --- ---
    tpNativeName String string --- ---
    neName String string --- ---
    interfaceName String string --- ---
    accessIngressPolicy N_AccessIngressPolicy N_AccessIngressPolicy --- ---
    accessEgressPolicy N_AccessEgressPolicy N_AccessEgressPolicy --- ---
    networkQoSPolicy N_NetworkQoSPolicy N_NetworkQoSPolicy --- ---
    networkQueuePolicy N_NetworkQueuePolicy N_NetworkQueuePolicy --- ---
    egressPortSchedulerPolicy N_EgressPortSchedulerPolicy N_EgressPortSchedulerPolicy --- ---
    egressQueueSlopingPolicy N_EgressQueuePolicy N_EgressQueuePolicy --- ---
    remarkingPolicy N_RemarkingPolicy N_RemarkingPolicy --- ---
    mplsLspExpData N_MplsLspExpData N_MplsLspExpData --- ---
    additionalInfo Object object --- ---
    policyModified Boolean boolean --- ---
    policyChanged Boolean boolean --- ---

    N_QueueData

    Name

    Type

    Description

    Enum

    queueId Long long --- ---
    egressqueue Object object --- ---
    changedParam array[String] string --- ---

    N_RemarkingPolicy

    Name

    Type

    Description

    Enum

    policyType String string --- ---
    additionalInfo Object object --- ---
    remarkingData Object object --- ---
    remarkingFCData array[N_FCData] N_FCData --- ---

    N_SlopingQueueData

    Name

    Type

    Description

    Enum

    queueId Long long --- ---
    slopeType String string --- ---
    egressQueueSloping Object object --- ---
    changedParam array[String] string --- ---

    N_TrafficMatchData

    Name

    Type

    Description

    Enum

    trafficMatchID Long long --- ---
    trafficMatchParams Object object --- ---
    changedParam array[String] string --- ---

    nMplstpSvcAttributes

    Name

    Type

    Description

    Enum

    mplstp_handle Long long --- ---
    pwStatusSignalEnabled String string --- ---
    pwControlChannelEnabled String string --- ---
    pwAcknowledgementEnabled String string --- ---
    epStandbySignallingMaster String string --- ---
    epStandbySignallingSlave String string --- ---
    pwRefreshTimer Long long --- ---
    pwRequestTimer Long long --- ---
    pwRetryTimer Long long --- ---
    pwTimeoutMultiplier Long long --- ---
    epRevertTimer Long long --- ---
    epActiveHoldDelay Long long --- ---

    nOAMTemplateId

    Name

    Type

    Description

    Enum

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

    nPolicyName

    Name

    Type

    Description

    Enum

    policyName String string --- ---
    portMode String string --- ---

    nRateLimitData

    Name

    Type

    Description

    Enum

    egressRate String string --- ---
    egressMaxBurst String string --- ---
    aggMeterRate String string --- ---
    aggMeterBurst String string --- ---
    egressRateOper String string --- ---

    nSvcTemplateData

    Name

    Type

    Description

    Enum

    tempId nSvcTemplateId nSvcTemplateId --- ---
    customer String string --- ---
    author String string --- ---
    descr String string --- ---
    serviceType String string --- ---
    eTreeType String string --- ---
    policyNameList array[nPolicyName] nPolicyName --- ---
    reqQoS N_PolicyInstPostMapper N_PolicyInstPostMapper --- ---
    rateData nRateLimitData nRateLimitData --- ---
    templateState String string --- ---
    createTime String string --- ---
    modifyTime String string --- ---
    ingressEnabled Integer integer --- ---
    egressEnabled Integer integer --- ---
    additionalInfo Object object --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    serviceParams ServiceParams ServiceParams --- ---
    templateType Integer integer --- ---
    mplstpAttributes nMplstpSvcAttributes nMplstpSvcAttributes --- ---
    qosList array[nPolicyName] nPolicyName --- ---

    nSvcTemplateDataHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId RequestHeader RequestHeader --- ---
    req nSvcTemplateData nSvcTemplateData --- ---
    oamTemplate nOAMTemplateId nOAMTemplateId --- ---
    pmSelection Integer integer --- ---
    repProf15m String string --- ---
    repProf24h String string --- ---
    tcaProfName String string --- ---
    activate Boolean boolean --- ---

    nSvcTemplateId

    Name

    Type

    Description

    Enum

    templateId String string --- ---
    templateName String string --- ---
    templatePath String string --- ---

    nSvcTemplateIdHolder

    Name

    Type

    Description

    Enum

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

    nSvcTemplateState

    Name

    Type

    Description

    Enum

    templateId nSvcTemplateId nSvcTemplateId --- ---
    templateState String string --- ---

    nSvcTemplateStateHolder

    Name

    Type

    Description

    Enum

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

    nSvcTemplateWithServiceInfoDataHolder

    Name

    Type

    Description

    Enum

    oamDescrption String string --- ---
    serviceName String string --- ---
    templateName String string --- ---
    locationDetails String string --- ---
    nename String string --- ---
    tpnativename String string --- ---
    oamPublishedTemplateName String string --- ---
    oamtemplateName String string --- ---
    oamlocationDetails String string --- ---
    oamConfigured Boolean boolean --- ---
    tempalteDesc String string --- ---

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

    ServiceParams

    Name

    Type

    Description

    Enum

    llf Integer integer --- ---
    l2pt Integer integer --- ---
    lacp Integer integer --- ---
    l2cp Integer integer --- ---
    eplOp2TunnelEnabled Integer integer --- ---
    fragmentType Integer integer --- ---
    vlanRangeEnabled Integer integer --- ---
    cvlan String string --- ---

    ServiceTemplateResponse

    Name

    Type

    Description

    Enum

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

    SvcTemplateIdRespHolder

    Name

    Type

    Description

    Enum

    responseId ResponseHeader ResponseHeader --- ---
    rsp nSvcTemplateId nSvcTemplateId --- ---