Skip to content
ComPDF

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

ParameterData typeDescriptionRequired
pageLongCurrent page numberNo (defaults to 1)
sizeLongItems per pageNo (defaults to 10)

Request URL

https://api-server.compdf.com/server/v2/task/list

Response Parameters

ParameterData typeDescription
recordsArrayTask records on the current page
totalLongTotal number of records
sizeLongItems per page
currentLongCurrent page number
pagesLongTotal page count
createdByStringCreator
updatedByStringUpdater
creationTimeLocalDateTimeCreation time
updateTimeLocalDateTimeUpdate time
idLongTask primary key ID
taskIdStringTask ID
taskUrlStringOriginal task file folder
taskLoadUrlStringConverted task file folder
taskFileNumIntegerNumber of files in the task
taskSuccessNumIntegerNumber of successful files
taskFailNumIntegerNumber of failed files
taskStatusStringTask status
assetTypeIdIntegerAsset type used
taskCostIntegerTask cost
taskTimeLongTask duration
callbackUrlStringCallback URL
serverStringServer address
sourceTypeStringSource file format
targetTypeStringTarget file format
tenantIdLongTenant 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

StatusDescription
TaskStartTask created successfully
TaskWaitingTask waiting to be processed
TaskProcessingTask is being processed
TaskFinishTask processing completed
TaskOverdueTask waiting timed out