Download a File in ObjectStore Using Path (REST API: GET)

This operation downloads a file in an ObjectStore based on the file path.

Note: Downloading a folder is currently not supported using this operation.

Request

Syntax

GET webservice/contentstore/action/download?path=path HTTP/1.1
 Host: host name
 Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

path

The path to the file to be downloaded. Specify the path relative from the root.

For example, if you want to download file1.txt in folder temp under the root folder, the path value will be \temp\file1.txt.

Note: The path must be URL encoded before they are sent in the request.

Yes

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Examples

Sample Request

GET webservice/contentstore/action/download?path=\Test\File1.txt HTTP/1.1
 Host: client.mydomain.com
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Supported Error Codes

Code	Status	Description
400	Bad Request	The request is missing required parameters.
403	Forbidden	Download operation is not allowed. This can happen if you attempt to download a folder.
404	Not Found	The specified file does not exist.