Skip to content

Rename Folder API

API Information

  • Request Path: /datafile/folder/rename
  • Request Method: POST
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure

RenameFolderReq Object

FieldTypeRequiredDescriptionConstraints
folderIdLongYesFolder ID to renameMust be a valid folder ID
newNameStringYesNew folder nameMust be unique within parent directory

Request Body Example

json
{
  "folderId": 12345,
  "newName": "renamed_folder"
}

Response Body

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataBooleanRename 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 CodeDescription
200Success
400Request parameter error
401Unauthorized
404Folder not found
500Server internal error

Usage Instructions

  1. This API is used to rename a folder
  2. User authentication is required
  3. Folder ID and new name must be provided
  4. 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