Use this operation to list specific or all custom properties of a file or folder that is public shared or resides within a public shared folder in Edge Drive based on the GUID of the file or folder.
Request
Syntax
GET <webservice>/drive/publicshare/{shareId}/file/{fileOrfolderId}/properties?propertyFilter={FILTER} HTTP/1.1
Host: <host name>
Accept: application/xml
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. 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 Properties of File or Folder. | Yes |
shareId | The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in Edge Drive. For details on retrieving the syncWebFolderId response, see Sharing a File or Folder or Viewing Shared Files and Folders. | Yes |
Filter | The custom property name to be listed. You can also include wildcards to list all custom properties with a specific pattern. | No |
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>/drive/publicshare/37/file/97409005317b4dbd9c138d2fd80a9e50/properties?HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Content-type: application/xml
To view the details of a specific custom property name:
GET <webservice>/drive/publicshare/37/file/97409005317b4dbd9c138d2fd80a9e50/properties?propertyFilter=prop1 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
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 | Required parameters were not specified correctly or invalid path inside share. |
403 | Forbidden | Input token does not match or share has expired or the user does not have access to this share. |
404 | Not Found | GUID provided in request is not found or failed to get share folder details. Share may no longer exist. |