変更¶
POST /api/v1/incidents/schedule/{schedule_uuid}/modify
概要¶
インシデントオンコール設定を完全に置換します。
呼び出し前の準備と使用手順¶
現在の Key には incidents.incidentsSchedule が必要で、現在のワークスペースのみが対象です。name/start/end/notifyTargets は必須で、通知先は空にできますが、それによって担当者が自動的に補完されることはありません。tagFilter の入力はタグ名で、レスポンスでは UUID に変わります。dimensionFilter はクエリ文字列を使用し、タグまたはディメンションのいずれかが一致すればよく、両方が空の場合はすべてのインシデントが対象になります。
これは完全置換です。必須フィールドは引き続き指定する必要があります。timezone を省略すると Asia/Shanghai にリセットされ、tagFilter/dimensionFilter/scheduleStrategy/extend を省略するとそれぞれクリアされます。詳細取得時の tagFilter は UUID であるため、返送前に tagFilterInfos から名前に変換する必要があります。レスポンスの配列をそのままコピーしないでください。公開 extend では 3 つの宣言済みキーのみ許可され、旧 workTime/custom 周期などはそのまま返送できず、以前の勤務時間の意味が失われる可能性があります。既存の Agent 関連付けは別途保持されますが、公開インターフェースでは変更できません。通知順序/時間/タイムゾーン/ローテーション拡張などの意味が変わると rotationUpdateAt がリセットされ、履歴が記録されます。名前のみ、またはフィルター/ポリシーのみの変更では、ローテーションが必ずしもリセットされるわけではありません。
日中の start/end はシフトの timezone に従って解釈され、日をまたぎません。effectiveTime.start/end は Unix 秒の日付境界です。ローテーションは notifyTargets の順序とカレンダー周期に従い、固定秒数ではありません。現在、新規作成時の rotationUpdateAt はデフォルトで -1 であり、計算チェーンはこれを有効な非ゼロのアンカーとして扱うため、ローテーションを直接有効にしても作成当日に最初の対象から始まるとは限りません。公開 API で rotationUpdateAt を渡して修正することはできません。作成後に詳細/カレンダーで実際のシフトを確認してください。後続で有効な意味変更があった場合にのみ、コードに従ってアンカーがリセットされます。customDay/customWeek/rotationInterval/workTime は現在、履歴レスポンスにのみ現れることができ、公開リクエストでは事前に 406 が返されます。
scheduleStrategy の子オブジェクトは完全には検証されないため、連続した level=配列インデックス、実際のレベル/対象、正の繰り返し間隔を使用する必要があります。作成通知は 0 層の notifyConfig から対象を取得し、[] ポリシーは作成時の全 notifyTargets への通知に自動フォールバックしません。watchkeeper は notifyObject に明示的に含める必要があります。インシデントの operate=update では、オンコール有効時間とフィルター一致後に、設定された notifyTargets のすべての対象が使用され、watchkeeper のローテーション/代理勤務によって現在のシフトだけに縮小されません。担当者が存在する場合はまず担当者に通知し、その後オンコール対象から重複を除外します。担当者だけに通知するわけではありません。ミュート、チャネル可用性などは引き続き実際の配信に影響し、保存成功は配信成功を保証しません。
オンコール/新規タグは先に送信され、その後インシデントマッチングキューが非同期で更新されます。配信失敗時は 500 になる可能性がありますが、本体はすでに保存されています。変更でフィルターのみが変わった場合は該当キューが更新されますが、HTTP 200 をすべてのキャッシュが即時更新された証拠と見なしてはいけません。失敗時はまず設定とカレンダーを読み戻し、重複作成/重複切り替えを避けてください。変更前に完全な公開設定をバックアップし、ロールバックには再送信が必要です。送信済み通知の自動取り消しは保証されません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| schedule_uuid | string | Y | 現在のワークスペースで未削除のオンコール UUID。ポリシー UUID/代理勤務 UUID/インシデント UUID では代替できません。 null を許可: False 例: incsch_example取得または入力方法: オンコールリストの通常管理モードの content.data[].uuid から incsch_ UUID を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| tagFilter[*] | any | 単一の空でないタグ名。既存タグ参照として tag_ UUID を渡すことはできず、渡した場合は新しい名前として処理されます。子項目は強制検証されないため、クライアントは文字列を使用する必要があります。 例: production取得または入力方法: タグ一覧の name または新しい名前。 |
|
| notifyTargets[*] | string | 単一の acnt_/group_/notify_ 文字列またはメールアドレス。ロール ID/Key UUID は使用できません。文字列以外の場合は明確なパラメータエラーではなく 500 になる可能性があります。 例: acnt_example取得または入力方法: ワークスペースメンバー から acnt_、チームリスト から group_、通知先リスト から notify_ を取得するか、許可された有効なメールアドレスを入力します。 |
|
| extend.effectiveTime.start | integer | 任意の整数 Unix 秒。省略/0 の場合は開始境界を設定しません。毎日の start 日内時刻とは異なります。 例: 1785369600取得または入力方法: シフトの timezone に従って対象日の開始時点の Unix 秒を計算します。 |
|
| extend.effectiveTime.end | integer | 任意の整数 Unix 秒。省略/0 の場合は終了境界を設定しません。毎日の end とは異なります。 例: 1785455999取得または入力方法: シフトの timezone に従って截止時刻の Unix 秒を計算します。 |
|
| extend.effectiveTime.その他のキー | any | 有効期間オブジェクトにはキーごとのホワイトリストがないため、その他の値も保存できますが、追加の実行契約は提供されません。 例: value取得または入力方法: 通常この種のキーは不要で、start/end のみを使用します。 |
|
| scheduleStrategy[*] | json | 単一のポリシーオブジェクト。ポリシー uuid は通知の重複排除キャッシュに使用され、シフト UUID ではありません。 例: {"uuid": "strategy_payment", "name": "支付通知", "strategy": []}取得または入力方法: 呼び出し元が安定した一意のポリシー識別子と名前を割り当て、ポリシー間で uuid を再利用しないようにします。 |
|
| scheduleStrategy[*].uuid | string | インシデント/ポリシー単位の重複排除キャッシュに使用します。空値や、複数ポリシーでの同一値の再利用は避けてください。 例: strategy_payment取得または入力方法: 呼び出し元がワークスペース内で競合しない安定したポリシー UUID 文字列を生成します。 |
|
| scheduleStrategy[*].name | string | ポリシー名。通知エスカレーション記録の表示に使用します。 例: 支付通知取得または入力方法: 呼び出し元がポリシーの表示名を入力します。 |
|
| scheduleStrategy[*].strategy | array | 階層オブジェクトの配列。level は 0 から連続して配列インデックスと一致する必要があります。実行チェーンが level を直接インデックスとして使用する可能性があるため、番号の飛び/負数は許可されません。 例: []取得または入力方法: 呼び出し元が通知エスカレーション順に設定します。 |
|
| scheduleStrategy[*].strategy[*] | json | 単層の通知設定。現在の保存時にはリーフ型を厳格に検証しません。 例: {"level": 0, "notifyConfig": [{"notifyObject": ["watchkeeper"]}], "ifRepeatNotify": false}取得または入力方法: インシデント作成/エスカレーション要件に応じて構築します。 |
|
| scheduleStrategy[*].strategy[*].level | integer | 0 は作成通知、以降は正の整数のエスカレーション層です。番号を飛ばしたり、配列インデックスに対応しない並べ替えを行ったりしてはいけません。 例: 0取得または入力方法: 0 から配列順に連続番号を付けます。 |
|
| scheduleStrategy[*].strategy[*].levelUpTime | integer | 正の階層で、インシデント状態の変化時刻からの待機秒数。省略/0 の場合は基本の 0 層選択となり、無限待機として扱うことはできません。 例: 600取得または入力方法: インシデントが未処理のまま一定時間継続した際のエスカレーション秒数を選択します。 |
|
| scheduleStrategy[*].strategy[*].incidentsLevel | array | エスカレーション適用レベルの UUID 配列。正の levelUpTime 分岐では一致が必要です。P1 の表示名ではありません。 例: ["system_level_1"]取得または入力方法: インシデントレベル一覧 から uuid を取得し、現在有効な設定を確認します。 |
|
| scheduleStrategy[*].strategy[*].incidentsLevel[*] | string | 単一のレベル UUID。 例: system_level_1取得または入力方法: インシデントレベル一覧の uuid。 |
|
| scheduleStrategy[*].strategy[*].incidentsStatus | array | エスカレーション適用状態の配列。通常は open/working を使用します。正の levelUpTime 分岐では状態の一致が必要です。 例: ["open", "working"]取得または入力方法: インシデント一覧の incidentsStatus 業務状態を取得します。 |
|
| scheduleStrategy[*].strategy[*].incidentsStatus[*] | string | 1 つの状態文字列。 例: open取得または入力方法: インシデントの業務状態であり、データベースの 0/2/3 ではありません。 |
|
| scheduleStrategy[*].strategy[*].ifRepeatNotify | boolean | 省略時は false。true の場合は有効な正の repeatNotifyInterval を指定する必要があります。基本層の計算では間隔の剰余を取る可能性があるため、0 はタスク内で失敗します。 例: false取得または入力方法: 同一階層で通知を繰り返すかどうかを決定します。 |
|
| scheduleStrategy[*].strategy[*].repeatNotifyInterval | integer | 繰り返し間隔の秒数。60 以上かつ整数分を推奨します。繰り返しが有効な場合のみ意味があり、0/負数は指定できません。 例: 600取得または入力方法: リマインド頻度に応じて正の整数秒を選択し、60 秒の正の整数倍を推奨します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig | array | 通知設定オブジェクトの配列。watchkeeper は実行時に現在有効なオンコール担当者(代理勤務を含む)に置き換えられ、固定アカウントではありません。 例: [{"notifyObject": ["watchkeeper"]}]取得または入力方法: 受信対象と通知方法に応じて構築します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*] | json | 通知先と任意の通知方法の組み合わせ。 例: {"notifyObject": ["watchkeeper"]}取得または入力方法: 実際の通知先に応じて構築します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*].notifyObjectType | string | 任意の表示分類。実行チェーンは主に notifyObject と notifyMethod に基づき、このフィールドで対象を検証しません。 例: member取得または入力方法: エディタの表示分類 member/object/group を踏襲できます。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*].notifyObject | array | 対象識別子の配列。空の [] は自動的にすべてのオンコール担当者を使用せず、watchkeeper を明示する必要があります。 例: ["watchkeeper"]取得または入力方法: ワークスペースメンバー から acnt_、チームリスト から group_、通知先リスト から notify_ を取得するか、許可された有効なメールアドレスを入力します。現在のシフトにはリテラル値 watchkeeper を使用します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*].notifyObject[*] | string | 単一の対象または watchkeeper プレースホルダー。 例: watchkeeper取得または入力方法: ワークスペースメンバー から acnt_、チームリスト から group_、通知先リスト から notify_ を取得するか、許可された有効なメールアドレスを入力します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*].notifyMethod | array | 省略/[] の場合は汎用の対象配信を使用し、notify_ オブジェクトはその設定に従います。明示的な配列は方式を選択しますが、対象が関連連絡先を設定済みであることや、サイトで有料チャネルが開通済みであることは保証しません。 例: ["email"]取得または入力方法: 対象で利用可能な通知チャネルに応じて email メール/mobile 電話/message SMS を選択します。 |
|
| scheduleStrategy[*].strategy[*].notifyConfig[*].notifyMethod[*] | string | 単一の方式(email/mobile/message など)。デプロイで実際に利用可能な機能に基づいて確認します。 例: email取得または入力方法: 開通済みの通知方式。 |
|
| dimensionFilter | string | 任意のクエリ文字列。JSON/SQL/DQL ではありません。プロジェクトのクエリ構文をサポートし、解析が無効な場合は 400 になります。作成時に省略すると空になり、変更時に省略した場合もクリアされます。タグとディメンションフィルターは実行チェーンに従ってマッチングされます。いずれかのタグが一致するか、ディメンション式が一致すればよく、両方が空の場合はすべてに一致します。両方を同時に満たす必要があると誤解しないでください。 null を許可: False 例: service:payment取得または入力方法: インシデントの dimensionTag の実際のディメンションフィールドと値からクエリ文字列を構築します。 |
|
| end | string | Y | 必須の HH:MM。start より後である必要があり、最大 23:59 です。実際の勤務時間帯には終了分内の 59 秒が含まれます。 null を許可: False 最大長: 48 例: 18:00取得または入力方法: シフトの timezone に従って毎日の終了時刻を選択します。 |
| extend | json | 任意の JSON オブジェクト。省略時は {}。変更時は旧公開拡張を全体置換します。現在は enableRotateNotification、rotationCycle、effectiveTime の 3 つの宣言済みキーのみ許可され、workTime/rotationInterval/agentUUIDs など読み取ったキーは送信できず、事前に 406 になります。変更時は元の Agent 関連付けを保持しますが、旧 workTime などの非公開拡張は削除されます。バックアップと評価の後に操作してください。 null を許可: False 例: {"enableRotateNotification": false}取得または入力方法: 輪班方式と有効日付に応じて構築します。 |
|
| extend.effectiveTime | json | 任意のオブジェクト。省略または {} の場合は有効日付制限なし。ミリ秒や旧説明の 11 桁要件ではありません。start/end はそれぞれ省略でき、非ゼロの場合のみ有効です。両方が非ゼロで end<start の場合は 400 になります。内部サブフィールドには型検証が宣言されていないため、必ず整数秒を使用し、文字列/null や任意の構造を使用しないでください。 null を許可: False 例: {"start": 1785369600, "end": 1785455999}取得または入力方法: シフトの有効日付境界を Unix 秒に変換します。タイムゾーンツールで計算できます。 |
|
| extend.enableRotateNotification | boolean | 任意のブール値。省略時は false。true の場合は rotationCycle を明示する必要があり、そうでない場合は 400 MissingCustomParameters になります。 null を許可: False 例: false取得または入力方法: 全対象が同時にオンコールする場合は false、notifyTargets の順序で輪班する場合は true を使用します。 |
|
| extend.rotationCycle | string | 任意の列挙値 day/week/month/workDay/weekend。ローテーション有効時は必須です。シフトのタイムゾーンにおけるカレンダー周期に従い、固定秒数ではありません。week は月曜日に切り替わり、month は暦月で切り替わり、workDay/weekend は曜日のみに従い、法定祝日は認識しません。現在の公開宣言では customDay/customWeek を受け付けず、履歴レスポンスに存在しても送信できません。旧互換の勤務時間では、workDay は月曜から金曜のみ、weekend は土曜と日曜のみとなり、ローテーションが無効でも稼働日に影響します。 null を許可: False 選択可能な値: ['day', 'week', 'month', 'workDay', 'weekend'] 例: day取得または入力方法: シフトに応じて day 日/week 週/month 月/workDay 稼働日/weekend 週末を選択します。 |
|
| name | string | Y | 必須の空でない文字列。宣言上の最大は 256 文字ですが、エンティティ列は 128 のため、1~128 に制限することを推奨します。同じワークスペース内の未削除シフトで重複した名前は使用できません。変更時も必須です。 空文字列を許可: False null を許可: False 最大長: 256 例: 支付服务值班取得または入力方法: オンコール保守担当者がワークスペース内で一意の名前を入力します。 |
| notifyTargets | array | Y | 必須の配列。[] も許可されますが、通知可能な担当者がいない可能性があります。元の順序で保存され、ローテーション有効時は順序がシフトに影響します。acnt_/notify_/group_ はプレフィックスのみでメール検証をスキップするため、対象の存在/有効性/配信可否は保証されません。必ず取得元リストで確認してください。通常のメールアドレスは形式をチェックし、無料プラン/無料ワークスペースではワークスペースメンバー以外のメールアドレスを許可しません。変更時は全量置換されます。 null を許可: False 例: ["acnt_example"]取得または入力方法: ワークスペースメンバー から acnt_、チームリスト から group_、通知先リスト から notify_ を取得するか、許可された有効なメールアドレスを入力します。 |
| scheduleStrategy | array | 任意のポリシーオブジェクト配列。作成時に省略すると []、変更時に省略/[] の場合は旧ポリシーがクリアされます。現在の保存側には完全な子項目検証がないため、成功しても通知設定が実行可能であることは証明されません。配列と内部階層の構造は正しくする必要があり、まず最小設定で検証することを推奨します。 例: []取得または入力方法: 現在のワークスペースのオンコールポリシーエディタで設定して JSON 構造を確認するか、以下のフィールドに従って構築します。 |
|
| start | string | Y | 必須の HH:MM 日内時刻。日付や Unix 時間ではありません。end より前である必要があり、深夜 0 時をまたぎません。24:00 を送信しないでください。日をまたぐ必要がある場合はスケジュールを分割するか、製品がサポートする他の管理方法を使用してください。 null を許可: False 最大長: 48 例: 09:00取得または入力方法: シフトの timezone に従って毎日の開始時刻を選択します。 |
| tagFilter | array | 任意のタグ名配列。作成時に省略するとタグなし、変更時に省略/[] の場合はクリアされます。コントローラーはタグ UUID に変換してレスポンスの tagFilter に保存します。新しいタグは all スコープで作成され、既存名はそのまま再利用されます。現在のチェーンでは monitor スコープ検証を渡さないため、インシデントのタグ書き込み時の競合ルールを適用しないでください。単一の名前はコントローラーで最大 128 文字ですが、エンティティ列は 64 のため、1~64 を推奨します。 null を許可: False 例: ["production"]取得または入力方法: タグ一覧 から name(uuid ではない)を取得するか、新しいタグ名を入力します。 |
|
| timezone | string | 任意の文字列で最大 48 文字。省略時は Asia/Shanghai。変更時に省略すると保持されず、このデフォルトにリセットされます。無効なタイムゾーンはフォーマット/読み取り時に 500 になる可能性があるため、保存前に検証してください。 null を許可: False 最大長: 48 例: Asia/Shanghai取得または入力方法: Asia/Shanghai や UTC などの IANA タイムゾーン識別子を使用します。 |
パラメータ補足説明¶
リクエストは本ページの公開パラメータに従います。日内の start/end は HH:MM、有効期間と代理勤務時間は Unix 秒です。完全なフィールド、値の取得元、レスポンス分岐、失敗時の処理は以下を参照してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/schedule/incsch_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"支付服务值班","timezone":"Asia/Shanghai","start":"09:00","end":"18:00","notifyTargets":["acnt_example"],"dimensionFilter":"service:payment","extend":{"enableRotateNotification":false},"scheduleStrategy":[]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 送信前に組み立てられたシフトエンティティのスナップショット。一覧/詳細の動的オンコールサマリーは含みません。 |
| content.id | integer または null | データベース行 ID。業務上の特定には uuid を使用し、送信前スナップショットでは null になる場合があります。 |
| content.uuid | string | オンコール UUID。incsch_ プレフィックス。 |
| content.status | integer | データベース状態。通常 0 がアクティブ、3 が削除。インシデントの open/working ではありません。 |
| content.creator | string | 作成主体。API Key の場合は通常 wsak_ リソース UUID です。 |
| content.updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.createAt | integer | Unix 秒の作成時刻。 |
| content.updateAt | integer | Unix 秒の最終更新時刻。 |
| content.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は -1。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | オンコール名。 |
| content.timezone | string | IANA タイムゾーン。 |
| content.start | string | 互換の毎日の勤務開始時刻 HH:MM。スケジュールの timezone に従って解釈され、日付や Unix 時間ではありません。 |
| content.end | string | 互換の毎日の勤務終了時刻 HH:MM。有効日付境界は extend.effectiveTime を別途参照してください。 |
| content.tagFilter | array<string> |
マッチングタグ UUID 配列。 |
| content.tagFilter[] | string | タグ UUID。 |
| content.dimensionFilter | string | ディメンションマッチングのクエリ式。 |
| content.notifyTargets | array<string> |
通知先識別子のリスト。 |
| content.notifyTargets[] | string | アカウント/グループ/通知先などの対象識別子。 |
| content.strategyConfig | array<object> |
エスカレーションポリシー設定。ワークスペースに保存されたバージョンに従って読み取ります。 |
| content.strategyConfig[] | object | 1 つの設定ポリシー。インシデント読み取りインターフェースでは実行プレビューを展開しません。 |
| content.strategyConfig[].カスタムフィールド | JSON | その他の保存済みポリシーキー。固定の実行セマンティクスは公開されていません。 |
| content.extend | object | シフト拡張オブジェクト。公開リクエストでは enableRotateNotification/rotationCycle/effectiveTime の 3 つの宣言済みキーのみ受け付けますが、履歴読み取りではさらに多くのキーが含まれる場合があります。 |
| content.extend.カスタムフィールド | JSON | 保存されたオンコール拡張のキーと値。このインターフェースでは変更できません。 |
| content.isDefault | boolean | デフォルトのオンコールかどうか。 |
| content.rotationUpdateAt | integer | ローテーションアンカーの Unix 秒。新規作成時のデフォルトは -1 で、現在の計算では作成時刻に自動でフォールバックしません。初回ローテーションが最初の対象から始まることは保証されず、意味変更後にリセットされる場合があります。 |
| content.agentUUIDs | array<string> |
拡張内の関連 Agent UUID 配列。 |
| content.agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.strategyConfig[].uuid | string | ポリシー UUID。 |
| content.strategyConfig[].name | string | ポリシー名。 |
| content.strategyConfig[].strategy | array<object> |
このポリシーのエスカレーション階層設定配列。 |
| content.strategyConfig[].strategy[].level | integer | 階層番号。通常は 0 から始まります。 |
| content.strategyConfig[].strategy[].levelUpTime | integer | インシデント状態のトリガー時刻からのエスカレーション待機秒数。 |
| content.strategyConfig[].strategy[].incidentsLevel | array<string> |
適用インシデントレベル UUID リスト。 |
| content.strategyConfig[].strategy[].incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.strategyConfig[].strategy[].incidentsStatus | array<string> |
適用インシデント状態リスト(open/working など)。 |
| content.strategyConfig[].strategy[].incidentsStatus[] | string | 1 つのインシデント状態。 |
| content.strategyConfig[].strategy[].ifRepeatNotify | boolean | 通知を繰り返すかどうか。 |
| content.strategyConfig[].strategy[].repeatNotifyInterval | integer | 繰り返し通知の間隔秒。 |
| content.strategyConfig[].strategy[].notifyConfig | array<object> |
この層の通知設定配列。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyObjectType | string | 通知先分類(member/object/group など)。保存済みバージョンに従って読み取ります。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定アカウント UUID ではありません。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyObject[] | string | 1 つの対象アカウント/グループ/通知先識別子、または watchkeeper。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyMethod | array<string> |
通知方法。通常は mobile 電話/message SMS/email メールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyMethod[] | string | 1 つの通知方法。 |
| content.extend.enableRotateNotification | boolean | 通知先をローテーションするかどうか。 |
| content.extend.rotationCycle | string | day/week/month/workDay/weekend/customDay/customWeek のいずれか。履歴では省略される場合があります。 |
| content.extend.rotationInterval | integer | customDay のローテーション間隔日数 1~31、customWeek の週数 1~4。 |
| content.extend.effectiveTime | object | スケジュール有効期間設定。 |
| content.extend.effectiveTime.start | integer | 保存された有効開始 Unix 秒。省略時は開始制限を設定しません。 |
| content.extend.effectiveTime.end | integer | 保存された有効終了 Unix 秒。省略時は終了制限を設定しません。 |
| content.extend.workTime | object | 勤務時間設定。省略時は互換 start/end とローテーション周期から導出されます。 |
| content.extend.workTime.mode | string | allDay は終日、specificTimes は指定時刻。 |
| content.extend.workTime.periods | array<object> |
指定勤務時間帯の配列。 |
| content.extend.workTime.periods[].weekdays | array<integer> |
適用曜日 1 は月曜、7 は日曜。 |
| content.extend.workTime.periods[].weekdays[] | integer | 1~7 のいずれか。 |
| content.extend.workTime.periods[].start | string | 現地日の開始 HH:MM。 |
| content.extend.workTime.periods[].end | string | 現地日の終了 HH:MM。 |
| content.extend.agentUUIDs | array<string> |
関連 Agent UUID。エンティティには別途トップレベルの agentUUIDs 投影があります。 |
| content.extend.agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.strategyConfig[].strategy[].notifyConfig[].notifyType | JSON | 旧エディタが保持する可能性のある表示分類。実行チェーンは主に notifyObject/notifyMethod を読み取り、これに基づいて配信を制御することはできません。 |
| content.extend.effectiveTime.その他のキー | JSON | 宣言されていない有効期間拡張はそのまま保存され、クライアントは start/end のみを使用します。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 7,
"uuid": "incsch_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付服务值班",
"timezone": "Asia/Shanghai",
"start": "09:00",
"end": "18:00",
"tagFilter": [],
"dimensionFilter": "service:payment",
"notifyTargets": [
"acnt_example"
],
"strategyConfig": [],
"extend": {
"enableRotateNotification": false,
"agentUUIDs": []
},
"isDefault": false,
"rotationUpdateAt": -1,
"agentUUIDs": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイル形式エラー | 完全なシフトパラメータオブジェクトを送信します。 |
| 400 | ft.InvalidStartEndTimeFromat | 日内時刻の形式/範囲が無効、または start>=end | 無効な時間帯形式 | 同じ日の有効な HH:MM を使用し、start を end より前にします。 |
| 400 | ft.InvalidEffectiveTime | 非ゼロの有効期間で end が start より前 | 無効な有効時間 | Unix 秒とタイムゾーンを確認し、ミリ秒を混用しないでください。 |
| 400 | ft.MissingCustomParameters | extend.enableRotateNotification=true だが rotationCycle がない | rotationCycle フィールドの欠落 | 公開でサポートされる周期を指定します。 |
| 406 | ft.InvalidEmail | notifyTargets がアカウント/チーム/通知先のプレフィックスではなく、メール形式も誤っている | 無効なメールアドレス | 取得元リストから識別子を選択するか、有効なメールアドレスを使用します。 |
| 400 | ft.UnsupportExternalEmail | 無料プラン/無料ワークスペースで、当該ワークスペースメンバー以外のメールアドレスを使用 | 無料プランワークスペースでは、通知先に外部メールアドレスを使用できません | ワークスペースメンバーのメールアドレスを選択するか、管理者に製品バージョンの制限を確認します。 |
| 400 | ft.scheduleSameNameExists | 同じワークスペース内の未削除シフトで名前が重複 | 同名のスケジュールが既に存在します | 一意の名前を使用します。ネットワーク失敗時はまず一覧を確認し、重複作成を避けます。 |
| 400 | ft.ParamsValidateError | dimensionFilter の構文解析失敗 | パラメータ検証失敗: Field dimensionFilter is fault |
有効なディメンションクエリ文字列(service:payment など)に変更します。 |
| 406 | ft.ExceedMaxCharacterLimit | tagFilter のタグ名がコントローラーの 128 文字上限を超過 | {}が最大文字長制限を超えています | 短い空でないタグ名を使用し、エンティティ列との互換性のため <=64 を推奨します。 |
| 500 | ft.InternalServerError | データベース/タグロックキャッシュ、通知サブ構造、無効なタイムゾーン、送信後のキュー配信などで未処理の例外 | 内部エラー | まずシフト/タグの実際の状態を読み戻します。本体がすでに送信されている可能性があり、キューが収束していなくても重複作成すべきではありません。traceId を保持して処理し、変更前に完全な設定をバックアップします。 |
| 400 | ft.IncidentsScheduleNotFound | 検証後に対象スケジュールが現在のワークスペースに存在しない/削除済み | 指定されたインシデントオンコールが見つかりません | 現在のワークスペース一覧から uuid を更新します。名前/時刻のエラーが先に返る可能性があるため、エラーの順序で存在を判断できません。 |