Operation
get /data/otn/connection/node/neighborNodesgetNeighborNodes (getNeighborNodes : /data/otn/connection/node/neighborNodes)
getNeighborNodes
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| nprNodeId | required | --- |
| rate | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[HashMap«string,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/node/neighborNodesgetNeighborNodes (getNeighborNodes : /data/otn/node/neighborNodes)
getNeighborNodes
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| nprNodeId | required | --- |
| rate | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[HashMap«string,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/connection/node/{id}item (item : /data/otn/connection/node/{id})
item
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NodeInventoryResponse
|
| 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/node/{id}item (item : /data/otn/node/{id})
item
Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NodeInventoryResponse
|
| 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/connection/node/itemsitems (items : /data/otn/connection/node/items)
items
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[HashMap«string,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/node/itemsitems (items : /data/otn/node/items)
items
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
List[HashMap«string,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/connection/node/list (list : /data/otn/connection/node/)
list
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NodeInventoryResponse
|
| 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/node/list (list : /data/otn/node/)
list
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
NodeInventoryResponse
|
| 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 :
HashMap«string,string»
Name |
Type |
Description |
Enum |
|---|
NodeInventoryResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqCompletionStatus | Integer integer |
--- | --- |
| requestId | Long long |
--- | --- |
| clientName | String string |
--- | --- |
| clientLocation | String string |
--- | --- |
| clientUser | String string |
--- | --- |
| sessionId | String string |
--- | --- |
| mdcId | String string |
--- | --- |
| sequenceNum | Integer integer |
--- | --- |
| moreToCome | Boolean boolean |
--- | --- |
| messages | array[OtnI18nMessage] OtnI18nMessage |
--- | --- |
| errcde | String string |
--- | --- |
| errorParams | array[Object] object |
--- | --- |
| nextTasks | array[String] string |
--- | --- |
| items | array[HashMap«string,string»] HashMap«string,string» |
--- | --- |
| failedCompletion | Boolean boolean |
--- | --- |
| successfulCompletion | Boolean boolean |
--- | --- |
| timeout | Long long |
--- | --- |
| nadString | String string |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
|---|---|---|---|
| messageType | String string |
--- | [Info, Warning, Error] |
| messageUnformatted | String string |
--- | --- |
| validPropertyResourceMessage | Boolean boolean |
--- | --- |
| messageId | String string |
--- | --- |
| messageParams | array[String] string |
--- | --- |
| messageTime | Long long |
--- | --- |
| message | String string |
--- | --- |