更新值班表

更新已有的值班表，需要通过 schedule_id 指定值班表。

POST /schedule/update

更新值班表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/schedule/update?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule_id": 2001,
  "schedule_name": "Production On-Call (Updated)",
  "description": "Updated primary on-call rotation",
  "team_id": 4291079133131
}
'

import requests

url = "https://api.flashcat.cloud/schedule/update?app_key="

payload = {
    "schedule_id": 2001,
    "schedule_name": "Production On-Call (Updated)",
    "description": "Updated primary on-call rotation",
    "team_id": 4291079133131
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    schedule_id: 2001,
    schedule_name: 'Production On-Call (Updated)',
    description: 'Updated primary on-call rotation',
    team_id: 4291079133131
  })
};

fetch('https://api.flashcat.cloud/schedule/update?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/schedule/update?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'schedule_id' => 2001,
    'schedule_name' => 'Production On-Call (Updated)',
    'description' => 'Updated primary on-call rotation',
    'team_id' => 4291079133131
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/schedule/update?app_key="

	payload := strings.NewReader("{\n  \"schedule_id\": 2001,\n  \"schedule_name\": \"Production On-Call (Updated)\",\n  \"description\": \"Updated primary on-call rotation\",\n  \"team_id\": 4291079133131\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/schedule/update?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schedule_id\": 2001,\n  \"schedule_name\": \"Production On-Call (Updated)\",\n  \"description\": \"Updated primary on-call rotation\",\n  \"team_id\": 4291079133131\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/schedule/update?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schedule_id\": 2001,\n  \"schedule_name\": \"Production On-Call (Updated)\",\n  \"description\": \"Updated primary on-call rotation\",\n  \"team_id\": 4291079133131\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	值班管理（on-call）

授权

app_key · string · query · 必填

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

请求体

application/json

值班表创建/更新/预览共用的请求体，结构与值班表详情一致，此处仅列出常用字段。更新时需要 schedule_id；预览时 start、end 必填。

schedule_id · integer<int64> | null

值班表 ID，更新时必填。

schedule_name · string | null

值班表显示名称，最长 40 字符。

Maximum string length: 40

name · string | null

旧版名称字段，当 schedule_name 为空时使用。

Maximum string length: 40

description · string | null

值班表描述，最长 500 字符。

Maximum string length: 500

team_id · integer<int64> | null

所属团队 ID。

layers · object[]

轮转分层。

Show child attributes

notify · object

值班表的通知配置。

Show child attributes

start · integer<int64>

预览窗口开始时间（Unix 秒，10 位），/schedule/preview 必填。

end · integer<int64>

预览窗口结束时间（Unix 秒，10 位），/schedule/preview 必填，且距 start 不超过 45 天。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

空响应。