Skip to content

Delete Dataset API

API Information

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

Request Headers

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

Request Body Structure

FieldTypeRequiredDescriptionConstraints
idsList<Long>YesDataset ID listCannot be null

Request Body Example

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

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDeleteDatasetRespDataset deletion response

DeleteDatasetResp Structure

FieldTypeDescription
successBooleanDeletion success status
notDeleteDatasetsList<Dataset>Datasets that could not be deleted

Response Examples

Success Response

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

Failure Response

json
{
  "code": 404,
  "message": "Dataset not found",
  "data": {
    "success": false,
    "notDeleteDatasets": [
      {
        "id": 12345,
        "name": "Satellite Dataset"
      }
    ]
  }
}

Error Code Description

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

Usage Instructions

  1. This API is used to delete one or more datasets
  2. Dataset IDs must be provided in an array
  3. User authentication is required
  4. Only dataset owners can delete their datasets
  5. Returns detailed deletion result including datasets that could not be deleted

Notes

  • Dataset IDs are required and cannot be null
  • Multiple datasets can be deleted in a single request
  • Deletion may fail if the dataset contains metadata or files
  • Failed deletions are reported in notDeleteDatasets field
  • User authentication token must be included in request headers
  • Request body must be valid JSON format