Appearance
Query File Details API
API Information
- Request Path:
/datafile/query/file/details - Request Method:
GET - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
Request Parameters
| Parameter | Type | Required | Description | Constraints |
|---|---|---|---|---|
| datafileId | Long | Yes | Data file ID | Must be a valid data file ID |
Parameter Example
/datafile/query/file/details?datafileId=12345Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | DataFileVo | File details response |
DataFileVo Object (Nested in CommonResponse)
| Field | Type | Description |
|---|---|---|
| id | Long | File ID |
| dataType | Integer | Data type (0-satellite image file) |
| imageId | String | Image unique identifier |
| fileExtension | String | File format (tif, tiff, gltf, obj, etc.) |
| size | Double | File size in GB |
| fileName | String | File/folder name |
| dirPath | String | File/folder logical storage path |
| parentId | Long | Parent folder ID |
| folder | Integer | Is folder (0-file, 1-folder) |
| captureTime | Long | Capture timestamp |
| updateTime | Long | Update timestamp |
| category | Integer | File category |
| userName | String | User name |
| avatar | String | User avatar |
| creator | String | Creator name |
| thumbnailUrl | String | Thumbnail URL |
| bandInfos | List<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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 404 | File not found |
| 500 | Server internal error |
Usage Instructions
- This API is used to query detailed information about a specific file or folder
- User authentication is required
- Data file ID must be provided as query parameter
- 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