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

Import a CSV File in to a Route Set

post

/{versionId}/routeSets/{routeSetId}/importFile

Import a CSV file having route information to a Route Set. Users provide the route set ID containing the header, file delimiter, and template ID details in the request query parameters. Users also provide the CSV file to be uploaded as part of request body.

Request

Path Parameters
Query Parameters
  • This parameter will have value (YES/NO) depending whether file contains header information.
  • The character used as delimiter in the file to be imported.
  • The id of the template used to import routes from the file.
Back to Top

Response

200 Response

202 Response

The user request is accepted.

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 import a CSV file in to 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}/importFile?containsHeader=YES&fileDelimiter=,&templateId=ID9"

The following example shows how to import a CSV file in to route set using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/importFile?containsHeader=YES&fileDelimiter=,&templateId=ID9"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.post(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"?>
<importTask>
  <taskId>13</taskId>
</importTask>

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

{
  "taskId":"13"
}
Back to Top