Service Center

Template Management

Can the template file generation API modify the file name?

Yes, pass the fileName parameter to set the output filename.

 

 

When setting the template, multiple controls are set to use the same control code and control name. Is it okay to only pass the value of one "fieldKey" for filling when calling the interface for generating files by filling in the template?

Yes, the specific steps are as follows: 

Step 1: Set the control names and control codes of multiple controls to be the same in the template setting. You can refer to the following figure:

模版设置-英文.png

Step 2: Call the interface for generating files by filling in the template. For the parameters passed in, you can refer to the following:

 {
            "fieldKey": "secondPartName",
            "fieldValue": "fengnian"
        }

 

Query the file synthesis task through the taskId, and the prompt shows "File conversion failed: Network address access failed"

When the document conversion times out, it will often lead to the failure of file synthesis. At this time, you can call the template again to generate the file, and then call the interface for querying the file synthesis task to check whether the file synthesis is successful this time. If the file synthesis still fails after the above operations, then you can directly contact the technical personnel, and let the professional technical personnel assist you in solving this problem.

 

 

How long is the downloadUrl from /esignglobal/v1/templates/fileFiling valid?

The generated file download link is valid for 60 minutes (only returned upon successful synthesis).

 

A table has been set in the template. After successfully invoking the interface for generating files based on the template, when invoking the interface for querying the details of the file synthesis task again, the message "not match: XXX" is reported. (How to synthesize the template file when the template is filled with a dynamic table?)

Step 1: Log in to the web terminal first. Add a dynamic table to the added templates in the template management section, and then open the template after saving it successfully, as shown in the following figure:

动态表格-英文.png

Step 2: Call the API for generating files by filling in the template. For the specific parameters to be passed, please refer to the following script:

{
    "templateId": "xxxxxx",
    "callBackUrl": "http://xxxxxx",
    "fields": [
        {
            "fieldKey": "vsTextField",
            "fieldId": "a73a0780b71243c78b8088d24af2232b",
            "fieldValue": "Harry"
        },
        {
            "fieldKey": "vsDynamicTable",
            "fieldId": "db431e8e945348e3a168002d84ca62be",
            "fieldValue": "[{\"row\":{\"column1\":\"Name\",\"column2\":\"Contact number\",\"column3\":\"Home address\",\"column4\":\"Health status\"}},{\"row\":{\"column1\":\"\",\"column2\":\"\",\"column3\":\"\"}},{\"row\":{\"column1\":\"\",\"column2\":\"\",\"column3\":\"\"}}]"
        }
    ]
}