1. REST API for Session Delivery Manager Release 8.2.5p1
  2. Tasks
  3. route sets management

Create a new route Set

post

/{versionId}/routeSets

Use this (POST) method to 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

Example of Accessing the API with cURL

The following example shows how to create a new route set by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use 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 shows an example of the contents of the request.json file sent as the request body. 

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

Example of Accessing the API with Python

The following example shows how to create a new route set by submitting a POST request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate. 

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 Response Body

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

<?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>
Back to Top