• Array of: object RouteResponse
  The response schema to get a route's information.

{
    "items":{
        "$ref":"#/components/schemas/RouteResponse"
    },
    "type":"array"
}

• destinationNodeID(required): string
  The identifier of the destination node.

  Example: z8kfsx-16it-3res21sew
• routingAttrs: object routingAttrs
  The attributes against which routing fields are compared using various operations.
• routingField: string
  Field defined in NPL used for routing
• routingFunction(required): string routingFunction
  The routing function used for the channel.
• sourceNodeID(required): string
  Identifier of the source node

  Example: z8kfsx-16it-l0mbm95p

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

• object RoutingAttributes
  The schema defining routing attributes for a route.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RoutingAttributes"
        }
    ],
    "description":"The attributes against which routing fields are compared using various operations.",
    "type":"object"
}

• string
  Allowed Values: [ "ROUND ROBIN", "MULTICAST", "MODULUS", "DIRECTED" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RoutingFunctionEnum"
        }
    ],
    "description":"The routing function used for the channel.",
    "example":"DIRECTED",
    "type":"string"
}

DIRECTED

• operand1(required): array operand1
  The values against which the operator acts on the routing field.
• operand2: array operand2
  The values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. For example, IN_BETWEEN operator.
• operator(required): string operator
  The expression representing action to be performed on routing field.

{
    "required":[
        "operand1",
        "operator"
    ],
    "properties":{
        "operand1":{
            "description":"The values against which the operator acts on the routing field.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "operand2":{
            "description":"The values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. For example, IN_BETWEEN operator.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "operator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/OperatorEnum1"
                }
            ],
            "description":"The expression representing action to be performed on routing field.",
            "example":"EQUALS",
            "type":"string"
        }
    },
    "description":"The schema defining routing attributes for a route.",
    "type":"object"
}

• Array of: string

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

• Array of: string

{
    "description":"The values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. For example, IN_BETWEEN operator.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

• string
  Allowed Values: [ "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "IN_BETWEEN", "LIST_EQUALS", "LIST_NOT_EQUALS", "SUBSET_OF", "NOT_SUBSET_OF" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/OperatorEnum1"
        }
    ],
    "description":"The expression representing action to be performed on routing field.",
    "example":"EQUALS",
    "type":"string"
}

EQUALS

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  The application relevant details defined in the API or a common list.
• message: string
  The details and corrective actions for the error shown to the client user.
• reason(required): string
  The reason for the error, which is shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error
• status: string
  HTTP Error code extension

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