Appearance
Query Analysis Task Page API
API Information
- Request Path:
/analysis/task/page/query - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Parameters
| Parameter | Type | Required | Description | Constraints |
|---|---|---|---|---|
| AnalysisTaskQuery | Object | Yes | Analysis task query request | Contains 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
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | AnalysisGroupResp | Analysis task list response |
AnalysisGroupResp Object
| Field | Type | Description |
|---|---|---|
| total | Integer | Total number of records |
| list | List<AnalysisTaskVo> | List of analysis tasks |
AnalysisTaskVo Object (Nested in AnalysisGroupResp)
| Field | Type | Description |
|---|---|---|
| id | Long | Task ID |
| taskName | String | Task name |
| algorithmCode | String | Algorithm code |
| taskStatus | String | Task status |
| progress | Integer | Progress percentage |
| inputCount | Integer | Number of input files |
| outputCount | Integer | Number of output files |
| createTime | String | Creation timestamp |
| startTime | String | Start timestamp |
| endTime | String | End 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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to query analysis task list with pagination
- User authentication is required
- Supports filtering by task name, algorithm code, and task status
- 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