Loading...

View Properties of File or Folder in ObjectStore Using Path (REST API: GET)

This operation returns the properties associated with a file or folder in an ObjectStore based on the file or folder path.

Request

Syntax

GET <webservice>/contentstore/action/metadata?path={path} 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

path

The path to the file or folder. Specify the path relative from the root.

Note: The path must be URL encoded before they are sent in the request.

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: 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

sizeinBytes

The size of the file.

App_FileResourceResponse

parentGuid

The GUID of the parent folder.

App_FileResourceResponse

GUID

The GUID of the file or folder.

App_FileResourceResponse

file

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

App_FileResourceResponse

directory

'directory=1' indicates the request item is a folder.

App_FileResourceResponse

modifiedTime

The last modified time of the file or folder.

App_FileResourceResponse

path

The path to the file or folder.

App_FileResourceResponse

parentPath

The path to the parent folder.

App_FileResourceResponse

downloadurl

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

To generate the complete URL of the file, see Generating Full Download URLs.

App_FileResourceResponse

versionGUID

The GUID of the latest version of the file.

App_FileResourceResponse

name

Name of the file or folder

App_FileResourceResponse

Examples

Sample Request

GET <webservice>/contentstore/action/metadata?path=\Test1.docx HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<App_FileResourceResponse>
<fileResource parentPath="\"sizeinBytes="620888" downloadUrl="/drive/file/83dd41f4d7b848429daf15b668ea5f9a/action/download parentGuid="62df0e9f1899425eb98173a8adb802c6" GUID="83dd41f4d7b848429daf15b668ea5f9a" file="1" modifiedTime="1247549551" path="\Test1.docx" name="test1.docx"/>
</App_FileResourceResponse>

Supported Error Codes

Code

Status

Description

400

Bad Request

The request is missing required parameters or the file/folder name has some unacceptable characters.

403

Forbidden

The user does not have access to the share or the file/folder requested is not accessible inside the share.

404

Not Found

The specified file or folder does not exist.

Last modified: 1/10/2018 5:59:35 PM