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

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

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

Request

Syntax

GET webservice/contentstore/publicshare/shareId/file/version/versionId/action/download HTTP/1.1
 Host: host name

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

versionId

The GUID of the file version that you want to download. 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 all the file versions, see View Versions of a File in ObjectStore.

Yes

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.

Response

Displays the file contents.

Examples

Sample Request

GET webservice/contentstore/publicshare/37/file/version/4865bff27253197a97be8bf2eb5b530e/action/download HTTP/1.1
 Host: client.mydomain.com

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.