获取任务列表
查询当前用户的文件处理任务列表。可通过分页参数浏览历史任务,并查看任务状态、费用、源文件类型、目标文件类型等任务级元数据。
请求方法
- 请求方法:GET
- 参数传递方式:Query
请求参数
| 参数 | 数据类型 | 说明 | 必填项 |
|---|---|---|---|
| page | Long | 当前页数 | 否(不填默认为 1) |
| size | Long | 每页显示项数 | 否(不填默认为 10) |
请求地址
https://api-server.compdf.com/server/v2/task/list
返回参数
| 参数 | 数据类型 | 说明 |
|---|---|---|
| records | Array | 当前页任务记录 |
| total | Long | 总记录数 |
| size | Long | 每页显示项数 |
| current | Long | 当前页数 |
| pages | Long | 总页数 |
| createdBy | String | 创建者 |
| updatedBy | String | 更新者 |
| creationTime | LocalDateTime | 创建时间 |
| updateTime | LocalDateTime | 更新时间 |
| id | Long | 任务主键 ID |
| taskId | String | 任务 ID |
| taskUrl | String | 任务原始文件夹 |
| taskLoadUrl | String | 任务转换文件夹 |
| taskFileNum | Integer | 任务文件数 |
| taskSuccessNum | Integer | 成功文件数 |
| taskFailNum | Integer | 失败文件数 |
| taskStatus | String | 任务状态 |
| assetTypeId | Integer | 使用资产类型 |
| taskCost | Integer | 任务成本 |
| taskTime | Long | 任务持续时间 |
| callbackUrl | String | 回调地址 |
| server | String | 服务器地址 |
| sourceType | String | 源文件格式 |
| targetType | String | 目标文件格式 |
| tenantId | Long | 租户 ID |
返回示例
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
}任务状态
| 状态内容 | 状态描述 |
|---|---|
| TaskStart | 任务创建成功 |
| TaskWaiting | 任务等待处理 |
| TaskProcessing | 任务开始处理中 |
| TaskFinish | 任务处理完成 |
| TaskOverdue | 任务等待处理超时 |