Skip to content

Query Analysis Task Page API

API Information

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

Request Headers

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

Request Parameters

ParameterTypeRequiredDescriptionConstraints
AnalysisTaskQueryObjectYesAnalysis task query requestContains pagination and filtering parameters

Request Body Example

json
{
  "page": 1,
  "size": 10,
  "taskName": "Vegetation",
  "algorithmCode": "NDVI_CALCULATION",
  "taskStatus": "COMPLETED",
  "sortField": "createTime",
  "sortOrder": "desc"
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataAnalysisGroupRespAnalysis task list response

AnalysisGroupResp Object

FieldTypeDescription
totalIntegerTotal number of records
listList<AnalysisTaskVo>List of analysis tasks

AnalysisTaskVo Object (Nested in AnalysisGroupResp)

FieldTypeDescription
idLongTask ID
taskNameStringTask name
algorithmCodeStringAlgorithm code
taskStatusStringTask status
progressIntegerProgress percentage
inputCountIntegerNumber of input files
outputCountIntegerNumber of output files
createTimeStringCreation timestamp
startTimeStringStart timestamp
endTimeStringEnd timestamp

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 25,
    "list": [
      {
        "id": 1,
        "taskName": "Vegetation Index Analysis",
        "algorithmCode": "NDVI_CALCULATION",
        "taskStatus": "COMPLETED",
        "progress": 100,
        "inputCount": 2,
        "outputCount": 1,
        "createTime": "2024-01-01T10:00:00Z",
        "startTime": "2024-01-01T10:00:00Z",
        "endTime": "2024-01-01T10:30:00Z"
      }
    ]
  }
}

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 analysis task list with pagination
  2. User authentication is required
  3. Supports filtering by task name, algorithm code, and task status
  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 tasks