Documentation

3.3.1 Get task information

Request task status and file-related metadata based on the task ID.

Request method

• request method: GET
• parameter transfer method: Query

Request parameter

parameter name	data type	description	required
taskId	String	task id	yes

Request address

https://api-cn-east-1.17pdf.com/server/v1/task/taskInfo?taskId='135e8570-6377-4660-94d2-867952796f2c'

Return parameter

return parameter	data type	description
taskId	String	task id
taskFileNum	Integer	number of task files
taskSuccessNum	String	number of successes
taskFailNum	String	number of failures
taskStatus	String	task status
assetTypeId	String	Use Asset Type
taskCost	String	task cost
taskTime	Long	task duration
sourceType	Long	source file format
targetType	Long	target file format
fileInfoDTOList	List	task file information

"code": "200",
"msg": "success",
"data": {
    "taskId": "f416dbcf-0c10-4f93-ab9e-a835c1f5dba1",
    "taskFileNum": 1,
    "taskSuccessNum": 1,
    "taskFailNum": 0,
    "taskStatus": "TaskFinish",
    "assetTypeId": 0,
    "taskCost": 1,
    "taskTime": 1,
    "sourceType": "pdf",
    "targetType": "docx",
    "fileInfoDTOList": [
      {
        "fileKey": "ba13a2a8-1278-43d4-a9a6-7ecc28a0804f",
        "taskId": "f416dbcf-0c10-4f93-ab9e-a835c1f5dba1",
        "fileName": "test.pdf",
        "downFileName": "test.docx",
        "fileUrl": "https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/test.pdf",
        "downloadUrl": "https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/test.docx",
        "sourceType": "pdf",
        "targetType": "docx",
        "fileSize": 24475,
        "convertSize": 6922,
        "convertTime": 8,
        "status": "success",
        "failureCode": "",
        "failureReason": "",
        "fileParameter": "{    \"pageOptions\": \"3\"}"
      }
    ]
}

Note:

taskStatus ：Task processing status

status	description
TaskStart	Task created successfully
TaskWaiting	Task waiting for processing
TaskProcessing	The task is being processed
TaskFinish	Task processing completed
TaskOverdue	Task waiting for processing timeout

Get asset details

Get the remaining assets of the current user.

Request method

• request method:GET
• parameter transfer mode:Query

Request address

https://api-cn-east-1.17pdf.com/server/v1/asset/info

Return parameter

return parameter	data type	description
tenantAsset	List	asset Information
assetTypeName	String	asset Type
asset	Integer	asset balance
withholdingAsset	Integer	total withholding assets

"code": "200",
"msg": "success",
"data": {
    "tenantAsset": [
      {
        "assetTypeName": "SUBSCRIPTIONS",
        "asset": 12,
        "withholdingAsset": 0
      },
      {
        "assetTypeName": "PACKAGES",
        "asset": 1,
        "withholdingAsset": 0
      }
    ]
}

Request the current user file transfer task list

Request the current user file transfer task list.

Request method

• request method:GET
• parameter transfer mode:Query

Request parameter

• page:Pagination - current number of pages, not required, default to 1 if not filled
• size:Pagination - the number of items displayed on the page, not required, the default is 10 if not filled

parameter name	data type	description	required
page	Long	current page	no（If not filled, the default is 1）
size	Long	number of pages	no（If not filled, the default is 10）

Request address

https://api-cn-east-1.17pdf.com/server/v1/task/list

Return parameter

return parameter	data type	description
createdBy	String	founder
updatedBy	String	updater
creationTime	LocalDateTime	creation time
updateTime	LocalDateTime	update time
id	Long	task primary key id
taskId	String	task id
taskUrl	taskUrl	task original folder
taskLoadUrl	String	task conversion folder
taskFileNum	Integer	number of task files
taskSuccessNum	Integer	number of successes
taskFailNum	Integer	number of failures
taskStatus	String	task status
assetTypeId	Integer	working with asset types
taskCost	Integer	task cost
taskTime	Long	task duration
callbackUrl	String	callback address
server	String	server address
sourceType	String	source file format
targetType	String	target file format
tenantId	Long	tenant id

{
    "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
}