This operation downloads a file from the ObjectStore public share based on the file path.
Note: Downloading a folder is currently not supported using this operation.
Request
Syntax
GET webservice/contentstore/publicshare/shareId/action/download?path=path HTTP/1.1
Host: host namewhere <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 |
|
shareID |
The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in the ObjectStore. |
Yes |
|
path |
The complete path to the file to be downloaded. Specify the path relative to the shared folder. 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 Web Console used in the API request. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
errorCode |
The possible error codes. Valid values are:
|
App_GenericResp |
|
errorString |
The description of the error code. Not all error codes have an error string. |
App_GenericResp |
Example
Sample Request
GET webservice/contentstore/publicshare/36/action/download?path=\Test\File1.txt HTTP/1.1
Host: client.mydomain.comSample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>