Renaming a File

Function

Rename a file.

URI

POST /koodrive/ose/v1/files/rename/{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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
containerId	Yes	String	Space ID.
name	Yes	String	New file name, which cannot contain <>\|:"*?/\ or be two periods (..) or a period (.). Maximum: 80
renameMode	Yes	Integer	Duplicate name policy. 2: Forcibly renames a file with an existing name by adding a timestamp to the end of the file name. 3: Rejects files with the same name. A file with an existing name cannot be created.

Response Parameters

Status code: 200

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

Example Requests

Renames a file whose ID is FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y under the space whose ID is IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 to Download.

POST /koodrive/ose/v1/files/rename/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y

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

{
    "name": "Download",
    "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "renameMode": 2
}