作成¶
POST /api/v1/incidents/schedule/add
概要¶
インシデントオンコールと通知エスカレーション設定を作成します。
呼び出し前の準備と使用手順¶
現在の Key には incidents.incidentsSchedule が必要で、現在のワークスペースのみが対象です。name/start/end/notifyTargets は必須で、通知先は空にできますが、それによって自動的に担当者が補われることはありません。tagFilter の入力はタグ名で、レスポンスでは UUID に変わります。dimensionFilter はクエリ文字列を使用し、タグまたはディメンションのいずれかが一致すればよく、両方が空の場合はすべてのインシデントが対象になります。
作成には冪等キーがなく、同名は拒否されます。タイムアウトや 500 の場合は、まず名前で一覧を検索し、重複して作成しないでください。
日内の 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 をすべてのキャッシュが即座に更新された証拠とみなすことはできません。失敗時はまず設定とカレンダーを読み戻し、重複作成/重複切り替えを避けてください。変更前には公開設定の全体をバックアップし、ロールバックは再送信が必要で、送信済み通知の自動取り消しは保証されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 | 1 組の通知対象と任意の通知方法です。 例: {"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/add' \
-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 つの設定ポリシーです。インシデント読み取り API では実行プレビューは展開されません。 |
| content.strategyConfig[].カスタムフィールド | JSON | その他の保存済みポリシーキーで、固定の実行セマンティクスは公開されていません。 |
| content.extend | object | スケジュールの拡張オブジェクトです。公開リクエストでは enableRotateNotification/rotationCycle/effectiveTime の 3 つの宣言済みキーのみ受け付け、過去の読み取りではさらに多くのキーが含まれる場合があります。 |
| content.extend.カスタムフィールド | JSON | 保存されたオンコール拡張のキーと値です。本 API では変更できません。 |
| 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.effectiveTimeInfos | object | 作成/管理一覧に付加される有効期間の表示です。get/modify ではこのフィールドが保証されません。 |
| content.effectiveTimeInfos.timeStr | string | スケジュールのタイムゾーンでフォーマットされた start〜end で、空になることがあります。 |
| content.effectiveTimeInfos.expired | boolean | 有効期間の end が存在し、現在時刻が end より大きい場合のみ true です。false は現在シフト中であることを意味しません。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": null,
"uuid": "incsch_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"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": [],
"effectiveTimeInfos": {
"timeStr": "",
"expired": false
},
"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 を保持して処理し、変更前に完全な設定をバックアップしてください。 |