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

Lock a RouteSet

post

/{versionId}/routeSets/{routeSetId}/action

Lock, Unlock, or OverrideLock a route set on the SDM server. Users provide the action to be taken on a route set as part of method body. Users provide the Route Set ID on which action needs to be executed as part of the URI.

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 lock, unlock, or override the lock of a 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/{routeSetId}/action"

The following example shows how to lock, unlock, or override the lock of a route set using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/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"?>
<routeSetAction>
  <type>Lock</type>
</routeSetAction>

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

{
  "type": "Lock"
}

Example of the Response Body

This endpoint does not return a response body.

Back to Top