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

Get Status by Task ID

get

/{versionId}/routeSets/routeUpdates/{taskId}

Get the details of the route update task on device. Users provide the update task ID to get the update task details.

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 get status of update task by task ID using curl.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets/routeUpdates/ID5"

The following example shows how to get status of update task by task ID using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/routeUpdates/ID5"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

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"?>
<routeUpdateTaskDetails>
    <errorHandling>abort</errorHandling>
    <rollbackCount>0</rollbackCount>
    <rollbackStatus>Unknown</rollbackStatus>
    <totalDeviceCount>0</totalDeviceCount>
    <updateStatus>Failed</updateStatus>
    <updatedCount>0</updatedCount>
</routeUpdateTaskDetails>

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

{
  "deviceStatusList": [{
      "deviceGroupId": "ID11",
      "objectId": "ID34",
      "preUpdateVersion": "0",
      "pushStatus": "Completed",
      "rollBackStatus": "Unknown",
      "routeSetId": "2",
      "routeUpdateTaskId": "ID33",
      "status": "Completed",
      "updateDate": "2022-10-04T04:03:56",
      "updateFailureMsg": "",
      "updateVersion": "1"
  }],
  "errorHandling": "rollback",
  "rollbackCount": "0",
  "rollbackStatus": "Unknown",
  "totalDeviceCount": "1",
  "updateStatus": "Completed",
  "updatedCount": "1"
}
Back to Top