Get the Routing Objects from Source Node
get
/nodes/{srcNodeId}/route
Returns the routing objects from source node.
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The routing objects have been successfully fetched from the source node.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object RouteResponse
Response schema to get a route's information.
Nested Schema : RouteResponse
Type:
object
Response schema to get a route's information.
Show Source
-
destinationNodeID(required): string
Identifier of the destination node.Example:
z8kfsx-16it-3res21sew
-
routingAttrs:
routingAttrs
-
routingField: string
Field defined in NPL used for routing.
-
routingFunction(required):
routingFunction
-
sourceNodeID(required): string
Identifier of the source node.Example:
z8kfsx-16it-l0mbm95p
Nested Schema : routingAttrs
Match All
Show Source
-
object
RoutingAttributes
Schema defining routing attributes for a route.
-
Attributes against which routing fields are compared using various operations.
Nested Schema : routingFunction
Match All
Show Source
-
string
Allowed Values:
[ "DIRECTED", "MODULUS", "MULTICAST", "ROUND_ROBIN" ]
-
Routing function used for the channel.Example:
DIRECTED
Nested Schema : RoutingAttributes
Type:
object
Schema defining routing attributes for a route.
Show Source
-
operand1(required): array
operand1
Values against which operator acts on the routing field.
-
operand2: array
operand2
Values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. e.g. - IN_BETWEEN operator
-
operator(required):
operator
Nested Schema : operand1
Type:
array
Values against which operator acts on the routing field.
Show Source
Nested Schema : operand2
Type:
array
Values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. e.g. - IN_BETWEEN operator
Show Source
Nested Schema : operator
Match All
Show Source
-
string
Allowed Values:
[ "EQUALS", "GREATER_THAN", "IN_BETWEEN", "LESS_THAN", "LIST_EQUALS", "LIST_NOT_EQUALS", "NOT_EQUALS", "NOT_SUBSET_OF", "SUBSET_OF" ]
-
Expression representing action to be performed on routing. fieldExample:
EQUALS
400 Response
The request cannot be processed due to a client error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
403 Response
The request was not authorized.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
404 Response
The requested resource cannot be found.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
405 Response
This method is not allowed.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
409 Response
The request cannot be processed due to a conflict in the existing state of the resource.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
Examples
The following example shows how to fetch the routing objects from source node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -X GET 'http://host:port /nodes/31eoef-otm-lna51qht/route'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
[
{
"destinationNodeID": "31eoef-otm-lna53s09",
"routingAttrs": {
"operand1": [
""
],
"operand2": [
""
]
},
"routingField": "",
"routingFunction": "MULTICAST",
"sourceNodeID": "31eoef-otm-lna51qht"
}