七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
系统设置自定义字段

查询自定义字段枚举值

根据字段 ID 查询枚举值。目前仅支持单选、多选、级联字段。单选/多选字段从字段 description 的 JSON 数组字符串解析枚举;级联字段返回树形枚举。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

请求体

名称类型必填描述示例值
idint64是自定义字段 ID10001

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
dataobject[]枚举值列表。级联字段返回树形结构;单选/多选字段返回平铺列表。[{"opId":"high","id":0,"name":"高意向"}]
└opIdstring数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring枚举项名称高意向
└childrenobject[]子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└opIdstring数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring枚举项名称高意向
└childrenobject[]子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└disabledboolean是否禁用;未返回时可按 false 处理。false
└disabledboolean是否禁用;未返回时可按 false 处理。false

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003time 缺失,或请求时间戳与服务器时间误差超过 10 分钟
14500服务内部异常;请求体无法解析、id 缺失或枚举值读取失败
19100字段不存在;或字段类型不是单选、多选、级联
postEndpoint
/openapi/customfield/getCustomFieldEnums
POST
/openapi/customfield/getCustomFieldEnums
curl -X POST "https://qiyukf.com/openapi/customfield/getCustomFieldEnums?appKey=9f1d7c2b8a6e4d3c&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0" \  -H "Content-Type: application/json" \  -d '{    "id": 10001  }'
{
  "code": 200,
  "data": [
    {
      "opId": "high",
      "id": 0,
      "name": "高意向"
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "time 缺失,或请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14500,
  "message": "服务内部异常;请求体无法解析、id 缺失或枚举值读取失败"
}
{
  "code": 19100,
  "message": "字段不存在;或字段类型不是单选、多选、级联"
}

这篇文档有帮助吗?