REST API for Content Management 1.1

Edit Folder Tags

put

/documents/api/1.1/folders/{folderId}/tags

Edit tag values assigned to a particular folder. 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

folderId: Type: string

Required: true

Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for folderId is self.

Header Parameters

accessToken: Type: string

Applink access token authorizing the current user to access this folder. 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 this folder. 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 folder. 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 : FolderEditTagsBody

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 folder.
removeTags: Type: string

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

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 folder edit tags results.

Root Schema : FolderEditTagsResponse

The response body includes information about folder edit tags results.

Properties

errorCode: Type: number

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

Globally unique identifier (GUID) of the original folder.
type: Type: string

Item type folder.

Example application/json


{
    "errorCode":"0",
    "idList":"FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518",
    "type":"folder"
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

Folder ID is not found.

Examples

The following example edits tag values assigned to a folder. It will add new tags without replacing existing ones.

PUT .../folders/FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
    "addTags":"important"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518",
    "type": "folder"
}

Example 2

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

PUT .../folders/FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
    "removeTags":"important"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518",
    "type": "folder"
}

Example 3

Edit tag values assigned to a particular folder. This API adds new tags without replacing existing ones or removes specific tags, or both. The example uses an applink ID because this folder 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 .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "addTags":"addTagApplink"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "type": "folder"
}

Example 4

The following example edits tag values assigned to a folder. It will remove a single tag without replacing or removing other existing ones. The example uses an applink ID because this folder 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 .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "removeTags":"addTagApplink"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "type": "folder"
}