跳转到主要内容
POST
获取值班表详情

限制说明

使用说明

  • start 和 end 为 10 位 Unix 秒级时间戳;end 必须晚于 start,且相差不超过 45 天。
  • schedule_layers(及其别名 layer_schedules)是窗口内各个未隐藏分层的班次;final_schedule 是所有分层合并后的结果,group 为 null 的班次表示该时段无人值班。
  • 计算结果中的第一个班次可能早于 start 开始:在 start 时刻已经开始的班次按真实开始时间返回。
  • cur_oncall 是此刻正在进行的班次,next_oncall 是之后第一个有人值班的班次;在当前时刻前后 45 天内找不到时为 null,与请求的时间窗口无关。
  • schedule_id 不存在时返回 400。
  • 无法编辑值班表的调用者(非账户所有者或管理员、非创建者、非其团队成员)读到的 notify.im 值以及各 webhook 的 token、verify_token、sign_secret 均为空字符串。

授权

app_key
string
query
必填

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

请求体

application/json

值班表详情请求。start/end 指定计算班次的窗口,相差不超过 45 天。

schedule_id
integer<int64>
必填

值班表 ID,可通过 POST /schedule/list 获取。

start
integer<int64>
必填

窗口开始时间(Unix 秒,10 位)。

end
integer<int64>
必填

窗口结束时间(Unix 秒,10 位)。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

info、list、infos、self、preview 接口返回的值班表。哪些计算字段有值取决于具体接口,见各接口说明。