Jump to

• Request
• Response
• Examples

Set Folder Tags

post

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

Set all tags values to a particular folder. This API will set tags and it will also replace any previously set values. In case replacing tag values is not the desired result, see the Edit Folder Tags API.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• folderId: string

  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(optional): 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(optional): 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(optional): 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(optional): 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 ()

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

Root Schema : FolderSetTagsBody

Type: object

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

Show Source

• setTags(optional): string
  Comma-separated list of tags to be set to this folder.

{
    "description":"The request body defines details of the set tags values request.",
    "properties":{
        "setTags":{
            "type":"string",
            "description":"Comma-separated list of tags to be set to this folder."
        }
    }
}

Example Request (application/json)

{
    "setTags":"todo,pending"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : FolderSetTagsResponse

Type: object

The response body includes information about folder tags set.

Show Source

• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• idList(optional): string
  Globally unique identifier (GUID) of the original folder.
• type(optional): string
  Item type folder.

{
    "description":"The response body includes information about folder tags set.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        }
    }
}

Example Response (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.

Back to Top

Examples

The following example assigns tag values to a folder. These values will replace any tags already set on this folder.

POST .../folders/FD3947BCFB3D3517CC7E6312B5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
    "setTags":"todo,pending"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

The following example assigns tag values to a folder. These values will replace any tags already set on this folder. 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.

POST .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "setTags":"myTag,appLinkTag"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Back to Top