21 Routing Domains
21.1 Get Routing Domains
GET https://<HOST>:<PORT>/api/routingDomains/get?version=0
Returns the currently configured routing domains.
Required Permissions
-
API
-
Configuration Mode Read Access
Response Body Structure
The response body is strutured as an array. The array consists of GetRoutingDomainOptions JSON objects. A description for its fields is at section 27.36.1. For the JSON schema refer to section 27.36.2.
Example
21.2 Add Routing Domain
POST https://<HOST>:<PORT>/api/routingDomains/add?version=1
Adds a new routing domain to the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request Body Structure
The request body is structured as AddRoutingDomainOptions JSON object. A description for its fields is at section 27.35.1. For the JSON schema refer to section 27.35.2.
Response Body Structure
The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 27.36.1. For the JSON schema refer to section 27.36.2.
Example
21.3 Set Routing Domain
POST https://<HOST>:<PORT>/api/routingDomains/set?version=1
Modifies the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The display name or id of the routing domain.
-
version
1
Request Body Structure
The request body is structured as AddRoutingDomainOptions JSON object. A description for its fields is at section 27.35.1. For the JSON schema refer to section 27.35.2.
Response Body Structure
The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 27.36.1. For the JSON schema refer to section 27.36.2.
Example
21.4 Remove Routing Domain
DELETE https://<HOST>:<PORT>/api/routingDomains/remove?version=0
Removes a routing domain from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The ID or display name of the routing domain.
Response Body Structure
The response body is strutured as an array. The array consists of GetRoutingDomainOptions JSON objects. A description for its fields is at section 27.36.1. For the JSON schema refer to section 27.36.2.
Example
21.5 Get Routes
GET https://<HOST>:<PORT>/api/routingDomains/routes/get?version=0
Returns the routes of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Response Body Structure
The response body is strutured as an array. The array consists of RoutingDomainRoute JSON objects. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Example
21.6 Add Route
POST https://<HOST>:<PORT>/api/routingDomains/routes/add?version=0
Adds a route to the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
routingDomain
The id or display name of the routing domain.
Request Body Structure
The request body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Response Body Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Example
21.7 Clone Route
POST https://<HOST>:<PORT>/api/routingDomains/routes/clone?version=0
Clones the selected route.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
routingDomain
The id or display name of the routing domain.
-
displayName
The display name of the route that will be cloned. Either this, the "id" or the "index" must be specified.
-
index
The index of the route that will be cloned. Either this, the "id" or the "displayName" must be specified.
-
id
The id of the route that will be cloned. Either this, the "index" or the "displayName" must be specified.
Response Body Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Example
21.8 Set Route
POST https://<HOST>:<PORT>/api/routingDomains/routes/set?version=0
Modifies a route of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
routingDomain
The id or display name of the routing domain.
-
index
The display name of the route that should be modified. Either this or the "index" must be specified.
Request Body Structure
The request body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Response Body Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Example
21.9 Remove Route
DELETE https://<HOST>:<PORT>/api/routingDomains/routes/remove?version=1
Removes a route from the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
routingDomain
The id or display name of the routing domain.
-
displayName
The display name of the route that will be removed. Either this or the "index" must be specified.
-
index
The index of the route that will be removed. Either this or the "displayName" must be specified.
-
version
1
Response Body Structure
The response body is strutured as an array. The array consists of RoutingDomainRoute JSON objects. A description for its fields is at section 27.37.1. For the JSON schema refer to section 27.37.2.
Example
21.10 Get Source Nodes
GET https://<HOST>:<PORT>/api/routingDomains/sourceNodes/get?version=0
Returns the source nodes of the selected routing domain
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
routingDomain
The id of the routing domain.
Example
21.11 Add Source Nodes
POST https://<HOST>:<PORT>/api/routingDomains/sourceNodes/add?version=1
Adds source nodes to the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id of the routing domain.
-
version
1
Request Body Structure
The body must be a list of the node object ids that should be added to the source nodes of the select routing domain.
The request body is strutured as JSON array. The array consists of String JSON objects. A description for its fields is at section 27.74.1. For the JSON schema refer to section 27.74.2.
Example
21.12 Set Source Nodes
POST https://<HOST>:<PORT>/api/routingDomains/sourceNodes/set?version=0
Modifies the source nodes of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Request Body Structure
The body must be a list of the node object ids that should replace the source nodes of the select routing domain.
The request body is strutured as JSON array. The array consists of String JSON objects. A description for its fields is at section 27.74.1. For the JSON schema refer to section 27.74.2.
Example
21.13 Remove Source Nodes
DELETE https://<HOST>:<PORT>/api/routingDomains/sourceNodes/remove?version=2
Removes source nodes from the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
-
version
2
Request Body Structure
The request body is structured as an array containing the node ids that should be removed.
The request body is strutured as JSON array. The array consists of String JSON objects. A description for its fields is at section 27.74.1. For the JSON schema refer to section 27.74.2.
Example
21.14 Get Proceeding Signal
GET https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/get?version=0
Returns whether the proceeding signal is enabled or not.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Example
21.15 Enable Proceeding Signal
POST https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/enable?version=0
Enables the proceeding signal of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Example
21.16 Disable Proceeding Signal
POST https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/disable?version=0
Disables the proceeding signal of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Example
21.17 Get Route in Maintenance
GET https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/get?version=0
Returns whether routing is active in maintenance mode.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Example
21.18 Enable Route in Maintenance
POST https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/enable?version=0
Enables routing in maintenance mode for the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.
Example
21.19 Disable Route in Maintenance
POST https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/disable?version=0
Disables routing in maintenance mode for the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
routingDomain
The id or display name of the routing domain.