Loading...

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

Description

This operation downloads a file in the ObjectStore public share based on the GUID of the file.

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

Request

Syntax

GET <webservice>/contentstore/publicshare/{shareId}/file/{fileId}/action/download 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 returned when you share a file or folder. To retrieve the ShareId, use the syncWebFolderId response when you share a file or folder or view the shared files and folders in the ObjectStore. Yes
fileId The GUID of the file to be downloaded. GUID is a unique identifier for a file or folder and remains the same even when you rename or move the file or folder to another path.

To retrieve the GUID of the file or folder, see Viewing File or Folder Properties.

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/file/7c4e538afe864e25ae415357aa6fa04e/action/download 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"/>