跳转到主要内容
POST
创建服务日历

限制说明

使用说明

  • 每个账户最多 20 个日历:账户已有 20 个日历后,任何成员的创建请求都返回 InvalidParameter。
  • cal_name 在账户内必须唯一,timezone 必须是合法的 IANA 时区,非零 team_id 必须是账户中的团队,否则返回 InvalidParameter。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

创建日历请求,cal_name 必填。

cal_name
string
必填

日历名称,在账户内必须唯一。

Required string length: 1 - 39
description
string

日历描述。

Maximum string length: 499
timezone
string
默认值:Asia/Shanghai

IANA 时区,如 America/New_York。为空时默认 Asia/Shanghai;非法名称返回 InvalidParameter。

team_id
integer<uint64>

所属团队 ID;为 0 或不传表示不归属团队。非零 ID 必须是账户中的团队。

workdays
integer[]

每周工作日,0 表示周日……6 表示周六。未列出的日子为非工作日。为空时不把任何一天视为非工作日。

必填范围: 0 <= x <= 6
extra_cal_ids
string[]

需要继承事件的公共日历 ID 列表,例如 zh-cn.china.official 这样的 region.official.holiday 日历,以及最多一个 exchange.holiday 交易所日历。关联交易所日历后,本日历的 timezone 会跟随交易所时区并覆盖请求中的取值;关联两个交易所日历则返回 InvalidParameter。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建日历响应。