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

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

Preview is currently supported for 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.

Request

Syntax

GET <webservice>/contentstore/share/{shareId}/file/{fileId}/action/preview 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
fileID	The GUID of the file. 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, see Viewing ObjectStore File or Folder Properties.	Yes

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

fileID

The GUID of the file. 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, see Viewing ObjectStore 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 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.

Response

All image file types are previewed as .jpg files.

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

Examples

Sample Request

GET <webservice>/contentstore/share/37/file/04fe655ecd804c40afca8bf3da604ac7/action/preview HTTP/1.1

 Host: client.mydomain.com

 Accept: text/html

 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

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.