Skip to content

Download Folder URLs API

API Information

  • Request Path: /datafile/folder/urls
  • Request Method: GET
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token

Request Parameters

ParameterTypeRequiredDescriptionConstraints
folderIdLongYesFolder IDMust be a valid folder ID

Parameter Example

/datafile/folder/urls?folderId=12345

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataFileUrlsRespDownload URLs response with folder structure

DataFileUrlsResp Object

FieldTypeDescription
urlListList<DataFileUrl>List of download URLs

DataFileUrl Object (Nested in DataFileUrlsResp)

FieldTypeDescription
urlStringDownload URL
dataFileIdLongData file ID
nameStringFile name
pathStringFile path (used for drone images uploaded via OBS path)

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "urlList": [
      {
        "url": "https://example.com/download/satellite_data/landsat/image_001.tif?token=...",
        "dataFileId": 12346,
        "name": "image_001.tif",
        "path": "/satellite_data/landsat/image_001.tif"
      },
      {
        "url": "https://example.com/download/satellite_data/sentinel/image_002.tif?token=...",
        "dataFileId": 12347,
        "name": "image_002.tif",
        "path": "/satellite_data/sentinel/image_002.tif"
      }
    ]
  }
}

Failure Response

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

Error Code Description

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

Usage Instructions

  1. This API is used to get download URLs for all files in a folder
  2. User authentication is required
  3. Folder ID must be provided as query parameter
  4. Returns download URLs with folder structure preserved

Notes

  • Folder ID is required and must be a valid folder ID
  • Returns hierarchical structure with folder paths
  • Download URLs are temporary and expire
  • User authentication token must be included in request headers