Skip to content

Query Data File Page API

API Information

  • Request Path: /datafile/query/page
  • Request Method: POST
  • Content-Type: application/json

Request Headers

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

Request Body Structure

QueryDataFiles Object

FieldTypeRequiredDescriptionConstraints
parentIdLongNoParent directory ID, root use -1, if value is null, system will search all datadirectory filter
pageIntegerYesPage numberMust be positive integer
sizeIntegerYesPage sizeMust be positive integer
fileNameStringNoFile name filterOptional name filter
geometryLongNowkt format polygonOptional geometry filter

Request Body Example

json
{
  "page": 1,
  "size": 10,
  "fileName": "satellite",
  "parentId": -1,
  "geometry": "POLYGON ((54.32011 24.452572, 54.329834 24.452572, 54.329834 24.459919, 54.32011 24.459919, 54.32011 24.452572))"
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataFileRespData file list response

DataFileResp Object

FieldTypeDescription
totalLongTotal number of records
pagesIntegerTotal number of pages
fileVoListList<DataFileVo>List of data file records

DataFileVo Object (Nested in DataFileResp)

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": {
    "total": 50,
    "pages": 5,
    "fileVoList": [
      {
        "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"
      }
    ]
  }
}

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 query data file list with pagination (user's own data)
  2. User authentication is required
  3. Supports filtering by file name, extension, parent directory, and data type
  4. Returns paginated results with total count

Notes

  • User authentication token must be included in request headers
  • Request body must be valid JSON format
  • Pagination parameters are required
  • Demo users can only see their own files