Use this operation to view the properties associated with a specific version of a public shared file in an ObjectStore.
Request
Syntax
GET <webservice>/contentstore/publicshare/{shareID}/file/version/{versionId} HTTP/1.1
Host: <host name>
Accept: application/xml
AuthShareToken: <password>
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 Edge Drive. For details on retrieving the syncWebFolderId response, see Sharing a File or Folder. |
Yes |
|
versionID |
The GUID of the file version. 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 versionID of a file, see Viewing File Versions. |
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. |
|
AuthShareToken |
Password for the public share in baser64 format. Applicable only when the public share is password protected. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
owner |
The name and email address of the share owner. |
App_FileResourceResponse |
|
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='true' indicates the request item is a file. |
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 |
|
name |
Name of the file. |
App_FileResourceResponse |
|
previewUrl |
The URL to preview 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 |
|
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 |
|
canUserEdit |
Indicates if the share user can edit the file. Valid values are: True or False. |
App_FileResourceResponse |
|
name |
The custom property name. |
nameValues |
|
value |
The value for the custom property. |
nameValues |
Examples
Sample Request
GET <webservice>/contentstore/publicshare/134384/file/version/83dd41f4d7b848429daf15b668ea5f9a HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Sample Response
{ "fileResource": { "owner": "user1 (user1@company.com)", "modifiedTime": 1488209749, "previewUrl": "/drive/file/version/36b3da7312eb134b114ccd2baef8eb22/action/preview", "parentPath": "\\", "GUID": "c33b0ed340284066bd23d4331c5bf354", "sizeinBytes": 11361, "downloadUrl": "/drive/file/version/36b3da7312eb134b114ccd2baef8eb22/action/download", "versionGUID": "36b3da7312eb134b114ccd2baef8eb22", "path": "\\test1.docx", "file": true, "parentGuid": "7fb849cb45ce43fc8818c14dc9d9a2db", "name": "test1.docx", "canuseredit": true, "customProperties": { "nameValues": [{ "name": "IS_VISIBLE", "value": "true" }, { "name": "timestamp", "value": "2017-07-12T16:27:27.675Z" }, { "name": "mtmstr", "value": "1488209749" }, { "name": "cvfsuniqueid", "value": "709687305" }, { "name": "_version_", "value": "1572734895047835648" }, { "name": "CI_STATUS", "value": "0" }] } }, "error": {}
}