Operation
post /esmService/SAT/cleanupFailedSAT/cleanupFailedSAT (cleanupFailedSAT : /esmService/SAT/cleanupFailedSAT/)
cleanupFailedSAT
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | E_SATIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_ServiceIdRespHolder
|
| 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/SAT/deleteSAT/deleteSAT (deleteSAT : /esmService/SAT/deleteSAT/)
deleteSAT
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | SATEProfileIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_ServiceIdRespHolder
|
| 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/SAT/deploySAT/deploySAT (deploySAT : /esmService/SAT/deploySAT/)
deploySAT
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | SATTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_ServiceIdRespHolder
|
| 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/SAT/stopSAT/stopSAT (stopSAT : /esmService/SAT/stopSAT/)
stopSAT
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | E_SATIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_ServiceIdRespHolder
|
| 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 :
AcceptanceCriteria
Name |
Type |
Description |
Enum |
|---|---|---|---|
| cirThreshold | Long long |
--- | --- |
| cirThresholdUnits | String string |
--- | --- |
| pirThreshold | Long long |
--- | --- |
| pirThresholdUnits | String string |
--- | --- |
| latencyRisingThreshold | String string |
--- | --- |
| latencyRisingThresholdIn | String string |
--- | --- |
| latencyRisingThresholdOut | String string |
--- | --- |
| jitterRisingThreshold | String string |
--- | --- |
| jitterRisingThresholdIn | String string |
--- | --- |
| jiterRisingThresholdOut | String string |
--- | --- |
| lossRisingThreshold | String string |
--- | --- |
| lossRisingThresholdIn | String string |
--- | --- |
| lossRisingThresholdOut | String string |
--- | --- |
| satACID | Long long |
--- | --- |
| satAsscdProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
E_SATIdHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| vsId | Long long |
--- | --- |
| testName | String string |
--- | --- |
| runId | Long long |
--- | --- |
| nmlServiceHandle | Long long |
--- | --- |
| profileId | Long long |
--- | --- |
| nSatHandle | Long long |
--- | --- |
| serviceName | String string |
--- | --- |
| schedServiceData | SchedServiceData SchedServiceData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_ServiceId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| managementState | String string |
--- | --- |
| toManagementState | String string |
--- | --- |
| serviceName | String string |
--- | --- |
| serviceDescr | String string |
--- | --- |
| serviceType | String string |
--- | --- |
| serviceState | String string |
--- | --- |
| serviceId | Long long |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| pmState | Integer integer |
--- | --- |
| shgData | N_SHGData N_SHGData |
--- | --- |
| eTreeType | Integer integer |
--- | --- |
| svcParams | ServiceParams ServiceParams |
--- | --- |
| networkTechnology | Integer integer |
--- | --- |
| switchOperationName | String string |
--- | --- |
| targetPseudowire | String string |
--- | --- |
N_ServiceIdRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
| rsp | N_ServiceId N_ServiceId |
--- | --- |
PayLoad
Name |
Type |
Description |
Enum |
|---|---|---|---|
| payloadType | String string |
--- | --- |
| dataPattern | String string |
--- | --- |
| etherType | String string |
--- | --- |
| satPayloadId | Long long |
--- | --- |
| satAsscdProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
PortSelection
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nearEndAccessPoint | String string |
--- | --- |
| testHead | String string |
--- | --- |
| nearEndLoopback | String string |
--- | --- |
| nearEndSrcMacAddress | String string |
--- | --- |
| nearEndDestAddress | String string |
--- | --- |
| farEndAccessPoint | String string |
--- | --- |
| farEndLoopback | String string |
--- | --- |
| farEndSrcMacAddress | String string |
--- | --- |
| farEndDestMacAddress | 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 |
--- | --- |
SATEProfileIdHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| profileId | Long long |
--- | --- |
| serviceName | String string |
--- | --- |
| nmlServiceId | Long long |
--- | --- |
| vsId | Long long |
--- | --- |
| nSatHandle | Long long |
--- | --- |
| schedServiceData | SchedServiceData SchedServiceData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
SATTemplateDataHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| id | Long long |
--- | --- |
| templateId | Long long |
--- | --- |
| templateName | String string |
--- | --- |
| author | String string |
--- | --- |
| desc | String string |
--- | --- |
| templateState | String string |
--- | --- |
| templatePath | String string |
--- | --- |
| createTime | Long long |
--- | --- |
| modifyTime | Long long |
--- | --- |
| colourAware | Integer integer |
--- | --- |
| forwardingClass | String string |
--- | --- |
| serviceName | String string |
--- | --- |
| testPorfile | TestProfile TestProfile |
--- | --- |
| payLoad | PayLoad PayLoad |
--- | --- |
| acceptanceCriteria | AcceptanceCriteria AcceptanceCriteria |
--- | --- |
| portSelection | PortSelection PortSelection |
--- | --- |
| schedServiceData | SchedServiceData SchedServiceData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
SchedServiceData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| jobName | String string |
--- | --- |
| jobDesc | String string |
--- | --- |
| userName | String string |
--- | --- |
| trigger | SchedTriggerData SchedTriggerData |
--- | --- |
TestProfile
Name |
Type |
Description |
Enum |
|---|---|---|---|
| dot1pInprofile | Integer integer |
--- | --- |
| dot1pOutprofile | Integer integer |
--- | --- |
| cirRate | Long long |
--- | --- |
| cirRateUnits | String string |
--- | --- |
| pirRate | Long long |
--- | --- |
| pirRatUnits | String string |
--- | --- |
| adaptationRule | String string |
--- | --- |
| frameSize | Integer integer |
--- | --- |
| hours | String string |
--- | --- |
| minites | String string |
--- | --- |
| seconds | String string |
--- | --- |
| satProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| timeDurationStr | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| satProfileIdUI | Long long |
--- | --- |