REST API Reference for Offline Mediation Controller

Update the Route Attributes Between Two Nodes

patch

/v1/nodes/{srcNodeId}/route/{destNodeId}

Updates existing route attributes between two nodes.

Request

Path Parameters

destNodeId(required): string

The destination node identifier.
srcNodeId(required): string

The source node identifier.

Supported Media Types

application/json;charset=utf-8

Root Schema : schema

Type: object

The payload schema to PATCH update an existing route.

Show Source

routingAttrs: object routingAttrs

Attributes against which routing fields are compared using various operations
routingField: string

The field defined in NPL used for routing.

{
    "properties":{
        "routingField":{
            "description":"The field defined in NPL used for routing.",
            "type":"string"
        },
        "routingAttrs":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs"
                }
            ],
            "description":"Attributes against which routing fields are compared using various operations",
            "type":"object"
        }
    },
    "description":"The payload schema to PATCH update an existing route.",
    "type":"object"
}

Nested Schema : routingAttrs

Type: object

Attributes against which routing fields are compared using various operations

Match All

Attributes against which routing fields are compared using various operations

Show Source

object RouteUpdateRequestRoutingAttrs

The schema defining routing attributes for a route update request.

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

Nested Schema : RouteUpdateRequestRoutingAttrs

Type: object

The schema defining routing attributes for a route update request.

Show Source

operand1: array operand1

The values against which the operator acts on the routing field.
operand2: array operand2

The values against which the 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: string operator

The expression representing action to be performed on routing field.

{
    "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 the 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/OperatorEnum"
                }
            ],
            "description":"The expression representing action to be performed on routing field.",
            "example":"EQUALS",
            "type":"string"
        }
    },
    "description":"The schema defining routing attributes for a route update request.",
    "type":"object"
}

Nested Schema : operand1

Type: array

The values against which the operator acts on the routing field.

Show Source

Array of: string

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

Nested Schema : operand2

Type: array

The values against which the operator acts on the routing field, two operands are required when an operator is used which requires 3 variables, for example, IN_BETWEEN operator.

Show Source

Array of: string

{
    "description":"The values against which the 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"
}

Nested Schema : operator

The expression representing action to be performed on routing field.

Match All

The expression representing action to be performed on routing field.

Show Source

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/OperatorEnum"
        }
    ],
    "description":"The expression representing action to be performed on routing field.",
    "example":"EQUALS",
    "type":"string"
}

Example:

EQUALS

Response

Supported Media Types

application/json

200 Response

The route attributes have been updated successfully.

Root Schema : RouteResponse

Type: object

The response schema to get a route's information.

Show Source

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"
}

Nested Schema : routingAttrs

Type: object

The attributes against which routing fields are compared using various operations.

Match All

The attributes against which routing fields are compared using various operations.

Show Source

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"
}

Nested Schema : routingFunction

The routing function used for the channel.

Match All

The routing function used for the channel.

Show Source

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"
}

Example:

DIRECTED

Nested Schema : RoutingAttributes

Type: object

The schema defining routing attributes for a route.

Show Source

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"
}

Nested Schema : operand1

Type: array

The values against which the operator acts on the routing field.

Show Source

Array of: string

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

Nested Schema : operand2

Type: array

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.

Show Source

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"
}

Nested Schema : operator

The expression representing action to be performed on routing field.

Match All

The expression representing action to be performed on routing field.

Show Source

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"
}

Example:

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

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"
}

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

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"
}

403 Response

The request is unauthorized.

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

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"
}

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

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"
}

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

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"
}

409 Response

The resource cannot be processed due to a conflict with 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

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"
}

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

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"
}

Examples

This example shows how to update the route attributes between two nodes by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH 'http://hostname:port/nodes/31eoen-otm-lne9hugk/route/31eoen-otm-lne9iglo'

Example of the Response Body

If successful, the response code 200 is returned with the following response body.

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