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

This operation returns the preview of a specific version of a public shared file or a file within a public shared folder in an ObjectStore based on the GUID of the file version.

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.

Request

Syntax

GET <webservice>/contentstore/publicshare/{shareId}/file/version/{versionId}/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
versionId	The GUID of the file version that you want to preview. 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

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

versionId

The GUID of the file version that you want to preview. 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 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/publicshare/30/file/version/4865bff27253197a97be8bf2eb5b530e/action/preview HTTP/1.1
 Accept: text/html
 Host: client.mydomain.com

Sample Response

<html xmlns="http://www.w3.org/1999/xhtml"> 
 <head> 
 <meta name="X-Parsed-By" content="org.apache.tika.parser.DefaultParser"/> 
 <meta name="X-Parsed-By" content="org.apache.tika.parser.txt.TXTParser"/> 
 <meta name="Content-Encoding" content="windows-1252"/> 
 <meta name="ext_name" content="none"/> 
 <meta name="Content-Type" content="text/plain; charset=windows-1252"/> 
 </head> 
 <body style="background:#fff;" background="" > 
 <pre>Demo File Content
 Content 1 
 Content 2
 </pre> 
 </body> 
 </html>

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.