View Custom Properties of a File or Folder in an ObjectStore Using ID (REST API: GET)

Use this operation to list specific or all custom properties of a file or a folder in an ObjectStore based on the GUID of the file or folder.

Request

Syntax

GET <webservice>/contentstore/file/{fileOrfolderId}/properties?propertyFilter={FILTER} HTTP/1.1

 Host: <host name>

 Accept: application/xml

 Authtoken: <authentication token>

 Content-type: application/xml

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

fileOrfolderId

The GUID of the file or folder. 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

Filter

The custom property name to be listed. You can also include wildcards to list all custom properties with a specific pattern.

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.
Content-type	The media type contained in the request body.

Response

Response Parameters

Parameter	Description	Element
name	The custom property name.	nameValues
value	The value for the custom property.	nameValues

Examples

Sample Request

To view all the custom properties:

GET <webservice>/contentstore/file/97409005317b4dbd9c138d2fd80a9e50/properties?HTTP/1.1

 Host: client.mydomain.com

 Accept: application/xml

 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

 Content-type: application/xml

To view the details of a specific custom property name:

GET <webservice>/contentstore/file/97409005317b4dbd9c138d2fd80a9e50/properties?propertyFilter=prop1 HTTP/1.1

 Host: client.mydomain.com

 Accept: application/xml

 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

 Content-type: application/xml

Sample Response

List all custom properties of a file:

<App_GetCustomPropertyResp> 

 <error /> 

 <props> 

 <customProps> 

 <nameValues name="FILE_FOLDER_SORT" value="1\b" /> 

 <nameValues name="IS_VISIBLE" value="true" /> 

 <nameValues name="MODIFIED_TIME_ROUND" value="2015-04-16T12:00:00Z" /> 

 <nameValues name="SIZE_KB_ROUND" value="0" /> 

 <nameValues name="szkbround2" value="0" /> 

 <nameValues name="cvfsuniqueid" value="332142243" /> 

 <nameValues name="timestamp" value="2015-04-16T13:52:27.754Z" /> 

 <nameValues name="propName1" value="propValue1" /> 

 <nameValues name="propName2" value="propValue2" /> 

 <nameValues name="propName3" value="propValue3" /> 

 <nameValues name="FILE_FOLDER_PATH_DATATYPE" value="1\b" /> 

 </customProps> 

 </props> 

 </App_GetCustomPropertyResp>

List a specific custom property:

<App_GetCustomPropertyResp> 

 <error /> 

 <props> 

 <customProps> 

 <nameValues name="propName1" value="propValue1" /> 

 </customProps> 

 </props> 

 </App_GetCustomPropertyResp>

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 or folder.
404	Not Found	GUID provided in request is not found.