Jump to

• Request
• Response
• Examples

Set File Tags

post

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

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

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• fileId: string

  Globally unique identifier (GUID) for the file.

Header Parameters

• accessToken(optional): 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(optional): 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(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 file. It can be used as linkID or LinkID.

Body ()

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

Root Schema : FileSetTagsBody

Type: object

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

Show Source

• setTags: string
  Comma-separated list of tags to be set to this file.

{
    "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 file."
        }
    },
    "required":[
        "setTags"
    ]
}

Example Request (application/json)

{
    "setTags":"file,metadata"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : FileSetTagsResponse

Type: object

The response body includes information about the file tags set.

Show Source

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

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

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

Back to Top

Examples

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

POST .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags

Request Header

None.

Request Body

{
	"setTags":"file,metadata"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

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

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/tags

Request Header

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

Request Body

{
    "setTags":"myFileTag,appLinkFileTag"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Back to Top