跳转到主要内容
POST
/
field
/
create
创建自定义字段
curl --request POST \
  --url 'https://api.flashcat.cloud/field/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_name": "severity_class",
  "display_name": "Severity Class",
  "description": "Business severity tier.",
  "field_type": "single_select",
  "value_type": "string",
  "options": [
    "Critical",
    "High",
    "Medium",
    "Low"
  ],
  "default_value": "Medium"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "field_id": "66e9d3a4f7c2b04a1c8a91b3",
    "field_name": "severity_class"
  }
}

​
调用限制

项值
速率限制每账户 1,000 次/分钟；50 次/秒
权限故障可管理 (on-call)

​
使用说明

  • 每个账号最多 15 个自定义字段。
  • field_name 必须匹配 ^[a-zA-Z_][a-zA-Z0-9_]{0,39}$，创建后不可更改；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。
  • 该接口会被审计日志记录。

授权

​
app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json
​
field_name
string
必填

机器名。必须以字母或下划线开头，长度 1–40，由 [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。创建后不可更改。

可用选项:
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
必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。