View Versions of a File in ObjectStore Using ID (REST API: GET)

Use this operation to view the first 50 versions of a file in an ObjectStore based on the GUID of the file. The versions are listed in descending order so that the latest version is the top result.

Request

Syntax
GET webservice/contentstore/file/fileId/versions HTTP/1.1
 Host: host name
 Accept: application/xml
 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

filed

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 or folder, see View ObjectStore File Properties.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Command Center used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

modifiedTime

The last modified time of the file.

fileResources

previewUrl

The URL for previewing the file. By default, a relative URL is returned.

fileResources

parentPath

The path to the parent folder.

fileResources

downloadUrl

The URL for downloading the file. By default, a relative download URL is returned.

To generate the complete URL for download, see Generating Full Download URLs.

fileResources

versionGUID

The GUID of the file version.

fileResources

parentGuid

The GUID of the parent folder.

fileResources

GUID

The GUID of the latest version of the file.

fileResources

name

Name of the file.

fileResources

file

'file=1' indicates the request item is a file.

fileResources

path

The path to the file.

fileResources

sizeinBytes

The size of the file.

fileResources

Examples

Sample Request
GET webservice/contentstore/file/d03149668c114174a342b3b2f3d020f8/versions HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<App_FileResourceListResponse> 
 <fileResources modifiedTime="1486413437" previewUrl="/contentstore/file/d03149668c114174a342b3b2f3d020f8/action/preview" parentPath="\DemoFolder" GUID="d03149668c114174a342b3b2f3d020f8" sizeinBytes="30" downloadUrl="/contentstore/file/d03149668c114174a342b3b2f3d020f8/action/download" directory="0" versionGUID="bcfd92e9d421dd071d20627f2a93624c" path="\DemoFolder\DemoFile1.doc" file="1" parentGuid="e26269e2967444ab8322828d481cdcde" name="DemoFile1.doc" canUserEdit="0" isShared="0" /> <fileResources modifiedTime="1481595468" previewUrl="/contentstore/file/d03149668c114174a342b3b2f3d020f8/action/preview" parentPath="\DemoFolder" GUID="d03149668c114174a342b3b2f3d020f8" sizeinBytes="17" downloadUrl="/contentstore/file/d03149668c114174a342b3b2f3d020f8/action/download" directory="0" versionGUID="6965bff27253197a97be8bf2eb5b530e" path="\DemoFolder\DemoFile1.doc" file="1" parentGuid="e26269e2967444ab8322828d481cdcde" name="DemoFile1.doc" canUserEdit="0" isShared="0" /> </App_FileResourceListResponse>

Supported Error Codes

Code

Status

Description

400

Bad Request

The request is missing required parameters or the GUID provided in request is not of the file.

404

Not Found

GUID provided in request is not found.

×

Loading...