Operation
post /data/gpc/network/computePathask GPC to compute a path (computePath : /data/gpc/network/computePath)
computePath
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | connectionRequestResponse | ConnectionL0Impl |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ConnectionL0
|
| 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 /data/gpc/network/deletePathask GPC to delete a path (deletePath : /data/gpc/network/deletePath)
deletePath
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | connection | GpcConnectionInfo |
--- |
Responses
Response Messages |
Schema |
|---|---|
| 200 | --- |
| 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
get /data/gpc/network/getServiceImpairmentData/{serviceId}ask for Service Impairment data for a given serviceId (getServiceImpairmentData : /data/gpc/network/getServiceImpairmentData/{serviceId})
getServiceImpairmentData
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| serviceId | required | serviceId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
AsonResponse
|
| 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.
application/json
External Docs
See Also :
Operation
post /data/gpc/network/getSnapshotask for a snapshot of gpc config data (getSnapshot : /data/gpc/network/getSnapshot)
getSnapshot
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | connectionRequestResponse | ConnectionL0Impl |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
AsonResponse
|
| 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 /data/gpc/network/synch/{scope}execute Network Synchronization request for GPC data within the scope: full|connectivity|impairment (synchronize : /data/gpc/network/synch/{scope})
synchronize
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| scope | required | 'scope' the scope of the data to synchronize | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
AsonResponse
|
| 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 /data/gpc/network/triggerNetworkRestorationask GPC to perform network restoration (triggerRestoration : /data/gpc/network/triggerNetworkRestoration)
triggerRestoration
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | connectionRequestResponse | GpcRestorationRequest |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
GpcRestorationResponse
|
| 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 :
AsonResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| requestType | String string |
Type of Request | [Info, Warning, Error] |
| messagetag | String string |
Message Tag | --- |
| errorMsgData | array[String] string |
Error messages Data | --- |
| requestStatus | String string |
Status of the request | [Executing, Success, Failed, SuccessWithWarnings, PartiallyFailed, Removed, FailedForTimeout] |
ConnectionL0
Name |
Type |
Description |
Enum |
|---|---|---|---|
| lambdaSpacingConstraint | Integer integer |
--- | --- |
| createdWithL1 | Boolean boolean |
--- | --- |
| setupPriority | Integer integer |
--- | --- |
| serviceId | String string |
--- | --- |
| boundMetrics | array[String] string |
--- | --- |
| holdingPriority | Integer integer |
--- | --- |
| constraints | array[Constraint] Constraint |
--- | --- |
| errorMessage | String string |
--- | --- |
| layerRate | String string |
--- | [OTU, OTU2, OTU4, ODU4, ODU4x2, ODU2, ODU2e, DSR, UNKNOWN] |
| connectionId | String string |
--- | --- |
| groupOrderId | String string |
--- | --- |
| connectionStatus | String string |
--- | [path computed failed, path computed, unknown] |
| fromNodeNo1 | Integer integer |
--- | --- |
| fromPortNo1 | Integer integer |
--- | --- |
| toNodeNo1 | Integer integer |
--- | --- |
| toPortNo1 | Integer integer |
--- | --- |
| protectionRestorationType | String string |
--- | [UNPROTECTED, SBR, GR, O_SNCP, O_PRC, UNKNOWN] |
| connectionSetupType | String string |
--- | [SOFT_PERMANENT, PERMANENT, SWITCHED, UNKNOWN] |
| fromNodeNo2 | Integer integer |
--- | --- |
| fromPortNo2 | Integer integer |
--- | --- |
| toNodeNo2 | Integer integer |
--- | --- |
| toPortNo2 | Integer integer |
--- | --- |
| displayName | String string |
--- | --- |
| paths | array[PathBase] PathBase |
--- | --- |
ConnectionL0Impl
Name |
Type |
Description |
Enum |
|---|---|---|---|
| connectionId | String string |
--- | --- |
| displayName | String string |
--- | --- |
| connectionStatus | String string |
--- | [path computed failed, path computed, unknown] |
| protectionRestorationType | String string |
--- | [UNPROTECTED, SBR, GR, O_SNCP, O_PRC, UNKNOWN] |
| connectionSetupType | String string |
--- | [SOFT_PERMANENT, PERMANENT, SWITCHED, UNKNOWN] |
| layerRate | String string |
--- | [OTU, OTU2, OTU4, ODU4, ODU4x2, ODU2, ODU2e, DSR, UNKNOWN] |
| fromNodeNo1 | Integer integer |
--- | --- |
| fromPortNo1 | Integer integer |
--- | --- |
| fromNodeNo2 | Integer integer |
--- | --- |
| fromPortNo2 | Integer integer |
--- | --- |
| toNodeNo1 | Integer integer |
--- | --- |
| toPortNo1 | Integer integer |
--- | --- |
| toNodeNo2 | Integer integer |
--- | --- |
| toPortNo2 | Integer integer |
--- | --- |
| paths | array[PathBase] PathBase |
--- | --- |
| groupOrderId | String string |
--- | --- |
| errorMessage | String string |
--- | --- |
| serviceId | String string |
--- | --- |
| holdingPriority | Integer integer |
--- | --- |
| setupPriority | Integer integer |
--- | --- |
| boundMetrics | array[String] string |
--- | --- |
| lambdaSpacingConstraint | Integer integer |
--- | --- |
| createdWithL1 | Boolean boolean |
--- | --- |
| constraints | array[Constraint] Constraint |
--- | --- |
Constraint
Name |
Type |
Description |
Enum |
|---|---|---|---|
| constraintType | String string |
--- | [INCLUDE, EXCLUDE, UNKNOWN] |
| nodeId | Integer integer |
--- | --- |
| pathType | String string |
--- | [MAIN_NOMINAL, SPARE_NOMINAL, MAIN_BACKUP_ACTIVE, SPARE_BACKUP_ACTIVE, MAIN_BACKUP_INACTIVE, MAIN_CURRENT, SPARE_CURRENT, UNKNOWN] |
| routeSegments | array[RouteSegmentL0] RouteSegmentL0 |
--- | --- |
| constraintObjectType | String string |
--- | [NODE, DATA_LINK_TP, THREER_OT_PAIR, WDM_PATH, UNKNOWN] |
| dataLinkTp | DataLinkTp DataLinkTp |
--- | --- |
| threeRPortPair | ThreeRPortPair ThreeRPortPair |
--- | --- |
GpcConnectionInfo
Name |
Type |
Description |
Enum |
|---|---|---|---|
| connectionId | Long long |
--- | --- |
| uniqueReqId | String string |
--- | --- |
| connectionName | String string |
--- | --- |
| restorationMode | Integer integer |
--- | --- |
| workingSegments | array[OchSegment] OchSegment |
--- | --- |
| protectionSegments | array[OchSegment] OchSegment |
--- | --- |
GpcRestorationRequest
Name |
Type |
Description |
Enum |
|---|---|---|---|
| failureList | array[FailedEntity] FailedEntity |
--- | --- |
| failureScope | String string |
--- | [FULLNETWORK, WHATIF] |
| failureAppearance | String string |
--- | [SIMULTANEOUS, SEQUENTIAL] |
| restorationOrder | String string |
--- | [RANDOM, DETERMINISTIC] |
GpcRestorationResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| restoredConnectionInfo | array[GpcRestoredConnectionInfo] GpcRestoredConnectionInfo |
--- | --- |
GpcRestoredConnectionInfo
Name |
Type |
Description |
Enum |
|---|---|---|---|
| connectionId | Long long |
--- | --- |
| uniqueReqId | String string |
--- | --- |
| connectionName | String string |
--- | --- |
| restorationMode | Integer integer |
--- | --- |
| workingSegments | array[OchSegment] OchSegment |
--- | --- |
| protectionSegments | array[OchSegment] OchSegment |
--- | --- |
| restoredPaths | array[RestoredOchSegment] RestoredOchSegment |
--- | --- |
OchSegment
Name |
Type |
Description |
Enum |
|---|---|---|---|
| ochId | Long long |
--- | --- |
| ochUserLabel | String string |
--- | --- |
| aneid | Long long |
--- | --- |
| aochIfindex | String string |
--- | --- |
| aochPortLabel | String string |
--- | --- |
| zneid | Long long |
--- | --- |
| zochIfindex | String string |
--- | --- |
| zochPortLabel | String string |
--- | --- |
| channel | String string |
--- | --- |
| channelSpacing | Integer integer |
--- | --- |
| fecType | String string |
--- | --- |
| channelUnit | Integer integer |
--- | --- |
| teLinks | array[TeLink] TeLink |
--- | --- |
PathBase
Name |
Type |
Description |
Enum |
|---|---|---|---|
| pathType | String string |
--- | [MAIN_NOMINAL, SPARE_NOMINAL, MAIN_BACKUP_ACTIVE, SPARE_BACKUP_ACTIVE, MAIN_BACKUP_INACTIVE, MAIN_CURRENT, SPARE_CURRENT, UNKNOWN] |
| routeSegments | array[RouteSegmentBase] RouteSegmentBase |
--- | --- |
| pathId | String string |
--- | --- |
RestoredOchSegment
Name |
Type |
Description |
Enum |
|---|---|---|---|
| ochId | Long long |
--- | --- |
| ochUserLabel | String string |
--- | --- |
| aneid | Long long |
--- | --- |
| aochIfindex | String string |
--- | --- |
| aochPortLabel | String string |
--- | --- |
| zneid | Long long |
--- | --- |
| zochIfindex | String string |
--- | --- |
| zochPortLabel | String string |
--- | --- |
| channel | String string |
--- | --- |
| channelSpacing | Integer integer |
--- | --- |
| fecType | String string |
--- | --- |
| channelUnit | Integer integer |
--- | --- |
| teLinks | array[TeLink] TeLink |
--- | --- |
RouteElementBase
Name |
Type |
Description |
Enum |
|---|---|---|---|
| egressTPLabel | String string |
--- | --- |
| ingressTPLabel | String string |
--- | --- |
| routeElementId | Integer integer |
--- | --- |
| ingressNe | Integer integer |
--- | --- |
| egressNe | Integer integer |
--- | --- |
| ingressTerminationPoint | Integer integer |
--- | --- |
| egressTerminationPoint | Integer integer |
--- | --- |
RouteSegmentBase
Name |
Type |
Description |
Enum |
|---|---|---|---|
| routeSegmentId | Integer integer |
--- | --- |
| routeElements | array[RouteElementBase] RouteElementBase |
--- | --- |
RouteSegmentL0
Name |
Type |
Description |
Enum |
|---|---|---|---|
| channelSpacing | String string |
--- | --- |
| channelNumber | Integer integer |
--- | --- |
| routeSegmentId | Integer integer |
--- | --- |
| routeElements | array[RouteElementBase] RouteElementBase |
--- | --- |
Void
Name |
Type |
Description |
Enum |
|---|