Skip to content

Query File Details API

API Information

  • Request Path: /datafile/query/file/details
  • Request Method: GET
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token

Request Parameters

ParameterTypeRequiredDescriptionConstraints
datafileIdLongYesData file IDMust be a valid data file ID

Parameter Example

/datafile/query/file/details?datafileId=12345

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataFileVoFile details response

DataFileVo Object (Nested in CommonResponse)

FieldTypeDescription
idLongFile ID
dataTypeIntegerData type (0-satellite image file)
imageIdStringImage unique identifier
fileExtensionStringFile format (tif, tiff, gltf, obj, etc.)
sizeDoubleFile size in GB
fileNameStringFile/folder name
dirPathStringFile/folder logical storage path
parentIdLongParent folder ID
folderIntegerIs folder (0-file, 1-folder)
captureTimeLongCapture timestamp
updateTimeLongUpdate timestamp
categoryIntegerFile category
userNameStringUser name
avatarStringUser avatar
creatorStringCreator name
thumbnailUrlStringThumbnail URL
bandInfosList<SpectralBandInfo>Spectral band information

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": 1,
    "dataType": 0,
    "imageId": "IMG_001",
    "fileExtension": ".tif",
    "size": 1.024,
    "fileName": "satellite_image_001.tif",
    "dirPath": "/data/satellite",
    "parentId": 12345,
    "folder": 0,
    "captureTime": 1704105600000,
    "updateTime": 1704105600000,
    "category": 1,
    "userName": "admin",
    "avatar": "/avatars/admin.jpg",
    "creator": "admin",
    "thumbnailUrl": "/thumbnails/satellite_image_001.jpg",
    "bandInfos": []
  }
}

Failure Response

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

Error Code Description

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

Usage Instructions

  1. This API is used to query detailed information about a specific file or folder
  2. User authentication is required
  3. Data file ID must be provided as query parameter
  4. Returns comprehensive file information including metadata

Notes

  • Data file ID is required and must be a valid file ID
  • Returns detailed technical information about the file
  • Includes metadata for raster and vector files
  • User authentication token must be included in request headers