Flashcat API

创建值班表

POST

/schedule/create

最后修改时间：2023-12-18 02:47:42

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Body 参数application/json

layers

array [object {12}]

规则

必需

layer_name

string

规则名

必需

mode

enum<integer>

模式(普通/临时)

必需

mode为1的规则放到为0的后面

枚举值:

groups

array [object {2}]

值班分组

可选

fair_rotation

boolean

公平轮转开关

可选

handoff_time

integer

接手时间

可选

接手时间，1周粒度的值班周期使用，从周一00:00到接手的秒数

layer_start

integer

开始时间

必需

最小粒度半小时

layer_end

integer

结束时间

可选

最小粒度半小时

restrict_mode

enum<integer>

周期内限定模式

可选

0 无限制 1 天粒度 2 周粒度

枚举值:

012

restrict_periods

array [object {2}]

限定时间区间列表

可选

day_mask

object

日期掩码

可选

rotation_unit

enum<string>

周期单位

可选

month 自然月

枚举值:

hourdayweekmonth

rotation_value

integer

周期值

可选

notify

object

值班轮转通知

可选

advance_in_time

integer

提前多久通知

可选

单位s

fixed_time

object

固定时间通知

可选

object

个人通知

可选

webhooks

array [object {2}]

Webhooks通知

可选

schedule_name

string

必需

team_id

integer

团队id

可选

status

integer

是否启用

必需

0 启用

description

string

备注

必需

示例

{
  "layers": [
    {
      "layer_name": "string",
      "mode": 0,
      "groups": [
        {
          "group_name": "string",
          "members": [
            {
              "role_id": 0,
              "person_ids": [
                0
              ]
            }
          ]
        }
      ],
      "fair_rotation": true,
      "handoff_time": 0,
      "layer_start": 0,
      "layer_end": 0,
      "restrict_mode": 0,
      "restrict_periods": [
        {
          "restrict_start": 0,
          "restrict_end": 0
        }
      ],
      "day_mask": {
        "repeat": [
          0
        ]
      },
      "rotation_unit": "hour",
      "rotation_value": 0
    }
  ],
  "notify": {
    "advance_in_time": 0,
    "fixed_time": {
      "cycle": "day",
      "start": "string"
    },
    "by": {
      "follow_preference": true,
      "personal_channels": [
        "email"
      ]
    },
    "webhooks": [
      {
        "type": "feishu",
        "settings": {
          "token": "string",
          "alias": "string",
          "integration_id": 0,
          "chat_ids": [
            "string"
          ],
          "sign_secret": "string"
        }
      }
    ]
  },
  "schedule_name": "string",
  "team_id": 0,
  "status": 0,
  "description": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.flashcat.cloud/schedule/create?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "layers": [
        {
            "layer_name": "string",
            "mode": 0,
            "groups": [
                {
                    "group_name": "string",
                    "members": [
                        {
                            "role_id": 0,
                            "person_ids": [
                                0
                            ]
                        }
                    ]
                }
            ],
            "fair_rotation": true,
            "handoff_time": 0,
            "layer_start": 0,
            "layer_end": 0,
            "restrict_mode": 0,
            "restrict_periods": [
                {
                    "restrict_start": 0,
                    "restrict_end": 0
                }
            ],
            "day_mask": {
                "repeat": [
                    0
                ]
            },
            "rotation_unit": "hour",
            "rotation_value": 0
        }
    ],
    "notify": {
        "advance_in_time": 0,
        "fixed_time": {
            "cycle": "day",
            "start": "string"
        },
        "by": {
            "follow_preference": true,
            "personal_channels": [
                "email"
            ]
        },
        "webhooks": [
            {
                "type": "feishu",
                "settings": {
                    "token": "string",
                    "alias": "string",
                    "integration_id": 0,
                    "chat_ids": [
                        "string"
                    ],
                    "sign_secret": "string"
                }
            }
        ]
    },
    "schedule_name": "string",
    "team_id": 0,
    "status": 0,
    "description": "string"
}'

返回响应

🟢200成功

application/json

Body

data

object

可选

schedule_id

integer

必需

error

object

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

示例

{
  "data": {
    "schedule_id": 0
  },
  "error": {
    "code": "",
    "message": ""
  }
}

修改于 2023-12-18 02:47:42

团队Upsert

更新值班表