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

Update SBC devices with a Route Sets

post

/{versionId}/routeSets/devices/action

Update all associated SBC devices with specified route sets. Users provide the route set ID to be updated as part of 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 update all associated SBC devices with specified route sets 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/devices/action"

The following example shows how to update all associated SBC devices with specified route sets using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/devices/action"
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"?>
<routeUpdate>
  <routeSets>
    <routeSets>
        <routeSetId>1</routeSetId>
    </routeSets>
  </routeSets>
  <action>Update</action>
  <failureAction>abort</failureAction>
  <name>Task1</name>
  <notes>notes for task 1</notes>
</routeUpdate>

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

{
  "routeSets": {
    "routeSets": {
      "routeSetId": "2"
    }
  },
  "action": "Update",
  "failureAction": "abort",
  "name": "Task1",
  "notes": "notes for task 1"
}

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"?>
<routeUpdateTask>
  <devices></devices>
  <failureAction>abort</failureAction>
  <initiatedBy>admin</initiatedBy>
  <initiatedDate>2022-10-06T19:21:07</initiatedDate>
  <name>Task1</name>
  <notes>notes for task 1</notes>
  <objectId>ID9</objectId>
  <rollbackStatus>Unknown</rollbackStatus>
  <routeSets></routeSets>
</routeUpdateTask>

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

{
  "devices": "",
  "failureAction": "abort",
  "initiatedBy": "admin",
  "initiatedDate": "2022-10-04T02:00:57",
  "name": "Task1",
  "notes": "notes for task 1",
  "objectId": "ID28",
  "rollbackStatus": "Unknown",
  "routeSets": ""
}
Back to Top