Operation
get /data/otn/port/{id}/currentPm/start
getPmTpsStart (getPmTpsStart : /data/otn/port/{id}/currentPm/start)
getPmTpsStart
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
frequency | optional | --- |
duration | optional | --- |
counters | optional | --- |
connectionid | optional | --- |
granularity | optional | --- |
location | optional | --- |
direction | optional | --- |
isSimulateData | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«RetrievePMSchedulerResponse»
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
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 /data/otn/port/{id}/currentPm/start
getPmTpsStartPost (getPmTpsStartPost : /data/otn/port/{id}/currentPm/start)
getPmTpsStartPost
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | portBasedConnectionId | array[PmCounterRequest] |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
frequency | optional | --- |
duration | optional | --- |
counters | optional | --- |
connectionid | optional | --- |
granularity | optional | --- |
location | optional | --- |
direction | optional | --- |
isSimulateData | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«RetrievePMSchedulerResponse»
|
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.
*/*
External Docs
See Also :
Operation
get /data/otn/port/{portId}/currentPm/stop
getPmTpsStop (getPmTpsStop : /data/otn/port/{portId}/currentPm/stop)
getPmTpsStop
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
portId | required | portId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
requestId | required | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«RetrievePMSchedulerResponse»
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
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 /data/otn/ports/{id}/loopback
loopbackAction (loopbackAction : /data/otn/ports/{id}/loopback)
loopbackAction
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
body2 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
portLoopbackType | required | --- |
loopbackCommandName | required | --- |
layerRateId | required | --- |
neId | required | --- |
tpDisplayLabel | required | --- |
neName | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnConnectionResponse»
|
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.
*/*
External Docs
See Also :
Operation
post /data/otn/ports/{id}/protectionSwitch
protectionSwitchingAction (protectionSwitchingAction : /data/otn/ports/{id}/protectionSwitch)
protectionSwitchingAction
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
body2 | optional | locale | Locale |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
pgCommandName | required | --- |
neId | required | --- |
neName | required | --- |
connectionId | required | --- |
switchReason | required | --- |
protectionGroupType | required | --- |
protectionGroupRef | required | --- |
protectionGroupId | required | --- |
protectionPortId | required | --- |
workingPortId | required | --- |
activePortId | required | --- |
activePortRef | required | --- |
westWorkingPortId | required | --- |
eastWorkingPortId | required | --- |
westWorkingPortNativeName | required | --- |
eastWorkingPortNativeName | required | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnConnectionResponse»
|
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.
*/*
External Docs
See Also :
OtnConnectionResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
message | String string |
--- | --- |
messageId | String string |
--- | --- |
messageSeverity | String string |
--- | --- |
status | String string |
--- | --- |
connectionName | String string |
--- | --- |
connectionId | Integer integer |
--- | --- |
orderNumber | String string |
--- | --- |
orderId | String string |
--- | --- |
orderStep | Integer integer |
--- | --- |
id | String string |
--- | --- |
errorField | String string |
--- | --- |
errorValue | String string |
--- | --- |