YesDev
HTTP/HTTPS
请求协议
YesDev / WebAPI / 修改自定义字段
修改自定义字段
接口地址：https://www.yesdev.cn/api/platform.php?s=Platform.CustomField_CustomFieldSettings.UpdateCustomField
接口描述：//请使用@desc 注释
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| app_key | 字符串 | 可选 | app_key，团队代码 | ||
| sign | 字符串 | 可选 | - | 动态签名，签名算法请联系我们技术客服获取 | |
| id | 整型 | 必须 | - | 自定义字段ID | |
| field_label | 字符串 | 必须 | - | 自定义字段名称 | |
| field_control_type | 字符串 | 必须 | - | 字段类型 | |
| field_option_rules | 字符串 | 可选 | - | 字段选项规则 | |
| field_require | 整型 | 必须 | - | 是否为必填项 | |
| field_sort | 整型 | 可选 | - | 排序位置 | |
| field_visiable | 整型 | 可选 | 0 | 可见范围：0-全部；1-企业管理员 | |
| field_default | 字符串 | 可选 | - | 字段默认值 | |
| is_open | 整型 | 可选 | - | 是否开启：1-是；0-否 | |
| field_placeholder | 字符串 | 可选 | - | 字段占位符 | |
| allow_staff_ids | 字符串 | 可选 | - | 允许的员工ID，多个用英文逗号隔开 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| app_key | 可选 | |
| sign | 可选 | |
| id | 必须 | |
| field_label | 必须 | |
| field_control_type | 必须 | |
| field_option_rules | 可选 | |
| field_require | 必须 | |
| field_sort | 可选 | |
| field_visiable | 可选 | |
| field_default | 可选 | |
| is_open | 可选 | |
| field_placeholder | 可选 | |
| allow_staff_ids | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Platform.CustomField_CustomFieldSettings.UpdateCustomField.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 410 | 权限不足 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-27 13:48:10 联系我们开通接入OpenAPI