REST API for Content Management 1.1

Edit File Tags

put

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

Edit tag values assigned to a particular file. This API adds new tags without replacing existing ones or removes specific tags or both.

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.

Body Parameter

The request body defines details of the edit tags values request. There are no required attributes.

Root Schema : FileEditTagsBody

The request body defines details of the edit tags values request.

Properties

addTags: Type: string

Comma-separated list of tags to be added to this file.
removeTags: Type: string

Comma-separated list of tags to be removed from this file.

Example application/json


{
    "addTags":"newTagValue",
    "removeTags":"existingTagValue"
}

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about file edit tags results.

Root Schema : FileEditTagsResponse

The response body includes information about file edit tags results.

Properties

errorCode: Type: number

An error code of zero (0) indicates no errors.
idList: Type: string

Globally unique identifier (GUID) for the file.
type: Type: string

Item type file.

Example application/json


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

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 edits tag values assigned to a file. It will add new tags without replacing existing ones.

PUT .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
    "addTags":"inclusive"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

The following example edits tag values assigned to a file. It will remove a single tag without replacing or removing other existing ones.

PUT .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
    "removeTags":"inclusive"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 3

The following example edits tag values assigned to a file. It will add new tags without replacing existing ones. 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.

PUT .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "addTags":"addFileTagApplink"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 4

The following example edits tag values assigned to a file. It will remove a single tag without replacing or removing other existing ones. 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.

PUT .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "removeTags":"addFileTagApplink"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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