Query Process Task List API

API Information

• Request Path: /processtask/query/page
• 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 Body Parameters

DataProcessListReq Object

Parameter	Type	Required	Description	Constraints
keyword	String	No	Search keyword for filtering tasks	Optional
taskStatusList	List<Integer>	No	List of task status codes to filter by	Optional
taskTypeList	List<Integer>	No	List of task type codes to filter by	Optional
pageNumber	Integer	No	Current page number	Default: 1
pageSize	Integer	No	Number of items per page	Default: 10

Parameter Example

{
  "keyword": "clip task",
  "taskStatusList": [3, 4],
  "taskTypeList": [3],
  "pageNumber": 1,
  "pageSize": 20
}

Response Body

CommonResponse Object

Field	Type	Description
code	Integer	Response status code
message	String	Response message
data	DataProcessResp	Response data containing task list

DataProcessResp Object

Field	Type	Description
taskList	List<DataProcessVo>	List of process task objects
pageNumber	Integer	Current page number
pageSize	Integer	Number of items per page
pageCount	Long	Total number of pages
totalCount	Long	Total number of items across all pages

DataProcessVo Object

Field	Type	Description
id	Long	Task ID
taskName	String	Task name
taskType	Integer	Task type
status	Integer	Task status
creator	String	Creator ID
creatorName	String	Creator display name
creatorAvatarUrl	String	Creator avatar URL
ctime	Long	Creation timestamp
outputDataFileId	Long	Output data file ID
reason	String	Failure reason (if applicable)

Response Examples

Success Response

{
  "code": 200,
  "message": "success",
  "data": {
    "taskList": [
      {
        "id": 12345,
        "taskName": "Clip Task 001",
        "taskType": 3,
        "status": 3,
        "creator": "user123",
        "creatorName": "John Doe",
        "creatorAvatarUrl": "https://example.com/avatar.jpg",
        "ctime": 1698765432000,
        "outputDataFileId": 67890,
        "reason": null
      },
      {
        "id": 12346,
        "taskName": "Mosaic Task 002",
        "taskType": 2,
        "status": 5,
        "creator": "user456",
        "creatorName": "Jane Smith",
        "creatorAvatarUrl": "https://example.com/avatar2.jpg",
        "ctime": 1698765433000,
        "outputDataFileId": null,
        "reason": null
      }
    ],
    "pageNumber": 1,
    "pageSize": 20,
    "pageCount": 5,
    "totalCount": 98
  }
}

Empty Result Response

{
  "code": 200,
  "message": "success",
  "data": {
    "taskList": [],
    "pageNumber": 1,
    "pageSize": 20,
    "pageCount": 0,
    "totalCount": 0
  }
}

Failure Response

{
  "code": 401,
  "message": "Unauthorized",
  "data": null
}

Error Code Description

Error Code	Description
200	Success
400	Request parameter error
401	Unauthorized
500	Server internal error

Task Type Reference

Value	Task Type	Description
0	Extract Info	Extract metadata and information from data files
1	Fusion	Combine multiple data sources into a single output
2	Mosaic	Create a mosaic from multiple overlapping images
3	Clip	Extract a specific region from the data
4	Cloud Removal	Remove cloud cover from imagery
5	Index Calculation	Calculate spectral indices (NDVI, etc.)
6	Band Merge	Combine multiple bands into a single file

Task Status Reference

Value	Task Status	Description
0	Not Started	Task created but not yet started
1	Downloading Files	Downloading required input files
2	Downloaded	All input files downloaded successfully
3	Processing Complete	Data processing completed successfully
4	Processing Failed	Data processing failed
5	Processing	Data processing in progress
6	Publishing	Publishing output files
7	Publish Complete	Publishing completed successfully
8	Publish Failed	Publishing failed
9	Download Failed	File download failed

Usage Instructions

1. This API is used to query paginated lists of data processing tasks
2. Optional filtering by keyword, task status, and task type is supported
3. Pagination is handled through pageNumber and pageSize parameters
4. User authentication is required, valid Authorization token must be included in request headers
5. The response includes pagination metadata and detailed task information

Notes

• All request parameters are optional
• When no filters are provided, all tasks are returned (paginated)
• Task status and type filters accept arrays of integer values
• The keyword parameter searches in task names
• Timestamps are returned as Unix timestamps in milliseconds
• Failed tasks include a reason field with failure details