Use this operation to delete tags from one or more files and folders in an ObjectStore.
Request
Syntax
DELETE webservice/contentstore/tags HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token
Content-type: application/xml
<Api_TagsReq values="">
<fileFolderInfo fileGUID=""/>
<fileFolderInfo fileGUID=""/>
</Api_TagsReq>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 Headers
|
Name |
Description |
|
Host |
The host name of the Web Server or the Command Center 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. |
fileFolderInfo |
Response
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 |
Examples
Sample Request
DELETE webservice/contentstore/tags HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<Api_TagsReq values="tag1,tag2">
<fileFolderInfo fileGUID="4c303a847f494d0d9f05df09f08494b4"/>
<fileFolderInfo fileGUID="6sdkjfh47f494d0d9f05df09f08494sd"/>
</Api_TagsReq>Sample Response
<Api_TagsRespList>
<response errorMessage="Guid provided in the request is not found.">
<fileFolderInfo
fileGUID="6sdkjfh47f494d0d9f05df09f08494sd " />
</response>
</Api_TagsRespList>
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. |