Skip to content

Delete Data Files API

API Information

  • Request Path: /datafile/delete/datafiles
  • Request Method: POST
  • Content-Type: application/json

Request Headers

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

Request Body Structure

RemoveDataReq Object

FieldTypeRequiredDescriptionConstraints
dataFileIdsList<Long>YesData file IDs to deleteMust be valid file/folder IDs

Request Body Example

json
{
  "dataFileIds": [12345, 12346, 12347]
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataList<DeleteDataFileResp>Deletion results for each item

DeleteDataFileResp Object (Nested in CommonResponse)

FieldTypeDescription
successBooleanWhether deletion was successful
dataFileIdLongData file ID that was attempted to delete
canNotBeDeletedFilesList<DataFilesResp>Files that could not be deleted

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "success": true,
      "dataFileId": 12345,
      "canNotBeDeletedFiles": []
    },
    {
      "success": true,
      "dataFileId": 12346,
      "canNotBeDeletedFiles": []
    },
    {
      "success": false,
      "dataFileId": 12347,
      "canNotBeDeletedFiles": [
        {
          "id": 12347,
          "fileName": "metadata.json",
          "fileExtension": ".json"
        }
      ]
    }
  ]
}

Failure Response

json
{
  "code": 400,
  "message": "Invalid request parameters",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions

  1. This API is used to delete files or folders
  2. User authentication is required
  3. Data IDs must be provided in an array
  4. Returns detailed results for each deletion attempt

Notes

  • Data IDs are required and must be valid file/folder IDs
  • Multiple items can be deleted in a single request
  • Returns individual success/failure status for each item
  • User authentication token must be included in request headers