Adding a Custom Tag to a File

Function

Add a custom tag to the file, overwriting the existing tag with the same name.

URI

POST /koodrive/ose/v1/files/tag/{fileId}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
fileId	Yes	String	File ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
x-hw-share-folder-id	No	String	Definition: ID of the shared folder. If this request header is passed, the current operation is performed in the shared folder. Constraints: N/A Range: N/A Default Value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
containerId	Yes	String	Definition: Space ID. Constraints: The value cannot exceed 64 characters. Range: N/A Default Value: N/A
tagList	Yes	Array of TagInfo objects	Definition: List of tags. Constraints: The number of tags must be less than 100. Range: N/A Default Value: N/A

**Table 4** TagInfo
Parameter	Mandatory	Type	Description
key	Yes	String	Parameter description: Tag name. Constraints: The value contains a maximum of 128 characters, including letters, digits, and underscores (_). Value range: N/A Default Value: N/A
value	No	String	Definition: Tag value. Constraints: The value contains a maximum of 1,024 characters, excluding the number sign (#). Range: N/A Default Value: N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response message.

Example Requests

Add tag1 and tag2 to the file whose ID is FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y under the space whose ID is IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4.

POST /koodrive/ose/v1/files/tag/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y

Authorization:Bearer+10f88*********4791e9ff

{
    "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
     "tagList": [{"tag1":"1","tag2":"2"}]
}