Operation
post /esmService/svcTemplate/createServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Template Data | nSvcTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Template Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ServiceTemplateHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <tempId> <templateName>test</templateName> <templatePath>My Templates/Service Templates/</templatePath> <templateId/> </tempId> <customer/> <author>test</author> <descr/> <serviceType>EVPL</serviceType> <templateState>UNPUBLISHED</templateState> <createTime/> <modifyTime/> <postProvCliCmd/> <preProvCliCmd/> <policyNameList> <nPolicyName> <policyName>Best Practices/QoS Templates/ACCESSINGRESSQOS_IP</policyName> <portMode>UNI</portMode> </nPolicyName> <nPolicyName> <policyName>Best Practices/QoS Templates/NETWORKPOLICY1</policyName> <portMode>I-NNI</portMode> </nPolicyName> </policyNameList> <templateType>0</templateType> <nMplstpSvcAttributes> <pwStatusSignalEnabled>Y</pwStatusSignalEnabled> <pwControlChannelEnabled>N</pwControlChannelEnabled> <pwAcknowledgementEnabled>N</pwAcknowledgementEnabled> <pwRefreshTimer>0</pwRefreshTimer> <pwRequestTimer>12</pwRequestTimer> <pwRetryTimer>11</pwRetryTimer> <pwTimeoutMultiplier>13</pwTimeoutMultiplier> <epRevertTimer>5</epRevertTimer> <epActiveHoldDelay>8</epActiveHoldDelay> <epStandbySignallingMaster>N</epStandbySignallingMaster> <mplstp_handle>0</mplstp_handle> </nMplstpSvcAttributes> <nRateLimitData> <egressRate>Default</egressRate> <egressMaxBurst>None</egressMaxBurst> <aggMeterRate>0</aggMeterRate> <aggMeterBurst>Default</aggMeterBurst> </nRateLimitData> <ingressEnabled>0</ingressEnabled> <egressEnabled>0</egressEnabled> <serviceParams> <llf>0</llf> <l2pt>0</l2pt> <lacp>0</lacp> <eplOp2TunnelEnabled>0</eplOp2TunnelEnabled> </serviceParams> </req> <oamTemplate> <Name>OAM_FOR_Service</Name> <Path>Best Practices/OAM Template</Path> <id>2</id> <maName>OAMSvc</maName> </oamTemplate> <repProf15m/> <repProf24h/> <tcaProfName/> <pmSelection>-1</pmSelection> </ServiceTemplateHolder>
Produces
application/xml
Example Response Data
<ServiceTemplateResponse> <message>Service Template Published successfully</message> <msgCode>TMPL_002</msgCode> <paramCount>1</paramCount> <parameters>REST-EVPL-LLF</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmService/svcTemplate/deleteServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Template Id Data | nSvcTemplateIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Service Template Id Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ServiceTemplateIdHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateName>REST-EVPLAN-L2PT</templateName> <templatePath>My Templates/Service Templates/</templatePath> </req> </ServiceTemplateIdHolder>
Produces
application/xml
Example Response Data
<SvcTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>SVC_TMPL_DEL_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/Service Templates/REST-EVPLAN-L2PT</parameters> </responseId> </SvcTemplateIdRespHolder>
External Docs
Operation
post /esmService/svcTemplate/modifyServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Template Data | nSvcTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Service Template Id Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ServiceTemplateHolder> <reqId> <reqId/> <respBeanRef/> <clientName/> </reqId> <req> <tempId> <templateName>test</templateName> <templatePath>My Templates/Service Templates/</templatePath> <templateId/> </tempId> <customer/> <author>testNew</author> <descr>test</descr> <serviceType>EVPL</serviceType> <templateState>UNPUBLISHED</templateState> <createTime/> <modifyTime/> <postProvCliCmd/> <preProvCliCmd/> <policyNameList> <nPolicyName> <policyName>Best Practices/QoS Templates/ACCESSINGRESSQOS_IP</policyName> <portMode>UNI</portMode> </nPolicyName> <nPolicyName> <policyName>Best Practices/QoS Templates/NETWORKPOLICY1</policyName> <portMode>I-NNI</portMode> </nPolicyName> </policyNameList> <templateType>0</templateType> <nMplstpSvcAttributes> <pwStatusSignalEnabled>Y</pwStatusSignalEnabled> <pwControlChannelEnabled>N</pwControlChannelEnabled> <pwAcknowledgementEnabled>N</pwAcknowledgementEnabled> <pwRefreshTimer>0</pwRefreshTimer> <pwRequestTimer>12</pwRequestTimer> <pwRetryTimer>11</pwRetryTimer> <pwTimeoutMultiplier>13</pwTimeoutMultiplier> <epRevertTimer>5</epRevertTimer> <epActiveHoldDelay>8</epActiveHoldDelay> <epStandbySignallingMaster>N</epStandbySignallingMaster> <mplstp_handle>0</mplstp_handle> </nMplstpSvcAttributes> <nRateLimitData> <egressRate>Default</egressRate> <egressMaxBurst>None</egressMaxBurst> <aggMeterRate>0</aggMeterRate> <aggMeterBurst>Default</aggMeterBurst> </nRateLimitData> <ingressEnabled>0</ingressEnabled> <egressEnabled>0</egressEnabled> <serviceParams> <llf>0</llf> <l2pt>0</l2pt> <lacp>0</lacp> <eplOp2TunnelEnabled>0</eplOp2TunnelEnabled> </serviceParams> </req> <oamTemplate> <Name>OAM_FOR_Service</Name> <Path>Best Practices/OAM Template</Path> <id>2</id> <maName>OAMSvc</maName> </oamTemplate> <repProf15m/> <repProf24h/> <tcaProfName/> <pmSelection>-1</pmSelection> </ServiceTemplateHolder>
Produces
application/xml
Example Response Data
<SvcTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>SVC_TMPL_MODIFY_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/Service Templates/REST-EPL-LLF</parameters> </responseId> </SvcTemplateIdRespHolder>
External Docs
Operation
post /esmService/svcTemplate/publishServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Template State Data | nSvcTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Service Template Id Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ServiceTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>test</templateName> <templatePath>My Templates/Service Templates/</templatePath> </templateId> </req> </ServiceTemplateStateHolder>
Produces
application/xml
Example Response Data
<SvcTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>SVC_TMPL_PUBLISH_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/Service Templates/test</parameters> </responseId> </SvcTemplateIdRespHolder>
External Docs
Operation
post /esmService/svcTemplate/saveServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Saving Service Template for service name | nSvcTemplateWithServiceInfoDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Service Template Id Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
/esmService/svcTemplate/saveServiceTemplate
Produces
application/json
Example Response Data
<ServiceTemplateResponse> <message>Service Template saved successfully</message> <msgCode>TMPL_001</msgCode> <paramCount>1</paramCount> <parameters>CMKSERV</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmService/svcTemplate/unpublishServiceTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Template State Data | nSvcTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Service Template Id Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ServiceTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>PUBLISHED</templateState> <templateId> <templateName>REST-EVPL-LLF</templateName> <templatePath>My Templates/Service Templates/</templatePath> </templateId> </req> </ServiceTemplateStateHolder>
Produces
application/xml
Example Response Data
<SvcTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>SVC_TMPL_UNPUB_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/Service Templates/REST-EVPL-LLF</parameters> </responseId> </SvcTemplateIdRespHolder>
External Docs
Access Egress Mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
policyType | String string |
policyType | [ ] |
additionalInfo | Object object |
--- | --- |
accessEgressData | Object object |
Access Egress Policy Details | --- |
queueData | array[Network Queue data mapper] Network Queue data mapper |
Policy Queue Details | --- |
accessEgressFCData | array[N_FCData] N_FCData |
Access Egress Policy FC Details | --- |
remarkingpolicyInstMapper | Policy Instance Mapper Policy Instance Mapper |
--- | --- |
remarkingpolicyInst | PolicyInst1 PolicyInst1 |
--- | --- |
Access Ingress Policy Mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
policyType | String string |
policyType | [ ] |
additionalInfo | Object object |
--- | --- |
changedParam | array[String] string |
--- | --- |
accessIngresData | Object object |
Access Ingress Data | --- |
accessIngressMatchCriterion | array[Traffic Match Data Mapper] Traffic Match Data Mapper |
Access Ingress Match Critertion | --- |
accessIngressMeter | array[Metering Data Mapper] Metering Data Mapper |
Access Ingress meter | --- |
accessCosMeter | array[COS meter Mapper] COS meter Mapper |
Access Ingress COS meter | --- |
EgressQueuePolicy
Name |
Type |
Description |
Enum |
---|---|---|---|
policyType | String string |
policyType | [ ] |
additionalInfo | Object object |
--- | --- |
queueData | array[SlopingQueueData] SlopingQueueData |
List |
--- |
N_NetworkEgressData
Name |
Type |
Description |
Enum |
---|---|---|---|
networkEgressData | Object object |
--- | --- |
remarkingpolicyInstMapper | Policy Instance Mapper Policy Instance Mapper |
--- | --- |
remarkingpolicyInst | PolicyInst1 PolicyInst1 |
--- | --- |
networkEgressFCData | array[N_FCData] N_FCData |
--- | --- |
N_NetworkIngressData
Name |
Type |
Description |
Enum |
---|---|---|---|
networkIngressData | Object object |
--- | --- |
changedParam | array[String] string |
--- | --- |
mplsLspExpPolicyInstMapper | Policy Instance Mapper Policy Instance Mapper |
--- | --- |
mplsLspExppolicyInst | PolicyInst1 PolicyInst1 |
--- | --- |
networkIngressFCData | array[N_FCData] N_FCData |
--- | --- |
networkIngressMeter | array[Metering Data Mapper] Metering Data Mapper |
--- | --- |
networkCosMeter | array[COS meter Mapper] COS meter Mapper |
--- | --- |
Network QOS data mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
policyType | String string |
policyType | [ ] |
additionalInfo | Object object |
--- | --- |
networkIngressParams | N_NetworkIngressData N_NetworkIngressData |
Network Ingress Params | --- |
networkEgressParams | N_NetworkEgressData N_NetworkEgressData |
Network Egress Params | --- |
changedParam | array[String] string |
--- | --- |
Network Queue data mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
policyType | String string |
policyType | [ ] |
additionalInfo | Object object |
--- | --- |
queueData | array[Network Queue data mapper] Network Queue data mapper |
Network Queue Data | --- |
nMplstpSvcAttributes
Name |
Type |
Description |
Enum |
---|---|---|---|
mplstp_handle | Long long |
--- | --- |
pwStatusSignalEnabled | String string |
Status Signal Enable/Disable | --- |
pwControlChannelEnabled | String string |
Control Channel Enable/Disable | --- |
pwAcknowledgementEnabled | String string |
PW Acknowledgement Enable/Disable | --- |
epStandbySignallingMaster | String string |
Stand By Signalling Master | --- |
epStandbySignallingSlave | String string |
--- | --- |
pwRefreshTimer | Long long |
Refresh Timer in Seconds | --- |
pwRequestTimer | Long long |
Request Timer in Seconds | --- |
pwRetryTimer | Long long |
Retry Timer in Seconds | --- |
pwTimeoutMultiplier | Long long |
Timeout Multiplier in Seconds | --- |
epRevertTimer | Long long |
Revert Timer in Seconds | --- |
epActiveHoldDelay | Long long |
Active Hold Delay in deciSeconds | --- |
nOAMTemplateId
Name |
Type |
Description |
Enum |
---|---|---|---|
id | String string |
Id | --- |
maName | String string |
MaName | --- |
demarcName | String string |
Name | --- |
demarcPath | String string |
OamTemplatePath | --- |
demarcId | String string |
Id | --- |
demarcMaName | String string |
DemarcationMaName | --- |
path | String string |
OamTemplatePath | --- |
name | String string |
Name | --- |
nSvcTemplateData
Name |
Type |
Description |
Enum |
---|---|---|---|
tempId | Service Template data Service Template data |
--- | --- |
customer | String string |
--- | --- |
author | String string |
--- | --- |
descr | String string |
--- | --- |
serviceType | String string |
--- | --- |
eTreeType | String string |
--- | --- |
policyNameList | array[nPolicyName] nPolicyName |
--- | --- |
reqQoS | Policy Instance Mapper Policy Instance Mapper |
Policy instance to be saved as part of service template Instance | --- |
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 | Request Header Request Header |
--- | --- |
req | nSvcTemplateData nSvcTemplateData |
--- | --- |
oamTemplate | nOAMTemplateId nOAMTemplateId |
--- | --- |
pmSelection | Integer integer |
--- | --- |
repProf15m | String string |
--- | --- |
repProf24h | String string |
--- | --- |
tcaProfName | String string |
--- | --- |
activate | Boolean boolean |
--- | --- |
nSvcTemplateIdHolder
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 | Service Template data Service Template data |
--- | --- |
activate | Boolean boolean |
--- | --- |
nSvcTemplateState
Name |
Type |
Description |
Enum |
---|---|---|---|
templateId | Service Template data Service Template data |
--- | --- |
templateState | String string |
--- | --- |
nSvcTemplateStateHolder
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 | nSvcTemplateState nSvcTemplateState |
--- | --- |
activate | Boolean boolean |
--- | --- |
nSvcTemplateWithServiceInfoDataHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
oamDescrption | String string |
--- | --- |
serviceName | String string |
Service name | --- |
templateName | String string |
template name | --- |
locationDetails | String string |
location details | --- |
nename | String string |
ne name | --- |
tpnativename | String string |
tpnative name | --- |
oamPublishedTemplateName | String string |
OAM Published Template Name | --- |
oamtemplateName | String string |
oam template name | --- |
oamlocationDetails | String string |
oam template details | --- |
oamConfigured | Boolean boolean |
oam config details | --- |
tempalteDesc | String string |
Template description | --- |
Policy Instance Mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
policyID | Long long |
policy ID | --- |
policyName | String string |
policy Name | --- |
policyPath | String string |
policy Path | --- |
policyDescription | String string |
policy Description | --- |
bestPractice | Boolean boolean |
Best Practice | --- |
policyType | String string |
policy Type | --- |
state | String string |
--- | --- |
author | String string |
--- | --- |
servicePolicyType | Integer integer |
Service policy Type | --- |
tpid | Integer integer |
--- | --- |
interfaceId | Integer integer |
--- | --- |
tpNativeName | String string |
Port Name | --- |
neName | String string |
NE Name | --- |
interfaceName | String string |
Interface Name | --- |
accessIngressPolicy | Access Ingress Policy Mapper Access Ingress Policy Mapper |
Access Ingress Policy Details | --- |
accessEgressPolicy | Access Egress Mapper Access Egress Mapper |
Access Egress Policy Details | --- |
networkQoSPolicy | Network QOS data mapper Network QOS data mapper |
Netwrk QOS Policy Details | --- |
networkQueuePolicy | Network Queue data mapper Network Queue data mapper |
Network Queue Policy Details | --- |
egressPortSchedulerPolicy | EgressPortSchedulerPolicy EgressPortSchedulerPolicy |
Port Scheduler Policy Details | --- |
egressQueueSlopingPolicy | EgressQueuePolicy EgressQueuePolicy |
Egress Queue Sloping Policy Details | --- |
remarkingPolicy | AbstractPolicy AbstractPolicy |
--- | --- |
mplsLspExpData | AbstractPolicy AbstractPolicy |
--- | --- |
additionalInfo | Object object |
--- | --- |
policyModified | Boolean boolean |
--- | --- |
policyChanged | Boolean boolean |
Is Policy Changed | --- |
PolicyInst1
Name |
Type |
Description |
Enum |
---|---|---|---|
policyID | Long long |
policyID | --- |
policyName | String string |
policyName | [ ] |
policyPath | String string |
policyPath | [ ] |
policyDescription | String string |
policyDescription | [ ] |
bestPractice | Boolean boolean |
--- | --- |
policyType | String string |
policyType | [ ] |
state | String string |
state | [ ] |
author | String string |
author | [ ] |
policyScope | Integer integer |
--- | --- |
servicePolicyType | Integer integer |
--- | --- |
policyRecordType | Integer integer |
--- | --- |
tpid | Integer integer |
--- | --- |
oldPolicyId | Integer integer |
--- | --- |
interfaceId | Integer integer |
--- | --- |
handle | Integer integer |
--- | --- |
policyList | array[AbstractPolicy ] AbstractPolicy |
List |
--- |
additionalInfo | Object object |
--- | --- |
changedParams | array[String] string |
List |
--- |
internalPolicy | Boolean boolean |
is Internal Policy | --- |
policyModified | Boolean boolean |
is current policy modified | --- |
cirPirAdminUnitReqd | Boolean boolean |
--- | --- |
policyChanged | Boolean boolean |
--- | --- |
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 | --- |
Service Template Id Response Data Holder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
Response wrapper for operation status | --- |
rsp | Service Template data Service Template data |
Service Template data | --- |
ServiceParams
Name |
Type |
Description |
Enum |
---|---|---|---|
llf | Integer integer |
LLF Enabled/Disabled | [0, 1] |
l2pt | Integer integer |
L2PT Enabled/Disabled | [0, 1] |
lacp | Integer integer |
LAPT Enabled/Disabled | [0, 1] |
l2cp | Integer integer |
L2CP Enabled/Disabled | [0, 1] |
eplOp2TunnelEnabled | Integer integer |
EPL Option 2 Tunnel Enabled/Disabled | [0, 1] |
fragmentType | Integer integer |
Fragment Type | [0, 1] |
vlanRangeEnabled | Integer integer |
VLAN Range Enabled/Disabled | [0, 1] |
cvlan | String string |
CVLAN Value | --- |