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	Definition: File ID. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Definition: 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}. Constraints: N/A Range: N/A Default Value: N/A
X-Traceid	No	String	Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A
language	No	String	Definition: Language code. Constraints: The value must comply with the internationalization specifications. For example, en_us indicates English (United States). Range: The value must comply with the internationalization specifications. Default Value: en-US
X-User-Id	Yes	String	Definition: User ID on KooDrive, which is used for app authentication. Constraints: N/A Range: N/A Default Value: N/A
X-Date	Yes	String	Definition: Date, which is used for app authentication. The format is yyyyMMdd'T'HHmmss'Z'. Constraints: The time must be within 15 minutes from the current time and cannot be later than the current time. Range: N/A Default Value: N/A
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 length cannot exceed 64. Range: N/A Default Value: N/A
name	Yes	String	Definition: New name of the file. Constraints: Cannot contain '<>\|:"*? /\', cannot be .. or ., and can contain up to 250 characters. Range: N/A Default Value: N/A
renameMode	Yes	Integer	Definition: Policy for specifying how to handle duplicate names. Constraints: N/A Range: 2#: Forcibly a file with an existing name by adding a timestamp to the end of the file name. - 3#: Reject files with the same name. A file with an existing name cannot be created. Default Value: N/A

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
}