Appearance
Rename Folder API
API Information
- Request Path:
/datafile/folder/rename - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
RenameFolderReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| folderId | Long | Yes | Folder ID to rename | Must be a valid folder ID |
| newName | String | Yes | New folder name | Must be unique within parent directory |
Request Body Example
json
{
"folderId": 12345,
"newName": "renamed_folder"
}Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | Boolean | Rename result, true indicates success |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": true
}Failure Response
json
{
"code": 404,
"message": "Folder not found",
"data": false
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 404 | Folder not found |
| 500 | Server internal error |
Usage Instructions
- This API is used to rename a folder
- User authentication is required
- Folder ID and new name must be provided
- Returns boolean indicating rename success
Notes
- Folder ID is required and must be a valid folder ID
- New name must be unique within the parent directory
- User authentication token must be included in request headers