Appearance
Delete Data Files API
API Information
- Request Path:
/datafile/delete/datafiles - 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
RemoveDataReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| dataFileIds | List<Long> | Yes | Data file IDs to delete | Must be valid file/folder IDs |
Request Body Example
json
{
"dataFileIds": [12345, 12346, 12347]
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | List<DeleteDataFileResp> | Deletion results for each item |
DeleteDataFileResp Object (Nested in CommonResponse)
| Field | Type | Description |
|---|---|---|
| success | Boolean | Whether deletion was successful |
| dataFileId | Long | Data file ID that was attempted to delete |
| canNotBeDeletedFiles | List<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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to delete files or folders
- User authentication is required
- Data IDs must be provided in an array
- 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