跳转到主要内容
POST
查看自定义字段列表

限制说明

使用说明

  • 一次返回全部未删除的字段,无分页、无 total。按 orderby(默认 created_at)排序,默认倒序,asc 为 true 时正序。
  • query 是对 field_name 的正则匹配,不区分大小写;不合法的正则按普通文本匹配。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json
orderby
enum<string>

排序键,省略时默认为 created_at。

可用选项:
created_at,
updated_at
asc
boolean

true 升序,false 降序。

creator_id
integer<int64> | null

按创建人成员 ID 过滤,不传或传 null 不过滤。

query
string

正则过滤,仅匹配 field_name。非法正则会自动转义为字面量子串匹配。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。