V11 SP8

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


This operation returns the preview of a specific version of a file in 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.



GET <webservice>/contentstore/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
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.


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/file/version/6965bff27253197a97be8bf2eb5b530e/action/preview HTTP/1.1
Host: client.mydomain.com
Accept: text/html
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

Sample Response

<html xmlns="http://www.w3.org/1999/xhtml">
<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"/>
<body style="background:#fff;" background="" >
<pre>Demo File Content
Content 1
Content 2


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.