接口描述
编辑已经存在的控件组ID对应的控件列表:
- 控件ID列表必须传入(按传入的控件ID列表覆盖原有控件);
- 控件组名称非必传,传入即修改,不传则保持原有名称不变(如果仅调整控件组名名称,不想改变控件列表,建议使用【重命名控件组】接口)。
接口地址&请求方法
接口地址:https://{host}/v3/custom-component-group/update
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
componentGroupId | string | 是 | body | 控件组ID | |
componentGroupName | string | 否 | body | 控件组名称 | |
componentGroupOrder | int | 否 | body | 控件组展示顺序
| |
components | array | 是 | body | 控件ID列表 注:如果传入components空数组,对应清空控件组内所有控件 | |
componentId | string | 否 | body | 控件ID |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 |
请求示例
{
"componentGroupId":"6c580301*****e19719",
"componentGroupName": "修改的控件组名称",
"components": [
{
"componentId": "18978******3b557d2f"
},
{
"componentId": "d7ada*******7cf87e"
}
]
}
响应示例
{
"code": 0,
"message": "成功",
"data": null
}
错误码
code 错误码 | message 错误信息 | 解决方案 |
1430002 | 参数错误 | 检查对应的参数是否符合格式 |
1430724 | 控件组不存在 | 检查下输入的控件组ID是否是当前appId下创建,是否真实存在 |
1430012 | 服务异常 | 检查接口整体的参数格式是否正确 |