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

POST to Lock/Unlock/OverrideLock a RouteSet

post

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

Use this (POST) method to Lock / Unlock/ OverrideLock a RouteSet on SDM server. User needs to provide the action to be taken ona route set as part of method body and needs to provide Route Set ID on which action needs to be executed as part of 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

Example of Accessing the API with cURL

The following example shows how to lock, unlock, or override the lock of a 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/{routeSetId}/action"

Example of Accessing the API with Python

The following example shows how to lock, unlock, or override the lock of a 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
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/action"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.post(url, headers=headers)

Example of the Response Body

This endpoint does not return a response body.

Back to Top