1. REST API for Content Management 1.1
  2. Tasks
  3. Files

Delete All File Tags

delete

/documents/api/1.1/files/{fileId}/tags

Delete all tags directly assigned to this file. It is important to observe that inherited tags will not be deleted and, therefore, they will still be retrieved by the Get File Tags API.

Request

Supported Media Types
  • application/json
  • application/xml
Path Parameters
fileId
Type: string
Required: true

Globally unique identifier (GUID) for the file.

Header Parameters
accessToken
Type: string

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.

appLinkID
Type: string

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.

dAccessCode
Type: string

Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>

linkID
Type: string

Public link ID of a public link authorizing the current user to access this file. It can be used as linkID or LinkID.

Response

Supported Media Types
  • application/json
  • application/xml
200 Response

The request was fulfilled.

Body
The response body includes information about file delete tags results.
Root Schema : FileDeleteTagsResponse
The response body includes information about file delete tags results.
Example application/json

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0"
}
400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example deletes all tags directly assigned to this file.

DELETE .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518",
    "type": "file"
}

Example 2

The following example deletes all tags directly assigned to this file. The example uses an applink ID because this file is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

DELETE .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/tags

Request Header

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}