YesDev / WebAPI / 加载模块自定义字段的规则配置

加载模块自定义字段的规则配置

接口描述: 加载模块自定义字段的规则配置

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.need数组需求模块的自定义字段规则
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "need": [ // 需求自定义字段
        {
            "key": "_CFKEY_4", // 字段系统key
            "label": "需求收益33", // 字段名称
            "value": "", // 字段值(默认值)
            "required": 0, // 是否必填,1是0否
            "type": "", // 前端控件类型
            "visiable": 0, // 可见范围,0全部1企业管理员
            "option": "" // 字段控件规则选项,由前端规定
        },
        {
            "key": "_CFKEY_2",
            "label": "需求难度",
            "value": "",
            "required": 0,
            "type": "",
            "visiable": 0,
            "option": ""
        }
        ]
    },
    "msg": ""
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
410权限不足
500表示服务端内部错误

本文档生成时间:2024-04-27 19:55:34 联系我们开通接入OpenAPI