コンテンツにスキップ

作成¶

POST /api/v1/notification_schedule/add

概要¶

スケジュールを作成します

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
name	string	Y	名称空を許可: False 最大長: 256 空文字列を許可: False
timezone	string		タイムゾーン、デフォルトは Asia/Shanghai 例: Asia/Shanghai 空を許可: False 最大長: 48
start	string	Y	時間帯開始時刻例: 00:00 空を許可: False 最大長: 48
end	string	Y	時間帯終了時刻例: 23:59 空を許可: False 最大長: 48
notifyTargets	array	Y	通知先。アカウントUUID、通知先UUID、メールアドレスを含む例: ['acnt_xxx', 'notify_', 'xxx@guance.com'] 空を許可: False
extend	json		拡張情報。通知先のローテーション設定を含む空を許可: False
extend.enableRotateNotification	boolean		ローテーションを有効にするかどうか。デフォルトでは無効例: False 空を許可: False
extend.rotationCycle	string		ローテーション周期。日: day, 週: week, 月: month, 平日: workDay, 週末: weekend 例: day 空を許可: False 選択可能な値: ['day', 'week', 'month', 'workDay', 'weekend']
extend.effectiveTime	json		スケジュールの有効期限。デフォルトでは永続有効。開始/終了時間は11桁のタイムスタンプ例: {'start': 1719990196, 'end': 1729990196} 空を許可: False

パラメータ補足説明¶

1. リクエストパラメータ説明

パラメータ名	type	必須	説明
name	String	必須	スケジュール名
start	String	必須	時間帯開始時刻
end	String	必須	時間帯終了時刻
timezone	String		タイムゾーン
notifyTargets	array	必須	通知先。アカウントUUID、通知先UUID、メールアドレスを含む
extend	Json		拡張情報

2. extend 内のパラメータ説明

パラメータ名	type	必須	説明
enableRotateNotification	Boolean		通知先のローテーションを有効にするかどうか。デフォルトでは無効
rotationCycle	string		通知先のローテーションを有効にした場合のローテーション周期
effectiveTime	json		スケジュールの有効時間設定。デフォルトでは永続有効。開始/終了時間は11桁のタイムスタンプ

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/notification_schedule/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"schecule_add","timezone":"Asia/Shanghai","start":"00:00","end":"23:59","notifyTargets":["acnt_8b4bd2b8782646f3ba8f6554193f5997","notify_1c08db8458ba4ecabd27b8ce805e8502"],"extend":{"enableRotateNotification":true,"rotationCycle":"workDay","effectiveTime":{"start":1735747200,"end":1737603472}}}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "createAt": 1735797896,
        "creator": "wsak_f2ba9858f4414655be39efc882b120dd",
        "declaration": {},
        "deleteAt": -1,
        "effectiveTimeInfos": {
            "expired": false,
            "timeStr": "2025/01/02 00:00:00~2025/01/23 11:37:52"
        },
        "end": "23:59",
        "extend": {
            "effectiveTime": {
                "end": 1737603472,
                "start": 1735747200
            },
            "enableRotateNotification": true,
            "rotationCycle": "workDay"
        },
        "id": null,
        "name": "schecule_add",
        "notifyTargets": [
            "acnt_8b4bd2b8782646f3ba8f6554193f5997",
            "notify_1c08db8458ba4ecabd27b8ce805e8502"
        ],
        "rotationUpdateAt": 1735797896,
        "start": "00:00",
        "status": 0,
        "timezone": "Asia/Shanghai",
        "updateAt": null,
        "updator": null,
        "uuid": "nsche_3512c1f4d176433484676225b547ef7a",
        "workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-2655C615-0DA5-4391-8528-E46D1783B3F6"
}