跳转到主要内容
POST
创建自定义字段

限制说明

使用说明

  • 需要标准版或更高版本的订阅,否则返回 NoLicense。
  • 每个账户默认最多 15 个未删除的自定义字段(部分账户上限更高),超出返回 InvalidParameter。
  • field_name 为 1–39 个字符,须匹配 ^[a-zA-Z_][a-zA-Z0-9_]*$,唯一且创建后不可修改。已删除字段的名称只能在 field_type 和 value_type 都相同时复用。display_name 在未删除字段中须唯一。
  • 类型规则:checkbox 要求 value_type=bool 且不带 options;single_select/multi_select 要求 value_type=string 且 options 非空、不重复;text 要求 value_type=string 且不带 options。
  • 响应只包含 field_id 和 field_name,完整信息请调用 /field/info。
  • 同一账户并发创建会返回 RequestTooFrequently。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
field_name
string
必填

字段标识:1–39 个 [a-zA-Z0-9_] 字符,以字母或下划线开头,创建后不可修改。

Maximum string length: 39
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,39}$
display_name
string
必填

展示名,账号内须唯一。

Maximum string length: 39
field_type
enum<string>
必填

字段类型,创建后不可更改。

可用选项:
checkbox,
multi_select,
single_select,
text
value_type
enum<string>
必填

取值类型。checkbox 须为 bool;其他类型须为 string。创建后不可更改。float 为保留值,当前所有 field_type 均不接受。

可用选项:
string,
bool,
float
description
string

可选描述。

Maximum string length: 499
options
string[]

single_select/multi_select 必填且非空,元素唯一、每个 1–200 字符;checkbox/text 必须省略或为空。

default_value

可选默认值,类型须与 field_type 匹配:checkbox 为 bool;single_select 为 options 中之一;multi_select 为 options 的子集;text 为不超过 3000 字符的字符串。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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