查询合同模板中控件详情

更新时间:2024-10-28 20:15:00

接口描述

通过合同模板 docTemplateId 来获取模板中设置的所有控件信息,后续可通过【填写模板生成文件】接口来填充模板。

接口地址&请求方法

接口地址:https://{host}/v3/doc-templates/{docTemplateId}

请求方法:GET

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

docTemplateId

string

path

合同模板ID(通过【获取制作文件模板页面链接】接口获取)

响应参数

展开全部参数参数名称

参数类型

必选

参数说明(左右拖动查看完整描述)

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据

docTemplateId

string

合同模板ID

docTemplateName

string

合同模板名称

createTime

int64

合同模板创建时间(Unix时间戳格式,单位:毫秒)

updateTime

int64

合同模板更新时间(Unix时间戳格式,单位:毫秒)

fileDownloadUrl

string

合同模板的底稿PDF文件下载链接

  • 链接有效期为60分钟
  • 当模板类型为html模板时,默认会返回 null

components(点击“+”展开详情)

array

模板中的控件列表信息

componentId

string

控件ID(设置合同文件模板时由e签宝系统生成)

componentKey

string

控件Key(设置合同文件模板时由用户自定义)

componentName

string

控件名称

required

boolean

控件是否必填

true - 必填,false - 非必填

componentType

int32

控件类型

1 - 单行文本,2 - 数字,3 - 日期,6 - 签章区域,8 - 多行文本,9 - 复选,10 - 单选,11 - 图片,14 -下拉框,15 - 勾选框,16 - 身份证,17 - 备注区域,18 - 动态表格,19 - 手机号

componentPosition

object

控件位置信息

componentPositionX

float

控件位置X横坐标

componentPositionY

float

控件位置Y纵坐标

componentPageNum

int32

控件所在页码

componentSpecialAttribute

object

控件特有属性

dateFormat

string

日期格式(日期控件特有)

imageType

string

图片类型(图片控件特有)

IDCard_widthwise(身份证横向,等比缩放大小)

IDCard_longitudinal(身份证纵向,等比缩放大小)

other (其他,自由缩放大小)

options(点击“+”展开详情)

array

选项(下拉框控件、单选控件、多选控件特有)

optionContent

string

选项内容

optionOrder

int32

选项顺序

selected

boolean

选项是否默认选中

tableContent

array

表格行列内容(动态表格控件特有),格式:

[row{"column1":"value1","column2":"value2"}]

补充说明:

  • row 表示动态表格对应的行,row的个数依据模板动态表格控件中所添加的所添加的行数。
  • column1 表示当前行中单元格的Key值
  • value1 表示当前行中单元格的Value值,单元格未设置固定值时为""空字符串,否则为所设置的固定值。
  • 详见 tableContent 解释说明

numberFormat

string

数字格式(数字控件特有),格式如下:

0 - 整数,0.0 - 保留一位小数,0.00 - 保留两位小数

componentMaxLength

string

可填充的长度上限,单位:中文字符

【注】1个中文字符=2个英文字符;

(仅适用于制作PDF模板时,返回此参数)

componentMaxRows

string

多行文本控件可以填充的行数上限

【注】按最小字体 + 行间距计算

(仅适用于制作PDF模板时,返回此参数)

signerRole

string

签署方角色标识(签署区控件)

componentSize

object

控件尺寸

componentWidth

float

控件宽度(矩形的左右距离,单位为px)

componentHeight

float

控件高度(矩形的上下距离,单位为px)

normalSignField

object

签章区属性

showSignDate

int32

是否显示签署日期

0 - 不显示,1 - 显示

dateFormat

string

日期格式,支持以下日期格式:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

yyyy-MM-dd HH:mm:ss

signFieldStyle

int32

签章样式

1 - 单页签章,2 - 骑缝签章

sealSpecs

int32

落章规则

1 - 以实际印章规格加盖

2 - 自定义印章规格加盖(根据指定的签署区宽高适配)

remarkSignField

object

备注区属性

aiCheck

int32

是否开启手写抄录AI校验

0 - 不开启,1 - 开启 AI 校验,2 - 强制 AI 校验

inputType

int32

备注文字输入方式

1 - 手写抄录方式,2 - 自由输入方式

remarkContent

string

预设手写抄录信息

remarkFontSize

string

备注文字的字号,单位pt,默认值12pt

注:签署侧需要的字号单位是px,模板侧通用的都是pt,因此要做一次转换;pt与px间的换算关系是:0.75px=1pt

originCustomComponentId

string

自定义控件ID

【获取制作文件模板页面链接】接口传入的自定义控件ID值)

componentTextFormat

object

控件字符样式

font

int32

填充字体,默认:1

1 - 宋体

2 - 新宋体

4 - 黑体

5 - 楷体

fontSize

float

填充字体大小,默认:12.0

42 - 初号

36 - 小初

26 - 一号

24 - 小一

22 - 二号

19 - 小二

16 - 三号

15 - 小三

14 - 四号

12 - 小四

10.5 - 五号

9 - 小五

textColor

string

字体颜色,默认:#000000

#000000 - 黑色

bold

boolean

是否加粗,默认:false

true - 是

false - 否

italic

boolean

是否斜体,默认:false

true - 是

false - 否

horizontalAlignment

string

水平对齐,默认:LEFT

LEFT - 左对齐

CENTER - 居中对齐

RIGHT - 右对齐

verticalAlignment

string

垂直对齐,默认:TOP(适用于多行文本)

TOP - 顶对齐

MIDDLE - 居中对齐

BOTTOM - 底对齐

textLineSpacing

float

行间距,默认:1.0 (适用于多行文本)

最多支持一位小数,最大值为:2.0

请求示例

GET https://openapi.esign.cn/v3/doc-templates/061778***701b7

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "docTemplateId": "f4821f6d1b11111111473df37fdda61",
        "docTemplateName": "test.pdf",
        "createTime": 1729063233000,
        "updateTime": 1729063233000,
        "fileDownloadUrl": "https://esignoss.esign.cn/1111564182/9ce8ea48-33c6-420e-8e00-b3f6ecb3b330/test.pdf?Expires=1729737297&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=fMze4GEojjH8V3xW8LISgr7uW48%3D",
        "components": [
            {
                "componentId": "b9b2a27511111420769a3ca1ca",
                "componentKey": null,
                "componentName": "签署区",
                "required": false,
                "componentType": 6,
                "componentDefaultValue": null,
                "componentPosition": {
                    "componentPositionX": 99.03,
                    "componentPositionY": 775.47,
                    "componentPageNum": 1
                },
                "componentSpecialAttribute": {
                    "dateFormat": null,
                    "imageType": null,
                    "options": null,
                    "tableContent": null,
                    "numberFormat": null,
                    "componentMaxLength": null,
                    "componentMaxRows": null,
                    "signerRole": null
                },
                "componentSize": {
                    "componentWidth": 100,
                    "componentHeight": 100
                },
                "remarkSignField": null,
                "normalSignField": {
                    "showSignDate": 0,
                    "dateFormat": null,
                    "signFieldStyle": 1,
                    "sealSpecs": 1
                },
                "originCustomComponentId": null,
                "componentOrder": 1,
                "componentTextFormat": {
                    "font": 1,
                    "fontSize": 12.0,
                    "textColor": "#000000",
                    "bold": false,
                    "italic": false,
                    "horizontalAlignment": "LEFT",
                    "verticalAlignment": "TOP",
                    "textLineSpacing": 1.0
                }
            },
            {
                "componentId": "31baa6511111588c9091515281fecf",
                "componentKey": null,
                "componentName": "备注签署区",
                "required": false,
                "componentType": 17,
                "componentDefaultValue": null,
                "componentPosition": {
                    "componentPositionX": 454.19,
                    "componentPositionY": 744.89,
                    "componentPageNum": 1
                },
                "componentSpecialAttribute": {
                    "dateFormat": null,
                    "imageType": null,
                    "options": null,
                    "tableContent": null,
                    "numberFormat": null,
                    "componentMaxLength": null,
                    "componentMaxRows": null,
                    "signerRole": null
                },
                "componentSize": {
                    "componentWidth": 189,
                    "componentHeight": 51
                },
                "remarkSignField": {
                    "inputType": 1,
                    "aiCheck": 0,
                    "remarkContent": "11111",
                    "remarkFontSize": 12
                },
                "normalSignField": null,
                "originCustomComponentId": null,
                "componentOrder": 2,
                "componentTextFormat": {
                    "font": 1,
                    "fontSize": 12.0,
                    "textColor": "#000000",
                    "bold": false,
                    "italic": false,
                    "horizontalAlignment": "LEFT",
                    "verticalAlignment": "TOP",
                    "textLineSpacing": 1.0
                }
            },
            {
                "componentId": "15cb81111119796fdc6d860f",
                "componentKey": null,
                "componentName": "单行文本",
                "required": true,
                "componentType": 1,
                "componentDefaultValue": null,
                "componentPosition": {
                    "componentPositionX": 378.01,
                    "componentPositionY": 800.08,
                    "componentPageNum": 1
                },
                "componentSpecialAttribute": {
                    "dateFormat": null,
                    "imageType": null,
                    "options": null,
                    "tableContent": null,
                    "numberFormat": null,
                    "componentMaxLength": "20",
                    "componentMaxRows": null,
                    "signerRole": null
                },
                "componentSize": {
                    "componentWidth": 160,
                    "componentHeight": 15
                },
                "remarkSignField": null,
                "normalSignField": null,
                "originCustomComponentId": null,
                "componentOrder": 3,
                "componentTextFormat": {
                    "font": 1,
                    "fontSize": 12.0,
                    "textColor": "#000000",
                    "bold": false,
                    "italic": false,
                    "horizontalAlignment": "LEFT",
                    "verticalAlignment": "TOP",
                    "textLineSpacing": 1.0
                }
            }            
        ]
    }
}

错误码

点击查看错误码

我要纠错