接口描述
通过此接口进行修改自定义业务控件的控件名称。
接口地址&请求方法
接口地址:https://{host}/v3/custom-components/rename
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
componentId | string | 是 | body | 控件ID |
componentName | string | 是 | body | 控件名称 |
customBizNum | string | 否 | body | 自定义业务编码 (可用于查询,需开发者自行控制唯一性) |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 |
请求示例
{
"componentId": "9e2d9b4******c0eef4ba5059",
"componentName":"改的自定义控件名称"
}
响应示例
{
"code": 0,
"message": "成功",
"data": null
}
错误码
code 错误码 | message 错误信息 | 解决方案 |
1430002 | 参数错误 | 检查对应的参数是否符合格式 |
1430722 | %S控件不存在 | 检查下输入的控件ID是否是当前appId下创建,是否真实存在 |
1430012 | 服务异常 | 检查接口整体的参数格式是否正确 |