Skip to content

Get Download URL API

API Information

  • Request Path: /analysis/task/get/Download/url
  • Request Method: GET
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token

Request Parameters

ParameterTypeRequiredDescriptionConstraints
taskIdStringYesTask IDMust be a valid task ID

Parameter Example

/analysis/task/get/Download/url?taskId=12345

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDownloadUrlRespDownload URL response

DownloadUrlResp Object

FieldTypeDescription
taskIdStringTask ID
downloadUrlsList<DownloadUrlVo>List of download URLs
totalSizeLongTotal file size in bytes

DownloadUrlVo Object (Nested in DownloadUrlResp)

FieldTypeDescription
fileNameStringFile name
downloadUrlStringDownload URL
fileSizeLongFile size in bytes
expiresAtStringURL expiration timestamp

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "12345",
    "downloadUrls": [
      {
        "fileName": "ndvi_result.tif",
        "downloadUrl": "https://example.com/download/ndvi_result.tif?token=...",
        "fileSize": 512000,
        "expiresAt": "2024-01-01T11:00:00Z"
      },
      {
        "fileName": "analysis_report.pdf",
        "downloadUrl": "https://example.com/download/analysis_report.pdf?token=...",
        "fileSize": 150000,
        "expiresAt": "2024-01-01T11:00:00Z"
      }
    ],
    "totalSize": 662000
  }
}

Failure Response

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

Error Code Description

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

Usage Instructions

  1. This API is used to get download URLs for analysis task results
  2. User authentication is required
  3. Task ID must be provided as query parameter
  4. Returns download URLs for all output files from the analysis task

Notes

  • Task ID is required and must be a valid task ID
  • Returns temporary download URLs that expire
  • User authentication token must be included in request headers