Get File Tags
/documents/api/1.2/files/{fileId}/tags
Request
- application/json
- application/xml
-
fileId: string
Globally unique identifier (GUID) for the file.
-
directAssigned(optional): string
Specify if just directly assigned tags should be retrieved (
1
) or if all inherited tags should be included as well (0
).
-
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 parameteraccessToken
must be provided as well. 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.
Response
- application/json
- application/xml
200 Response
The request was fulfilled.
object
-
errorCode(optional):
number
An error code of zero (0) indicates no errors.
-
idList(optional):
string
Globally unique identifier (GUID) for the file.
-
tags(optional):
string
Tags associated with this file.
-
type(optional):
string
Item type
file
.
{
"errorCode":"0",
"idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
"tags":"personal,work",
"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 returns all tags associated with the specified file. By default, all inherited tags will be retrieved with all tags directly assigned to this file. In this example, the tags file
and metadata
are directly assigned to this file, and the tags personal
and work
are assigned to its parent folder.
GET .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "idList": "D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518", "tags": "file,metadata,personal,work", "type": "file" }
Example 2
The following example returns all tags directly associated with the specified file. You can change this behavior by using the query parameter directAssigned
to retrieve only directly assigned tags (1
) or to retrieve inherited tags as well (0
). In this example, the tags file
and metadata
are directly assigned to this file.
GET .../files/D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518/tags?directAssigned=1
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "idList": "D2D76EA99539F2BDF37FD80CB5D17B95F47087F4E518", "tags": "file,metadata", "type": "file" }
Example 3
The following example returns all tags associated with the specified 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.
GET .../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", "tags": "myFileTag,appLinkFileTag", "type": "file" }