1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. route sets management

Create a New Route Set

post

/{versionId}/routeSets

Create a new route set on SDM server. User has to provide the route set information in the method body.

Request

Path Parameters
Back to Top

Response

200 Response

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to create a new route set using curl.

curl -X POST \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets"

The following example shows how to create a new route set using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)

Example of the Request Body

The following example shows the contents of the request body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
   <name>RouteSet2</name>
   <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
   <deviceLrtConfigName>testRoute2</deviceLrtConfigName>
   <description>This is the test Add route through Rest API</description>
   <notes>Add route set with Import Template containing Header</notes>
   <pubIdType>E164</pubIdType>
   <addMode>add</addMode>
</routeSet>

The following example shows the contents of the request body in JSON.

{
  "name": "RouteSet1",
  "deviceLrtFilename": "testRoute.xml.gz",
  "deviceLrtConfigName": "testRoute",
  "description": "This is the test Add route through Rest API",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "E164",
  "addMode": "add"
}

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
    <description>This is the test Add route through Rest API</description>
    <deviceLrtConfigName>testRoute2</deviceLrtConfigName>
    <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
    <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
    <lastModifiedTime>2022-08-08 02:58:02</lastModifiedTime>
    <lockOwner></lockOwner>
    <lockState>false</lockState>
    <name>RouteSet2</name>
    <notes>Add route set with Import Template containing Header</notes>
    <pubIdType>E164</pubIdType>
    <routeCount>0</routeCount>
    <routeSetId>2</routeSetId>
    <version>0</version>
</routeSet>

The following example shows the contents of the response body in JSON.

{
  "description": "This is the test Add route through Rest API",
  "deviceLrtConfigName": "testRoute",
  "deviceLrtFilename": "testRoute.xml.gz",
  "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
  "lastModifiedTime": "2022-10-04 00:52:22",
  "lockOwner": "",
  "lockState": "false",
  "name": "RouteSet1",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "E164",
  "routeCount": "0",
  "routeSetId": "2",
  "version": "0"
}

Example for Range Type RouteSet: Copy a Route Set

This example shows the request and response for copying a route set available in NNC 9.0.2 and later.

An example XML request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
  <name>RouteSet10</name>
  <deviceLrtFilename>testRoute10.xml.gz</deviceLrtFilename>
  <deviceLrtConfigName>testRoute10</deviceLrtConfigName>
  <description>This is for demo.</description>
  <notes> demo note</notes>
  <pubIdType>Range</pubIdType>
  <copyFromRouteSetId>18</copyFromRouteSetId>
  <addMode>copy</addMode>
</routeSet>

An example JSON request body:

{
  "name": "TestRouteSet2",
  "deviceLrtFilename": "demo.xml.gz",
  "deviceLrtConfigName": "demo",
  "description": "This is a test",
  "note": "sample",
  "pubIdType": "range",
  "copyFromRouteSetId": "13",
  "addMode": "copy"
}

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <routeSet>
  <addMode>copy</addMode>
  <addTaskId>158</addTaskId>
  <addTaskStatus>Working</addTaskStatus>
  <lockState>false</lockState>
</routeSet>

An example JSON response:

{
  "addMode": "copy",
  "addTaskId": "11",
  "addTaskStatus": "Working",
  "lockState": "false"
}

Example for Range Type RouteSet: Add a Route Set

This example shows the request and response for adding a route set available in NNC 9.0.2 and later.

An example XML request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
   <name>test_route1</name>
   <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
   <deviceLrtConfigName>testRoute2
   </deviceLrtConfigName>
   <description>This is the test Add route through Rest API</description>
   <notes>Add route set with Import Template containing Header</notes>
   <pubIdType>RANGE</pubIdType>
   <addMode>add</addMode>
</routeSet>

An example JSON request body:

{
  "name": "TestRouteSet1",
  "deviceLrtFilename": "testRoute.xml.gz",
  "deviceLrtConfigName": "testRoute",
  "description": "This is the test Add route through Rest API",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "Range",
  "addMode": "add"
}

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
    <description>This is the test Add route through Rest API</description>
    <deviceLrtConfigName>testRoute2</deviceLrtConfigName>
    <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
    <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
    <lastModifiedTime>2000-12-09 07:07:31</lastModifiedTime>
    <lockOwner></lockOwner>
    <lockState>false</lockState>
    <name>test_route1</name>
    <notes>Add route set with Import Template containing Header</notes>
    <pubIdType>range</pubIdType>
    <routeCount>0</routeCount>
    <routeSetId>18</routeSetId>
    <version>0</version>
</routeSet>

An example JSON response:

{
  "description": "This is the test Add route through Rest API",
  "deviceLrtConfigName": "testRoute",
  "deviceLrtFilename": "testRoute.xml.gz",
  "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
  "lastModifiedTime": "2000-12-09 09:06:44",
  "lockOwner": "",
  "lockState": "false",
  "name": "TestRouteSet1",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "range",
  "routeCount": "0",
  "routeSetId": "13",
  "version": "0"
}
Back to Top