Get the Task Status
get
/{versionId}/routeSets/tasks/{taskId}
Get the status of an 'Add Route Set' task by restoring an LRT file from a specified device. Users provide the task ID as part of the URI.
Request
Path Parameters
-
taskId(required):
The id of the add route set task.
-
versionId(required):
The rest api version, it's value is v1.3.
Query Parameters
-
addMode:
The mode specified for adding route set. It can have values copy/upload
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
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to get status of add route set task by restoring LRT from device using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/routeSets/tasks/21?addMode=upload"The following example shows how to get status of add route set task by restoring LRT from device using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/tasks/21?addMode=upload"
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"?>
<addRouteSetTask>
<rowsProcessed>0</rowsProcessed>
<status>Failed</status>
<taskId>4</taskId>
</addRouteSetTask>The following example shows the contents of the response body in JSON.
{
"rowsProcessed": "10",
"status": "Completed",
"taskId": "21"
}