Jump to

• Request
• Response
• Examples

Get Routing Fields of a Rule File

get

/v1/nodes/routeAttributes

Returns the routing algorithm for a node by node ID.

Request

Query Parameters

• nodeId(required): string
  The node identifier.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The routing fields of the rule file have been returned successfully.

Body ()

Root Schema : RouteAttributesResponse

Type: object

Response schema to get the output fields for a node

Show Source

• fields(required): array fields
  The output fields for a node defined in NPL.
• nodeId(required): string
  The identifier of the node.

{
    "required":[
        "nodeId",
        "fields"
    ],
    "properties":{
        "nodeId":{
            "description":"The identifier of the node.",
            "type":"string"
        },
        "fields":{
            "description":"The output fields for a node defined in NPL.",
            "items":{
                "$ref":"#/components/schemas/RoutingAttributesModel"
            },
            "type":"array"
        }
    },
    "description":"Response schema to get the output fields for a node",
    "type":"object"
}

Nested Schema : fields

Type: array

The output fields for a node defined in NPL.

Show Source

• Array of: object RoutingAttributesModel
  Schema defining an output field's details for a route

{
    "description":"The output fields for a node defined in NPL.",
    "items":{
        "$ref":"#/components/schemas/RoutingAttributesModel"
    },
    "type":"array"
}

Nested Schema : RoutingAttributesModel

Type: object

Schema defining an output field's details for a route

Show Source

• id: string
  The identifier or the name of the field.
• type: integer (int32)
  The type of the field.

{
    "properties":{
        "id":{
            "description":"The identifier or the name of the field.",
            "type":"string"
        },
        "type":{
            "description":"The type of the field.",
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"Schema defining an output field's details for a route",
    "type":"object"
}

400 Response

The server cannot process the request 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
  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.

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

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

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
  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 request cannot be processed due to the conflict with 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
  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.

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

Back to Top

Examples

The following example shows how to get the route attributes for a specified node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://hostname:port/nodes/routeAttributes?nodeId=31eoef-otm-lna53s09'

Example of the Response Body

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

{
  "fields": [
    {
      "id": "calling_number",
      "type": 0
    },
    {
      "id": "seq_no",
      "type": 1
    }
  ],
  "nodeId": "31eoef-otm-lna53s09"
}

Back to Top