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

Use this operation to download a shared file in the ObjectStore based on the GUID of the file.

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

Request

Syntax

GET <webservice>/contentstore/share/{shareId}/file/{fileId}/action/download 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

shareId

The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in the ObjectStore. For details on retrieving the syncWebFolderId response, see Sharing a File or Folder or Viewing Shared Files and Folders.

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.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Examples

Sample Request

GET <webservice>/contentstore/share/36/file/7c4e538afe864e25ae415357aa6fa04e/action/download HTTP/1.1
 Host: client.mydomain.com
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Supported Error Codes

Code	Status	Description
400	Bad Request	The request is missing required parameters.
403	Forbidden	Error cased due to one of the following reasons: The user does not have access to the share The file requested is not accessible inside the share Download operation is not allowed. This can happen if you attempt to download a folder.
404	Not Found	The specified file does not exist.

Code

Status

Description

400

Bad Request

The request is missing required parameters.

403

Forbidden

Error cased due to one of the following reasons:

The user does not have access to the share
The file requested is not accessible inside the share
Download operation is not allowed. This can happen if you attempt to download a folder.

404

Not Found

The specified file does not exist.