REST API Reference for Offline Mediation Controller

Delete Route Between Two Nodes

delete

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

Deletes the route between two specified nodes.

Request

Path Parameters

destNodeId(required): string

The destination node identifier.
srcNodeId(required): string

The source node identifier.

There's no request body for this operation.

Response

Supported Media Types

application/json

204 Response

The route has been deleted successfully.

Root Schema : schema

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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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 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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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 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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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

The 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)

The URI of the documentation describing the error.
status: string

The HTTP error code describing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing the error.",
            "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 delete the route between a source node and a destination node by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL.

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

Example of the Response Body

If successful, the response code 204 is returned with no response body.