Jump to

• Request
• Response
• Examples

Create a Route

post

/nodes/{srcNodeId}/route

Creates a route.

Request

Path Parameters

• srcNodeId(required): string

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

Payload schema to create a route between two nodes

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

{
    "required":[
        "destinationNodeID",
        "routingFunction"
    ],
    "properties":{
        "destinationNodeID":{
            "description":"Identifier of the destination node",
            "example":"z8kfsx-16it-3res21sew",
            "nullable":false,
            "type":"string"
        },
        "routingAttrs":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs"
                },
                {
                    "description":"Attributes against which routing fields are compared using various operations"
                }
            ]
        },
        "routingField":{
            "description":"Field defined in NPL used for routing",
            "type":"string"
        },
        "routingFunction":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/RoutingFunctionEnum"
                },
                {
                    "description":"Routing function used for the channel",
                    "example":"DIRECTED",
                    "nullable":false
                }
            ]
        }
    },
    "description":"Payload schema to create a route between two nodes",
    "type":"object"
}

Nested Schema : routingAttrs

Match All

Show Source

• object RouteUpdateRequestRoutingAttrs
  Schema defining routing attributes for a route update request
• Attributes against which routing fields are compared using various operations

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs"
        },
        {
            "description":"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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RoutingFunctionEnum"
        },
        {
            "description":"Routing function used for the channel",
            "example":"DIRECTED",
            "nullable":false
        }
    ]
}

Nested Schema : RouteUpdateRequestRoutingAttrs

Type: object

Schema defining routing attributes for a route update request

Show Source

• operand1: 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: operator

{
    "properties":{
        "operand1":{
            "description":"Values against which operator acts on the routing field",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "operand2":{
            "description":"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",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "operator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/OperatorEnum"
                },
                {
                    "description":"Expression representing action to be performed on routing field",
                    "example":"EQUALS"
                }
            ]
        }
    },
    "description":"Schema defining routing attributes for a route update request",
    "type":"object"
}

Nested Schema : operand1

Type: array

Values against which operator acts on the routing field

Show Source

• Array of: string

{
    "description":"Values against which operator acts on the routing field",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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

• Array of: string

{
    "description":"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",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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 field

  Example: EQUALS

{
    "allOf":[
        {
            "$ref":"#/components/schemas/OperatorEnum"
        },
        {
            "description":"Expression representing action to be performed on routing field",
            "example":"EQUALS"
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The requested route has been created.

Body ()

Root 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

{
    "required":[
        "destinationNodeID",
        "routingFunction",
        "sourceNodeID"
    ],
    "properties":{
        "destinationNodeID":{
            "description":"Identifier of the destination node.",
            "example":"z8kfsx-16it-3res21sew",
            "nullable":false,
            "type":"string"
        },
        "routingAttrs":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/RoutingAttributes"
                },
                {
                    "description":"Attributes against which routing fields are compared using various operations."
                }
            ]
        },
        "routingField":{
            "description":"Field defined in NPL used for routing.",
            "type":"string"
        },
        "routingFunction":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/RoutingFunctionEnum1"
                },
                {
                    "description":"Routing function used for the channel.",
                    "example":"DIRECTED",
                    "nullable":false
                }
            ]
        },
        "sourceNodeID":{
            "description":"Identifier of the source node.",
            "example":"z8kfsx-16it-l0mbm95p",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Response schema to get a route's information.",
    "type":"object"
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RoutingAttributes"
        },
        {
            "description":"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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RoutingFunctionEnum1"
        },
        {
            "description":"Routing function used for the channel.",
            "example":"DIRECTED",
            "nullable":false
        }
    ]
}

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

{
    "required":[
        "operand1",
        "operator"
    ],
    "properties":{
        "operand1":{
            "description":"Values against which operator acts on the routing field.",
            "items":{
                "type":"string"
            },
            "nullable":false,
            "type":"array"
        },
        "operand2":{
            "description":"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",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "operator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/OperatorEnum1"
                },
                {
                    "description":"Expression representing action to be performed on routing. field",
                    "example":"EQUALS",
                    "nullable":false
                }
            ]
        }
    },
    "description":"Schema defining routing attributes for a route.",
    "type":"object"
}

Nested Schema : operand1

Type: array

Values against which operator acts on the routing field.

Show Source

• Array of: string

{
    "description":"Values against which operator acts on the routing field.",
    "items":{
        "type":"string"
    },
    "nullable":false,
    "type":"array"
}

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

• Array of: string

{
    "description":"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",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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. field

  Example: EQUALS

{
    "allOf":[
        {
            "$ref":"#/components/schemas/OperatorEnum1"
        },
        {
            "description":"Expression representing action to be performed on routing. field",
            "example":"EQUALS",
            "nullable":false
        }
    ]
}

400 Response

The request cannot be processed due to a client error.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

401 Response

The client does not have the correct privileges.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

403 Response

The request was not authorized.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

404 Response

The requested resource cannot be found.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

405 Response

This method is not allowed.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

409 Response

The request cannot be processed due to a conflict in the existing state of the resource.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

500 Response

The system has encountered an internal server error.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

501 Response

The method is not supported.

Body ()

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Back to Top

Examples

The following example shows how to create a route by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/nodes/31eoen-otm-lne9hugk/route' -d @sampleCreateRoute.json

Example of Request Body

The following is an example of the contents of the sampleCreateRoute.json file sent as the request body.

{
  "destinationNodeID": "31eoen-otm-lnejuqgh",
  "routingAttrs": {
    "operand1": [
      "string"
    ],
    "operand2": [
      "string"
    ],
    "operator": "EQUALS"
  },
  "routingField": "string",
  "routingFunction": "MULTICAST"
}

Example of Response Body

If successful, the response code 201 is displayed with the following response body.

{
  "destinationNodeID": "31eoen-otm-lne9iglo",
  "routingAttrs": {
    "operand1": [
      ""
    ],
    "operand2": [
      ""
    ]
  },
  "routingField": "",
  "routingFunction": "MULTICAST",
  "sourceNodeID": "31eoen-otm-lne9hugk"
}

Back to Top