Get Document Generation Details

GET /esignglobal/v1/templates/renderTask

Interface Description

Query the document generation details.

Request Parameters

Parameter

Type

Required

Description

taskId

string

true

Document generation task id

Request Example

{
    "taskId": "ccecc62f55a64733a028cb08b406f1b7"
}

Responses

参数名称

类型

说明

taskId

string

Document generation task id

taskStatus

string

Document Generation Status
1-In Progress
2-Succeed
3-Failed

description

string

The reason for the generation failure, returned only when the TaskStatus is 3.

fileKey

string

The ID of the document generated, returned only when the TaskStatus is 2.

downloadUrl

string

The download address of the document generated (valid for 60 minutes).

fields

arrayField Information
 

fieldId

stringField ID
 

fieldKey

stringField Key
 

fieldName

stringField Name
 

fieldType

intField Type:
25-Signature
26-Stamp
 

fieldConfigs

objectField Settings
  

pageNo

stringPage number of the field.
  

posX

floatX-axis coordinate
  

posY

floatY-axis coordinate
  

height

floatHeight of the field.
  

width

floatWidth of the field.

Response Example

{
    "code": "0",
    "data": {
        "downloadUrl": "https://global-dev.s3.cn-northwest-1.amazonaws.Com.cn/epaas-docedit/9c4aa968-92a3-4346-8a33-528e584f79d4/pdf%20%E5%9B%BE%E7%89%87%E8%B5%84%E6%BA%90%E6%89%BE%E4%B8%8D%E5%88%B0bug%E9%AA%8C%E8%AF%81.pdf?response-content-disposition=attachment&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIASKKKTSYU5RW7YI4L%2F20240830%2Fcn-northwest-1%2Fs3%2Faws4_request&X-Amz-Date=20240830T091607Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=c7bc64eacd705af6144e3aafe7c4507ac79518d25cc95e7654c87e89b836047f",
        "fileKey": "$9cd40d42-b472-479c-bf3c-93ed8efc2863$3429580140",
        "taskId": "ccecc62f55a64733a028cb08b406f1b7",
        "taskStatus": "2"
    },
    "message": "success"
}

 

Interface Description
Request Parameters
Request Example
Responses
Response Example