Loading...

View Properties of File or Folder in an ObjectStore Public Share (REST API: GET)

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

Request

Syntax

GET <webservice>/contentstore/publicshare/{shareId}/action/metadata?path={path} HTTP/1.1
Host: <host name>
Accept: 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

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

path

The complete path to the shared file or folder.

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.

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 relative from the shared folder.

App_FileResourceResponse

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.

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/publicshare/7/action/metadata?path=\new\test1.docx HTTP/1.1
Host: client.mydomain.com
Accept: application/xml

Sample Response

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

Last modified: 1/10/2018 6:56:10 PM