添加输入项组件

接口描述:保存文件模板输入项组件,添加组件前需先上传文件

接口地址:/v1/docTemplates/{templateId}/components

请求方式: POST

请求参数:

参数名 参数类型 必选 类型 说明
templateId path string 模板id
structComponent body array
id body string 输入项组件id,使用时可用id填充,为空时表示添加,不为空时表示修改
key body string 模板下输入项组件唯一标识,使用模板时也可用根据key值填充
type body int 输入项组件类型,1-文本,2-数字,3-日期,6-签约区
context body object 输入项组件上下文信息,包含了名称,填充格式,样式以及坐标
label body string 输入项组件显示名称
required body boolean 是否必填,默认true
limit body string 输入项组件type=2,type=3时填充格式校验规则;数字格式如:#,#00.0# 日期格式如: yyyy-MM-dd
style body object 输入项组件样式
width body float 输入项组件宽度
height body float 输入项组件高度
font body int 填充字体,默认1,1-宋体,2-新宋体,3-微软雅黑,4-黑体,5-楷体
fontSize body float 填充字体大小,默认12
textColor body string 字体颜色,默认#000000黑色
pos body object 输入项组件坐标
page body int 页码
x body float x轴坐标,左下角为原点
y body float y轴坐标,左下角为原点

请求示例

POST https://openapi.esign.cn/v1/docTemplates/{templateId}/components
{
    "structComponents":[
        {
            "id":"45dd9420690b460c9e5ed55b40d7d0f8",
            "key":"key001",
            "type":1,
            "context":{
                "label":"身份证号码",
                "limit":"yyyy-MM-dd",
                "required":true,
                "style":{
                    "font":1,
                    "fontSize":11,
                    "textColor":"#000000",
                    "width":11.11,
                    "height":11.11
                },
                "pos":{
                    "x":11.11,
                    "y":11.11,
                    "page":1
                }
            }
        }
    ]
}

响应参数

参数名 类型 说明
data array 添加/编辑的输入项组件id列表

响应示例

{
    "code": 0,
    "data": ["dfadfasdadasdfasdfsadfsadf"],
    "message": "成功"
}

错误码

错误码 错误信息 错误原因

results matching ""

    No results matching ""