V11 SP8

Delete Tags from Shared File or Folder in an ObjectStore (REST API: DELETE)


Use this operation to delete tags from one or more shared files and folders in an ObjectStore.



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

<Api_TagsReq values="">
<fileFolderInfo fileGUID=""/>
<fileFolderInfo fileGUID=""/>

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.  

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.

Request Body

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

Name Description Elements
values The tag name. You can specify multiple tag names separated by a comma (,). Api_TagsReq
fileGUID The GUID of the file or folder from which the tags need to be deleted. 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, see Viewing File or Folder Properties.



Response Parameters

Parameter Description Element
errorMessage The description of the error. Not all error codes have an error string. response
fileGUID The GUID of the file or folder for which the delete tag operation failed. If delete operation was successful for all the files and folders in the request, the response will be blank. For example, <Api_TagsRespList/> fileFolderInfo


Sample Request

DELETE <webservice>/contentstore/share/37/tags HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
Content-type: application/xml

<Api_TagsReq values="tag1,tag2">
<fileFolderInfo fileGUID="4c303a847f494d0d9f05df09f08494b4"/>
<fileFolderInfo fileGUID="6sdkjfh47f494d0d9f05df09f08494sd"/>

Sample Response

<response errorMessage="Guid provided in the request is not found.">
fileGUID="6sdkjfh47f494d0d9f05df09f08494sd " />

Supported Error Codes

Code Status Description
400 Bad Request The request is missing required request body or the file or folder information is not provided in the request body or shareId is not specified correctly.
500 Internal Server Error Failed to retrieve the share information.
403 Forbidden Error caused by one of the following reasons:
  • Input token does not match
  • Share expired
  • User does not have access to the share
  • User does not have editable rights to the share
404 Not Found Failed to get share folder details. Share may no longer exist.