Get Task List
Query the current user's file processing task list. Use pagination parameters to browse historical tasks and inspect task-level metadata such as status, cost, source type, and target type.
Request Method
- Method: GET
- Parameter style: Query
Request Parameters
| Parameter | Data type | Description | Required |
|---|---|---|---|
| page | Long | Current page number | No (defaults to 1) |
| size | Long | Items per page | No (defaults to 10) |
Request URL
https://api-server.compdf.com/server/v2/task/list
Response Parameters
| Parameter | Data type | Description |
|---|---|---|
| records | Array | Task records on the current page |
| total | Long | Total number of records |
| size | Long | Items per page |
| current | Long | Current page number |
| pages | Long | Total page count |
| createdBy | String | Creator |
| updatedBy | String | Updater |
| creationTime | LocalDateTime | Creation time |
| updateTime | LocalDateTime | Update time |
| id | Long | Task primary key ID |
| taskId | String | Task ID |
| taskUrl | String | Original task file folder |
| taskLoadUrl | String | Converted task file folder |
| taskFileNum | Integer | Number of files in the task |
| taskSuccessNum | Integer | Number of successful files |
| taskFailNum | Integer | Number of failed files |
| taskStatus | String | Task status |
| assetTypeId | Integer | Asset type used |
| taskCost | Integer | Task cost |
| taskTime | Long | Task duration |
| callbackUrl | String | Callback URL |
| server | String | Server address |
| sourceType | String | Source file format |
| targetType | String | Target file format |
| tenantId | Long | Tenant ID |
Response Example
json
{
"records": [
{
"createdBy": null,
"updatedBy": null,
"creationTime": "2022-08-31 15:06:20",
"updateTime": "2022-08-31 15:14:44",
"id": 771751854513061888,
"taskId": "a300c232-0a2d-4e3c-95f2-cfb4604b2018",
"taskUrl": "",
"taskLoadUrl": "",
"taskFileNum": 3,
"taskSuccessNum": 0,
"taskFailNum": 0,
"taskStatus": "TaskFinish",
"assetTypeId": 0,
"taskCost": 3,
"taskTime": 0,
"callbackUrl": "",
"server": "",
"sourceType": "pdf",
"targetType": "docx",
"tenantId": 1
},
{
"createdBy": null,
"updatedBy": null,
"creationTime": "2022-08-31 15:25:24",
"updateTime": "2022-08-31 15:26:17",
"id": 771756653954465793,
"taskId": "e74d60a6-fbd3-4d7d-9efa-0dc70297ee0b",
"taskUrl": "",
"taskLoadUrl": "",
"taskFileNum": 3,
"taskSuccessNum": 3,
"taskFailNum": 0,
"taskStatus": "TaskFinish",
"assetTypeId": 0,
"taskCost": 3,
"taskTime": 3,
"callbackUrl": "",
"server": "",
"sourceType": "pdf",
"targetType": "docx",
"tenantId": 1
}
],
"total": 528,
"size": 2,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"countId": null,
"maxLimit": null,
"pages": 264
}Task Status
| Status | Description |
|---|---|
| TaskStart | Task created successfully |
| TaskWaiting | Task waiting to be processed |
| TaskProcessing | Task is being processed |
| TaskFinish | Task processing completed |
| TaskOverdue | Task waiting timed out |