form表单说明

单行文本/多行文本

项目	内容
类型	`singleline_text`、`multiline_text`
value值	String值，文本内容
备注	`singleline_text`限制100字 `multiline_text`限制2000字
说明	Form组件传值示例如下图：module_name传飞书合同的页签的描述，attribute_name传字段的描述，attribute_value传字段的值
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	//name匹配 { "module_name": "文本测试模块", "attribute_name": "合同备注", "attribute_value": "测试多行文本\n 第二行" } //code匹配 { "attribute_code": "custom_2_0c09c6daeebf4a3f938a07aa8082d85f", "attribute_value": "测试多行文本\n 第二行" }

日期

项目	内容
类型	`date`
value值	String值，格式为yyyy-MM-dd
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	//name匹配 { "module_name": "日期模块", "attribute_name": "合同生效日期", "attribute_value": "2021-09-13" } //code匹配 { "attribute_code": "custom_10_6599409c7dc84b0d988a9d0965cbc5c6", "attribute_value": "2021-09-13" }

人员

项目	内容
类型	`employee`
value值	List数组
备注	当`user_id_type`为`lark_user_id`时，`user_id`传入飞书`user_id`
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	//name匹配 { "module_name": "测试模块", "attribute_name": "需求人", "attribute_value": [ { "user_id": "g62a2f83", "user_id_type": "lark_user_id" } ] } //code匹配 { "attribute_code": "custom_1001_fb5fb3c7555f45328f992b61805a24af", "attribute_value": [ { "user_id": "g62a2f83", "user_id_type": "lark_user_id" } ] }

部门

项目	内容
类型	`department`
value值	List数组
备注	当`department_id_type`为`open_department_id`时，`department_id`传入飞书`open_department_id`
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	//name匹配 { "module_name": "测试模块", "attribute_name": "所属部门", "attribute_value": [ { "department_id": "od-5cefe25147a103456cf21a63b1132ad", "department_id_type": "open_department_id" } ] } //code匹配 { "attribute_code": "custom_1002_fb5fb3c7555f45328f992b61805a24af", "attribute_value": [ { "department_id": "od-5cefe25147a103456cf21a63b1132ad", "department_id_type": "open_department_id" } ] }

下拉单选

项目	内容
类型	`dropdown_radio`
value值	key为飞书合同侧选项唯一标识
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "测试模块", "attribute_name": "产权归属", "attribute_value": { "key": "ckx36ksd8002j3f61rr2ifb22", "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } } // code匹配 { "attribute_code": "custom_15_ea0f468f2b7d4997b5228fa95b85605a", "attribute_value": { "key": "ckx36ksd8002j3f61rr2ifb22", "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } }

数字

项目	内容
类型	`number`
value值	Number值，数字
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "数字模块", "attribute_name": "数字示例", "attribute_value": 12345 } // code匹配 { "attribute_code": "custom_5_b5b96bd524e0497dbdea0aeed108691d", "attribute_value": 12345 }

日期区间

项目	内容
类型	`date_range`
value值	JSONObject值, "start_date", "end_date"为飞书合同侧选项唯一标识
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "日期区间模块", "attribute_name": "日期区间示例", "attribute_value": { "start_date": "2022-01-01", "end_date": "2022-03-31" } } // code匹配 { "attribute_code": "日期区间模块", "attribute_value": { "start_date": "2022-01-01", "end_date": "2022-03-31" } }

单选项

项目	内容
类型	`radio`
value值	JSONObject值, "key"为飞书合同侧选项唯一标识
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "单选项模块", "attribute_name": "单选项示例", "attribute_value": { "key": "cl14rj97o000b386dayuolv3t", "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } } // name匹配 { "module_name": "custom_13_fb5fb3c7555f45328f992b61805a24af", "attribute_value": { "key": "cl14rj97o000b386dayuolv3t", "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } }

多选项

项目	内容
类型	`checkbox`
value值	JSONObject值，"key"为飞书合同侧选项唯一标识
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "多选项模块", "attribute_name": "多选项示例", "attribute_value": { "key": [ "cl14rj97o000b386dayuolv3t", "cl162uqx6000k386d5gn09eh3" ], "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } } // code匹配 { "attribute_code": "custom_14_fb5fb3c7555f45328f992b61805a24af", "attribute_value": { "key": [ "cl14rj97o000b386dayuolv3t", "cl162uqx6000k386d5gn09eh3" ], "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } }

下拉多选

项目	内容
类型	`dropdown_option`
value值	JSONObject值，"key"为飞书合同侧选项唯一标识
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "下拉多选模块", "attribute_name": "下拉多选示例", "attribute_value": { "key": [ "cl14rj97o000b386dayuolv3t", "cl162uqx6000k386d5gn09eh3" ], "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } } // code匹配 { "attribute_code": "custom_16_97441b4066074f67bc8de251a0110b4b", "attribute_value": { "key": [ "cl14rj97o000b386dayuolv3t", "cl162uqx6000k386d5gn09eh3" ], "outbound_options": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": [ { "value": "value", "labelCn": "中文名", "labelEn": "英文名", "labelJp": "日文名", "children": null } ] } ] } }

金额

项目	内容
类型	`amount`
value值	JSONObject值
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "金额模块", "attribute_name": "金额示例", "attribute_value": { "amount": "123.33", "currency": "CNY" } } // code匹配 { "attribute_code": "custom_1012_3cbb86bb39a548d78b51586573fccd6d", "attribute_value": { "amount": "123.33", "currency": "CNY" } }

超链接

项目	内容
类型	`hyperlink`
value值	JSONObject值
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "module_name": "基础信息", "attribute_name": "链接示例", "attribute_value": { "title": "百度", "url": "www.baidu.com" } } // code匹配 { "attribute_code": "custom_1012_3cbb86bb39a548d78b51586573fccd6d", "attribute_value": { "title": "百度", "url": "www.baidu.com" } }

国家地区

项目	内容
类型	`country_or_region`
value值	List数组值
备注	- country_code：国家地区编码 https://s.apifox.cn/e96c2a43-4dd5-4155-813f-1d6737fe3cb2
举例（支持name匹配和code匹配，传入时优先选择code匹配字段）	// name匹配 { "attribute_name": "国家地区模块", "module_name": "国家地区", "attribute_value": [ { "country_code": "US" } ] }

树形单选

字段说明

字段项	值
类型	`tree_radio`
`attribute_type`	`tree_radio`
`attribute_value`	`JSONObject`

attribute_value 结构说明

字段	类型	说明
`name`	`string`	当前选中节点名称
`key`	`string`	当前选中节点唯一标识

示例
json
{
"attribute_key": "custom_17_da23e91ff85a49948743ee282a69ea2f",
"attribute_code": "custom_17_da23e91ff85a49948743ee282a69ea2f",
"attribute_name": "树形单选示例",
"attribute_type": "tree_radio",
"module_name": "树形单选模块",
"attribute_value": {
"name": "法务子一",
"key": "ckzz5rwyk004l3h69p3lorjxc"
}
}

树形多选

字段说明

字段项	值
类型	`tree_option`
`attribute_type`	`tree_option`
`attribute_value`	`List` 数组

attribute_value 结构说明

attribute_value 为对象数组，每个对象表示一个已选中的树节点。

字段	类型	说明
`name`	`string`	当前选中节点名称
`key`	`string`	当前选中节点唯一标识

示例
json
{
"attribute_key": "custom_18_da23e91ff85a49948743ee282a69ea2f",
"attribute_code": "custom_18_da23e91ff85a49948743ee282a69ea2f",
"attribute_name": "树形多选示例",
"attribute_type": "tree_option",
"module_name": "树形多选模块",
"attribute_value": [
{
"name": "法务子一",
"key": "ckzz5rwyk004l3h69p3lorjxc"
},
{
"name": "财务子一",
"key": "ckzz5s3hg00563h69lmnh16h8"
}
]
}

公式

字段说明

字段项	值
类型	`calculation`
`attribute_type`	`calculation`
`attribute_value`	`Number` 数值

attribute_value 说明

attribute_value 为公式计算后的数值结果。

字段	类型	说明
`attribute_value`	`number`	公式计算结果，可为整数或小数

示例

json
{
"attribute_key": "custom_1027_da23e91ff85a49948743ee282a69ea2f",
"attribute_code": "custom_1027_da23e91ff85a49948743ee282a69ea2f",
"attribute_name": "公式示例",
"attribute_type": "calculation",
"module_name": "公式模块",
"attribute_value": 1234.56
}

附件

字段说明

字段项	值
类型	`file`
`attribute_type`	`file`
`attribute_value`	`List` 数组

attribute_value 结构说明

attribute_value 为附件对象数组，每个对象表示一个附件文件。

字段	类型	说明
`file_id`	`string`	文件 ID
`file_name`	`string`	文件名称
`file_size`	`string`	文件大小，单位 B
`mime`	`string`	文件 MIME 类型

示例
json
{
"attribute_key": "custom_21_d70049a4d6dc443fbe4c42f19c575339",
"attribute_code": "custom_21_d70049a4d6dc443fbe4c42f19c575339",
"attribute_name": "表格附件字段",
"attribute_type": "file",
"module_name": "附件模块",
"attribute_value": [
{
"file_id": "7113067054747500588",
"file_name": "表格1.xlsx",
"file_size": "8811",
"mime": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
},
{
"file_id": "7113067054747533356",
"file_name": "表格2.xlsx",
"file_size": "31428",
"mime": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}
]
}

明细字段

字段说明

字段项	值
类型	`array`
示例中的 `attribute_type`	`common_array`
`attribute_value`	数组值

结构说明

明细字段通常为多层数组结构：

最外层数组：字段对象列表。

字段对象的 attribute_value：明细行数组。

每一行明细：一个数组，数组中的每个元素表示该行中的一个字段对象。

行内字段对象：结构与普通字段一致，包含 attribute_key、attribute_code、attribute_name、attribute_type、module_name、attribute_value 等属性。

明细行内字段对象通用结构

字段	类型	说明
`attribute_key`	`string`	字段唯一标识
`attribute_code`	`string`	字段编码
`attribute_name`	`string`	字段名称
`attribute_type`	`string`	子字段类型
`module_name`	`string`	所属模块名称
`attribute_value`	`any`	子字段值，具体结构取决于子字段类型

示例
json
[
{
"attribute_key": "custom_1201_4b5f416e5473428a9cd0c6aa60558964",
"attribute_code": "custom_1201_4b5f416e5473428a9cd0c6aa60558964",
"attribute_name": "明细字段",
"attribute_type": "common_array",
"module_name": "基础信息",
"attribute_value": [
[
{
"attribute_key": "custom_1_6f93c09e342848b895e54240684cee25",
"attribute_code": "custom_1_6f93c09e342848b895e54240684cee25",
"attribute_name": "单行文本明细",
"attribute_type": "singleline_text",
"module_name": "基础信息",
"attribute_value": "555555"
},
{
"attribute_key": "custom_5_2615eadf0db54c80b8d9cf7a1d4e01c3",
"attribute_code": "custom_5_2615eadf0db54c80b8d9cf7a1d4e01c3",
"attribute_name": "数字明细",
"attribute_type": "number",
"module_name": "基础信息",
"attribute_value": 8888888
},
{
"attribute_key": "custom_16_34da29dad2e54b998829a3a2bb024d78",
"attribute_code": "custom_16_34da29dad2e54b998829a3a2bb024d78",
"attribute_name": "下拉多选明细",
"attribute_type": "dropdown_option",
"module_name": "基础信息",
"attribute_value": [
{
"name": "65",
"key": "ckzw3o1rm000o3968qjkdobxv"
}
]
},
{
"attribute_key": "custom_1001_985e630cd9be41b2a3f159cb2e9e91b2",
"attribute_code": "custom_1001_985e630cd9be41b2a3f159cb2e9e91b2",
"attribute_name": "人员明细",
"attribute_type": "employee",
"module_name": "基础信息",
"attribute_value": [
{
"name": "李紫燕",
"user_id": "f742g11e"
}
]
},
{
"attribute_key": "custom_1012_e1e5c5fb753b4e0db8f1eeb387b5dfe8",
"attribute_code": "custom_1012_e1e5c5fb753b4e0db8f1eeb387b5dfe8",
"attribute_name": "金额明细",
"attribute_type": "amount",
"module_name": "基础信息",
"attribute_value": {
"amount": "666666666",
"currency": "CNY",
"currency_name": "CNY-人民币元"
}
}
]
]
}
]

合同创建Form组件说明

form表单说明#

单行文本/多行文本#

日期#

人员#

部门#

下拉单选#

数字#

日期区间#

单选项#

多选项#

下拉多选#

金额#

超链接#

国家地区#

树形单选#

树形多选#

公式#

附件#

明细字段#

form表单说明

单行文本/多行文本

日期

人员

部门

下拉单选

数字

日期区间

单选项

多选项

下拉多选

金额

超链接

国家地区

树形单选

树形多选

公式

附件

明细字段