V11 SP8

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


This operation returns the preview for a public shared file or a file within a public shared folder in an ObjectStore based on the file path.

Preview is currently supported for all images and Microsoft Office file types.

By default, you can preview files that have a maximum file size limit of 10 MB. For instructions on changing the file size limit, see Changing the File Size Limit for Preview.



GET <webservice>/contentstore/publicshare/{shareId}/action/preview?path={path} HTTP/1.1
Host: <host name>
Accept: text/html
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. Yes
path The path to the file or folder. Specify the path relative from the share root.

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.


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 text/html for non-images or image/jpeg for images.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.


All image file types are previewed as .jpg files.

For Microsoft office files, the HTML content of the file is displayed as preview.


Sample Request

GET <webservice>/contentstore/publicshare/30/action/preview?path=\new.jpg HTTP/1.1
Host: client.mydomain.com
Accept: image/jpeg
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

Supported Error Codes

Code Status Description
400 Bad Request The request is missing required parameters or the file name has some unacceptable characters.
204 No Content Preview is not available for the file.
403 Forbidden User does not have permissions to preview or the preview is requested for a folder or an unsupported file type.
404 Not Found The specified file does not exist.