文档变更
原接口的中文名称由“添加输入项组件”变更为“添加填写控件”，其接口功能未做调整。
接口描述
通过 templateId 模板ID向PDF模板文件中添加填写控件，以便后续通过这些填写控件来填充内容。
接口地址&请求方式
接口地址：/v1/docTemplates/{templateId}/components
请求方式：POST
请求头格式
具体请求头格式结构，请点击查看公共参数说明。
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数类型 | 参数说明 （左右拖动查看完整描述） | |||
templateId | string | 是 | path | 模板id | |||
structComponent | array | 是 | body | ||||
id | string | 否 | body | 输入项组件id，使用时可用id填充，为空时表示添加，不为空时表示修改 | |||
key | string | 否 | body | 模板下输入项组件唯一标识，使用模板时也可用根据key值填充 | |||
type | int | 是 | body | 输入项组件类型，1-单行文本，2-数字，3-日期，8-多行文本，11-图片，不支持修改 | |||
context | object | 是 | body | 输入项组件上下文信息，包含了名称，填充格式，样式以及坐标 | |||
label | string | 是 | body | 输入项组件显示名称 | |||
required | boolean | 否 | body | 是否必填，默认true | |||
limit | string | 否 | body | 输入项组件type=2，type=3时填充格式校验规则 数字格式：
日期格式：
| |||
style | object | 是 | body | 输入项组件样式 | |||
width | float | 是 | body | 输入项组件宽度 | |||
height | float | 是 | body | 输入项组件高度 | |||
font | int | 否 | body | 填充字体,默认1，1-宋体，2-新宋体，4-黑体，5-楷体 | |||
fontSize | float | 否 | body | 填充字体大小,默认12 | |||
textColor | string | 否 | body | 字体颜色，默认#000000黑色 | |||
pos | object | 是 | body | 输入项组件坐标 | |||
page | int | 是 | body | 页码 | |||
x | float | 是 | body | x轴坐标，左下角为原点 | |||
y | float | 是 | body | y轴坐标，左下角为原点 | |||
响应参数
参数名称 | 类型 | 必选 | 参数说明 （左右拖动查看完整描述） |
code | int | 是 | 业务码，0表示成功 |
message | string | 否 | 业务信息 |
data | array | 否 | 添加/编辑的输入项组件id列表 |
请求示例
{
"structComponent":[
{
"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
}
}
}
]
}响应示例
{
"code": 0,
"data": ["dfadfasdadasdfasdfsadfsadf"],
"message": "成功"
}
我要纠错