Skip to content

Edit File API

API Information

  • Request Path: /datafile/file/edit
  • Request Method: POST
  • Content-Type: application/json

Request Headers

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

Request Body Structure

FieldTypeRequiredDescriptionConstraints
idLongYesFile IDMust exist
nameStringNoFile/folder name-
parentIdLongNoParent directory ID-1 for root directory

Request Body Example

json
{
  "id": 12345,
  "name": "updated_satellite_image.tif",
  "parentId": 67890
}

Response Body

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataBooleanEdit result, true indicates success

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": true
}

Failure Response

json
{
  "code": 404,
  "message": "File not found",
  "data": false
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
404File not found
500Server internal error

Usage Instructions

  1. This API is used to edit file properties
  2. User authentication is required
  3. File ID is required to identify which file to edit
  4. Returns boolean indicating edit success

Notes

  • File ID is required and cannot be null
  • Only fields that are provided will be updated
  • User authentication token must be included in request headers