Operation
post /data/otn/designs/{designId}/routes/{routeId}
getDesignRouteDetailsAsString (getDesignRouteDetailsAsString : /data/otn/designs/{designId}/routes/{routeId})
getDesignRouteDetailsAsString
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
designId | required | designId | --- |
routeId | required | routeId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«string»
|
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/npt/projects
getNPTProjects (getNPTProjects : /data/otn/npt/projects)
getNPTProjects
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnNPTProjectResponse»
|
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
get /data/otn/npt/designs/{designId}/projects/{projectId}/routes/{routeId}
getRouteDetails (getRouteDetails : /data/otn/npt/designs/{designId}/projects/{projectId}/routes/{routeId})
getRouteDetails
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
designId | required | designId | --- |
projectId | required | projectId | --- |
routeId | required | routeId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnNPTRouteDetailResponse»
|
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
get /data/otn/designs/{designId}/projects/{projectId}/routes/{routeId}
getRouteDetailsAsString (getRouteDetailsAsString : /data/otn/designs/{designId}/projects/{projectId}/routes/{routeId})
getRouteDetailsAsString
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
designId | required | designId | --- |
projectId | required | projectId | --- |
routeId | required | routeId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«string»
|
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
get /data/otn/npt/designs/{designId}/projects/{projectId}/routes/oduk
getRouteIDForInfraConnection (getRouteIDForInfraConnection : /data/otn/npt/designs/{designId}/projects/{projectId}/routes/oduk)
getRouteIDForInfraConnection
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
designId | required | designId | --- |
projectId | required | projectId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
rate | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnNPTRouteIDResponse»
|
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
get /data/otn/npt/designs/{designId}/projects/{projectId}/routes/demand
getRouteIDForServiceConnection (getRouteIDForServiceConnection : /data/otn/npt/designs/{designId}/projects/{projectId}/routes/demand)
getRouteIDForServiceConnection
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
designId | required | designId | --- |
projectId | required | projectId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
rate | optional | --- |
containerrate | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«OtnNPTRouteIDResponse»
|
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 :
OtnNPTProject
Name |
Type |
Description |
Enum |
---|---|---|---|
designName | String string |
--- | --- |
designId | String string |
--- | --- |
projectName | String string |
--- | --- |
projectId | String string |
--- | --- |
projectModifiedDate | String string |
--- | --- |
projectModifiedBy | String string |
--- | --- |
projectStatus | String string |
--- | --- |
className | String string |
--- | --- |
id | String string |
--- | --- |
key | String string |
--- | --- |
guiLabel | String string |
--- | --- |
OtnNPTProjectResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
status | Integer integer |
--- | --- |
errorMessage | String string |
--- | --- |
nextTasks | array[String] string |
--- | --- |
items | array[OtnNPTProject] OtnNPTProject |
--- | --- |
OtnNPTRouteDetail
Name |
Type |
Description |
Enum |
---|---|---|---|
className | String string |
--- | --- |
id | String string |
--- | --- |
key | String string |
--- | --- |
guiLabel | String string |
--- | --- |
type | String string |
--- | --- |
rate | String string |
--- | --- |
fromNE | String string |
--- | --- |
fromPort | String string |
--- | --- |
toNE | String string |
--- | --- |
toPort | String string |
--- | --- |
fromNE2 | String string |
--- | --- |
fromPort2 | String string |
--- | --- |
toNE2 | String string |
--- | --- |
toPort2 | String string |
--- | --- |
serverLinkName | String string |
--- | --- |
frequency | String string |
--- | --- |
provisioned | String string |
--- | --- |
designId | String string |
--- | --- |
projectId | String string |
--- | --- |
routeId | String string |
--- | --- |
protectionType | String string |
--- | --- |
serverId | String string |
--- | --- |
OtnNPTRouteDetailResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
status | Integer integer |
--- | --- |
errorMessage | String string |
--- | --- |
nextTasks | array[String] string |
--- | --- |
items | array[OtnNPTRouteDetail] OtnNPTRouteDetail |
--- | --- |
OtnNPTRouteID
Name |
Type |
Description |
Enum |
---|---|---|---|
className | String string |
--- | --- |
id | String string |
--- | --- |
key | String string |
--- | --- |
guiLabel | String string |
--- | --- |
routeId | String string |
--- | --- |
fromPort | String string |
--- | --- |
toPort | String string |
--- | --- |
availableFromPort | String string |
--- | --- |
availableToPort | String string |
--- | --- |
fromPort2 | String string |
--- | --- |
toPort2 | String string |
--- | --- |
fromNE | String string |
--- | --- |
toNE | String string |
--- | --- |
fromNE2 | String string |
--- | --- |
toNE2 | String string |
--- | --- |
oduName | String string |
--- | --- |
comment | String string |
--- | --- |
designID | String string |
--- | --- |
projectID | String string |
--- | --- |
OtnNPTRouteIDResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
status | Integer integer |
--- | --- |
errorMessage | String string |
--- | --- |
nextTasks | array[String] string |
--- | --- |
items | array[OtnNPTRouteID] OtnNPTRouteID |
--- | --- |