V11 SP8

Delete Custom Properties of Files and Folders in an ObjectStore Share Using ID (REST API: DELETE)


Use this operation to delete the custom properties of individual or multiple files and folders that are shared or resides within a shared folder in an ObjectStore based on the GUID of the file or folder.



DELETE <webservice>/contentstore/share/{shareId}/properties HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<fileFolderInfo fileGUID="245eb5cbf00d446abf495b76577cd4c6"/>
<fileFolderInfo fileGUID="2e4da058de924b3f9d0d92e725af46a8"/>
    <nameValues name="propName3" value="propValue3"/>
    <nameValues name="propName4" value="propValue4"/>

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

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.

Request Body

An XML element is required. See Syntax. The following table displays the parameters for the request body.

Name Description Elements
name The name of the custom property. nameValues
value The value assigned to the custom property. nameValues
fileGUID 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.



Response Parameters

Parameter Description Element
errorCode The possible error codes.

Valid values are:

  • 0, successful completion.
  • a specific error code.
errorString The description of the error code. Not all error codes have an error string. App_GenericResp


Sample Request

DELETE <webservice>/contentstore/share/39/properties HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
Content-type: application/xml
<fileFolderInfo fileGUID="4c303a847f494d0d9f05df09f08494b4"/>
<fileFolderInfo fileGUID="9299782c90684c25bcc74d71c641d9d0"/>
  <nameValues name="property1" value="value1"/>
  <nameValues name="property2" value="value2"/>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>

Supported Error Codes

Code Status Description
400 Bad Request Required parameters were not specified correctly or the custom property is not provided in the request body or invalid path inside share.
403 Forbidden Input token does not match or share has expired or User does not have access or editable rights to the share.
404 Not Found GUID provided in request is not found or failed to get share folder details. Share may no longer exist.