Download a File in Edge Drive Public Share Using Path (REST API: GET)

This operation downloads a file from the Edge Drive public share based on the file path.

Request

Syntax

GET <webservice>/drive/publicshare/{shareId}/action/download?path={path} 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 (syncWebFolderId response) returned when you share a file or view the shared files in the Edge Drive. For details on retrieving the syncWebFolderId response, see Sharing a File or Folder or Viewing Shared Files and Folders.	Yes
path	The complete path to the file to be downloaded. Specify the path relative from the shared folder. Note: The path must be URL encoded before they are sent in the request.	Yes

Name

Description

Required

shareID

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

Yes

path

The complete path to the file to be downloaded. Specify the path relative from 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:

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>/drive/publicshare/36/action/download?path=\Test\File1.txt HTTP/1.1

 Host: client.mydomain.com

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>

 <App_GenericResp errorCode="0"/>