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.

Request

Syntax

DELETE webservice/contentstore/share/shareId/properties HTTP/1.1
 Host: host name
 Accept: application/xml
 Authtoken: authentication token
 Content-type: application/xml
 <Api_CustomPropertiesReq>
 <fileFolderInfo fileGUID="245eb5cbf00d446abf495b76577cd4c6"/>
 <fileFolderInfo fileGUID="2e4da058de924b3f9d0d92e725af46a8"/> 
 <customProps> 
     <nameValues name="propName3" value="propValue3"/>
     <nameValues name="propName4" value="propValue4"/> 
 </customProps> 
 </Api_CustomPropertiesReq>

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.	fileFolderInfo

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
a specific error code.

App_GenericResp

errorString

The description of the error code. Not all error codes have an error string.