Loading...

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

Description

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 name>
Accept: application/xml

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
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: Special characters and spaces must be encoded before they are sent in the request. For example, spaces must be encoded with a plus sign: test+results.txt.

Yes

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.

Response

Response Parameters

Parameter Description Element
errorCode The possible error codes.

Valid values are:

  • 0, successful completion.
  • a specific error code.
App_GenericResp
errorString The description of the error code. Not all error codes have an error string. App_GenericResp

Examples

Sample Request

GET <webservice>/contentstore/publicshare/36/action/download?path=\Test\File1.txt HTTP/1.1
Host: client.mydomain.com
Accept: application/xml

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>