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

Modify a Route Set

put

/{versionId}/routeSets/{routeSetId}

Modify a specific route set that exists on the SDM server. Users provide the Route Set ID that needs modification.

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 modify a particular route set using curl.

curl -X PUT \
    -b sessionid.txt \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}"

The following example shows how to modify a particular route set using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.put(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>
   <description>This is the modified route set through Rest API</description>
</routeSet>

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

{
  "description": "This is the modified test Add route through Rest API"
}

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 modified route set through Rest API</description>
  <deviceLrtConfigName>testRoute</deviceLrtConfigName>
  <deviceLrtFilename>testRoute.xml.gz</deviceLrtFilename>
  <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
  <lastModifiedTime>2022-10-06 20:22:56</lastModifiedTime>
  <lockOwner>admin</lockOwner>
  <lockState>true</lockState>
  <name>RouteSet1</name>
  <notes>Add route set with Import Template containing Header</notes>
  <pubIdType>E164</pubIdType>
  <routeCount>9</routeCount>
  <routeSetId>1</routeSetId>
  <version>1</version>
</routeSet>

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

{
  "description": "This is the modified 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 01:03:33",
  "lockOwner": "admin",
  "lockState": "true",
  "name": "RouteSet1",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "E164",
  "routeCount": "0",
  "routeSetId": "2",
  "version": "0"
}

Example for Range Type RouteSet

Shows the response available in NNC 9.0.2 and later.

An example XML request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
  <description>Description of test_route1</description>
</routeSet>

An example JSON request body:

{
  "description": "This is the modified test Add route through Rest API"
}

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSet>
    <description>Description of test_route1</description>
    <deviceLrtConfigName>testRoute2</deviceLrtConfigName>
    <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
    <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
    <lastModifiedTime>2000-12-09 07:08:21</lastModifiedTime>
    <lockOwner>admin</lockOwner>
    <lockState>true</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 modified 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:17:55",
  "lockOwner": "admin",
  "lockState": "true",
  "name": "TestRouteSet1",
  "notes": "Add route set with Import Template containing Header",
  "pubIdType": "range",
  "routeCount": "0",
  "routeSetId": "13",
  "version": "0"
}
Back to Top