创建控件组

更新时间：2025-10-30 16:19:15

接口描述

为自定义控件创建分组，让控件可以分组显示。同类的自定义控件可以放到一个分组里。

添加了自定义控件组的模板制作页面样式参考（使用【获取制作合同模板页面】接口制作模板）：

注意：

开发者在当前appId下，最多可以创建 1000个自定义控件组。
该接口自2024年3月28日起放开对componentGroupName（控件组名称）唯一性的校验。

接口地址&请求方法

接口地址：https://{host}/v3/custom-component-group/create

请求方法：POST

请求头格式

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

请求参数

展开全部参数参数名称		参数类型	必选	参数位置	参数说明
componentGroupName		string	是	body	控件组名称
componentGroupOrder		int	否	body	控件组展示顺序（默认：1）指定数字：0-999，从小到大排序若不传，默认按创建时间正序排序
components		array	是	body	控件列表
	componentId	string	是	body	控件ID

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。
data		object	否	业务信息
	componentGroupId	string	否	控件组ID

请求示例

{
    "componentGroupName": "控件1组",
    "componentGroupOrder": 1,
    "components": [
        {
            "componentId": "07301790******3ebf0dd3"
        },
        {
            "componentId": "4d1ee2c9*****2bb12da0547e"
        }
    ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "componentGroupId": "08cec5*****4de815f7ff3c"
    }
}

错误码

code 错误码	message 错误信息	解决方案
1430002	参数错误	检查对应的参数是否符合格式
1430722	控件不存在	检查下输入的控件ID是否是当前appId下创建，是否真实存在
1430012	服务异常	检查接口整体的参数格式是否正确