取得¶
GET /api/v1/incidents/schedule/{schedule_uuid}/get
概要¶
インシデントのオンコール設定と、現在実際に適用されているオンコール/代理オンコールの概要を読み取ります。
呼び出し前の前提と使用手順¶
現在の Key 権限は routine.defaultAccess または incidents.incidentsSchedule のいずれかに該当する必要があり、対象は現在のワークスペースで削除されていないオンコールスケジュールのみです。対象が存在しない場合は 400 IncidentsScheduleNotFound となります。一覧の content.data[].uuid を取得し、インシデントUUIDやポリシーUUIDは渡しません。
完全なオンコールスケジュールエンティティ、notifyTargetsInfos、tagFilterInfos、現在の元の/代理オンコール後のオンコール対象、および onCallNext を返し、管理一覧の互換フィールド effectiveTimeInfos/inEffectNotifyTargetsInfos は付加しません。元のルールと現在のオンコールは異なります。effectiveTime と日内の勤務時間帯、ローテーション、代理オンコールはいずれも onCallNow に影響します。対象概要は欠落する場合があり、存在しない概要を設定が削除されたと見なしてはいけません。onCallNext は将来32日間の日付の勤務時間帯開始点のみを検索し、完全な将来のオンコールスケジュールを保証するものではありません。
読み取りにはフロントエンドで保存された workTime/custom ローテーション/Agent 関連付けが含まれる場合があります。現在公開されている書き込みの extend は3つの宣言済みキーのみを許可し、詳細のすべてのキーをそのまま返して変更してはいけません。公開フィールドに基づいて再構築する必要があり、変更は旧勤務時間のセマンティクスを変える可能性があります。操作前に設定をバックアップし、カレンダーモードで検証してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を取得します。 |
パラメータ補足説明¶
リクエストは本ページで公開されているパラメータに従います。日内の start/end は HH:MM、有効期間と代理オンコール時間は Unix 秒です。完全なフィールド、値の取得元、レスポンス分岐、失敗時の処理は以下を参照してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/incidents/schedule/incsch_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
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.rawWatchkeepers | array<string> |
一時的な代理オンコールを適用していない現在のオンコール対象。[] になる場合があります。 |
| content.rawWatchkeepers[] | string | 元のオンコール対象識別子。 |
| content.effectiveWatchkeepers | array<string> |
現在有効な代理オンコールを適用した後の対象識別子。 |
| content.effectiveWatchkeepers[] | string | 最終的な対象識別子。チーム/通知先のままである場合があり、必ずしも単一アカウントではありません。 |
| content.overrideInfos | array<object> |
現在実際に適用されている代理オンコールエンティティと、元の対象/代理オンコールの概要。 |
| content.onCallNext | array<object> |
将来最大32日間の日付の勤務時間帯開始点を検索して得られた次のシフトの対象概要。無限の将来における最近のイベントを保証するものではなく、終了/開始時刻も含みません。 |
| content.notifyTargetsInfos | array<object> |
解決可能な通知先概要。onCallNow/effective は現在有効なものを表し、inEffectNotifyTargetsInfos は管理一覧の旧互換別名にすぎません。 |
| content.notifyTargetsInfos[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.notifyTargetsInfos[].status | integer | 主体ステータス。 |
| content.notifyTargetsInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.notifyTargetsInfos[].username | string | ログイン名または Key 名。 |
| content.notifyTargetsInfos[].name | string | 表示名。 |
| content.notifyTargetsInfos[].iconUrl | string | アバターURL。空の場合があります。 |
| content.notifyTargetsInfos[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.notifyTargetsInfos[].mobile | string | 電話番号。空の場合があります。 |
| content.notifyTargetsInfos[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.notifyTargetsInfos[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.notifyTargetsInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.notifyTargetsInfos[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.notifyTargetsInfos[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.notifyTargetsInfos[].groupMembers[].name | string | 表示名。 |
| content.notifyTargetsInfos[].groupMembers[].email | string | メールアドレス。 |
| content.notifyTargetsInfos[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.notifyTargetsInfos[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.rawWatchkeepersInfos | array<object> |
解決可能な通知先概要。onCallNow/effective は現在有効なものを表し、inEffectNotifyTargetsInfos は管理一覧の旧互換別名にすぎません。 |
| content.rawWatchkeepersInfos[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.rawWatchkeepersInfos[].status | integer | 主体ステータス。 |
| content.rawWatchkeepersInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.rawWatchkeepersInfos[].username | string | ログイン名または Key 名。 |
| content.rawWatchkeepersInfos[].name | string | 表示名。 |
| content.rawWatchkeepersInfos[].iconUrl | string | アバターURL。空の場合があります。 |
| content.rawWatchkeepersInfos[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.rawWatchkeepersInfos[].mobile | string | 電話番号。空の場合があります。 |
| content.rawWatchkeepersInfos[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.rawWatchkeepersInfos[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.rawWatchkeepersInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.rawWatchkeepersInfos[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.rawWatchkeepersInfos[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.rawWatchkeepersInfos[].groupMembers[].name | string | 表示名。 |
| content.rawWatchkeepersInfos[].groupMembers[].email | string | メールアドレス。 |
| content.rawWatchkeepersInfos[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.rawWatchkeepersInfos[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.effectiveWatchkeepersInfos | array<object> |
解決可能な通知先概要。onCallNow/effective は現在有効なものを表し、inEffectNotifyTargetsInfos は管理一覧の旧互換別名にすぎません。 |
| content.effectiveWatchkeepersInfos[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.effectiveWatchkeepersInfos[].status | integer | 主体ステータス。 |
| content.effectiveWatchkeepersInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.effectiveWatchkeepersInfos[].username | string | ログイン名または Key 名。 |
| content.effectiveWatchkeepersInfos[].name | string | 表示名。 |
| content.effectiveWatchkeepersInfos[].iconUrl | string | アバターURL。空の場合があります。 |
| content.effectiveWatchkeepersInfos[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.effectiveWatchkeepersInfos[].mobile | string | 電話番号。空の場合があります。 |
| content.effectiveWatchkeepersInfos[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.effectiveWatchkeepersInfos[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.effectiveWatchkeepersInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.effectiveWatchkeepersInfos[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.effectiveWatchkeepersInfos[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.effectiveWatchkeepersInfos[].groupMembers[].name | string | 表示名。 |
| content.effectiveWatchkeepersInfos[].groupMembers[].email | string | メールアドレス。 |
| content.effectiveWatchkeepersInfos[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.effectiveWatchkeepersInfos[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.onCallNow | array<object> |
解決可能な通知先概要。onCallNow/effective は現在有効なものを表し、inEffectNotifyTargetsInfos は管理一覧の旧互換別名にすぎません。 |
| content.onCallNow[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.onCallNow[].status | integer | 主体ステータス。 |
| content.onCallNow[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.onCallNow[].username | string | ログイン名または Key 名。 |
| content.onCallNow[].name | string | 表示名。 |
| content.onCallNow[].iconUrl | string | アバターURL。空の場合があります。 |
| content.onCallNow[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.onCallNow[].mobile | string | 電話番号。空の場合があります。 |
| content.onCallNow[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.onCallNow[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.onCallNow[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.onCallNow[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.onCallNow[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.onCallNow[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.onCallNow[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.onCallNow[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.onCallNow[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.onCallNow[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.onCallNow[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.onCallNow[].groupMembers[].name | string | 表示名。 |
| content.onCallNow[].groupMembers[].email | string | メールアドレス。 |
| content.onCallNow[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.onCallNow[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.onCallNext[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.onCallNext[].status | integer | 主体ステータス。 |
| content.onCallNext[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.onCallNext[].username | string | ログイン名または Key 名。 |
| content.onCallNext[].name | string | 表示名。 |
| content.onCallNext[].iconUrl | string | アバターURL。空の場合があります。 |
| content.onCallNext[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.onCallNext[].mobile | string | 電話番号。空の場合があります。 |
| content.onCallNext[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.onCallNext[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.onCallNext[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.onCallNext[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.onCallNext[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.onCallNext[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.onCallNext[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.onCallNext[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.onCallNext[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.onCallNext[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.onCallNext[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.onCallNext[].groupMembers[].name | string | 表示名。 |
| content.onCallNext[].groupMembers[].email | string | メールアドレス。 |
| content.onCallNext[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.onCallNext[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.inEffectNotifyTargetsInfos[].uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.inEffectNotifyTargetsInfos[].status | integer | 主体ステータス。 |
| content.inEffectNotifyTargetsInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.inEffectNotifyTargetsInfos[].username | string | ログイン名または Key 名。 |
| content.inEffectNotifyTargetsInfos[].name | string | 表示名。 |
| content.inEffectNotifyTargetsInfos[].iconUrl | string | アバターURL。空の場合があります。 |
| content.inEffectNotifyTargetsInfos[].email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.inEffectNotifyTargetsInfos[].mobile | string | 電話番号。空の場合があります。 |
| content.inEffectNotifyTargetsInfos[].countryCode | string | 電話の国番号。空の場合があります。 |
| content.inEffectNotifyTargetsInfos[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.inEffectNotifyTargetsInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.inEffectNotifyTargetsInfos[].groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.inEffectNotifyTargetsInfos[].groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.inEffectNotifyTargetsInfos[].groupMembers[].name | string | 表示名。 |
| content.inEffectNotifyTargetsInfos[].groupMembers[].email | string | メールアドレス。 |
| content.inEffectNotifyTargetsInfos[].groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.inEffectNotifyTargetsInfos[].type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.overrideInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。 |
| content.overrideInfos[].uuid | string | このリソースUUID。チームは group_、代理オンコールは incschovr_。 |
| content.overrideInfos[].status | integer | リソースステータス。通常 0。ソフト削除の 3 はクエリから除外されます。 |
| content.overrideInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。 |
| content.overrideInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.overrideInfos[].createAt | integer | Unix 秒の作成時刻。 |
| content.overrideInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。 |
| content.overrideInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。 |
| content.overrideInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。 |
| content.overrideInfos[].scheduleUUID | string | 所属オンコールスケジュールUUID。 |
| content.overrideInfos[].replacedTarget | string | 置き換え対象のオンコール対象識別子。 |
| content.overrideInfos[].substituteTarget | string | 代理オンコール対象の識別子。 |
| content.overrideInfos[].startAt | integer | 代理オンコール開始 Unix 秒。 |
| content.overrideInfos[].endAt | integer | 代理オンコール終了 Unix 秒。 |
| content.overrideInfos[].timezone | string | 代理オンコールのタイムゾーン。 |
| content.overrideInfos[].extend | object | 代理オンコール保存拡張。 |
| content.overrideInfos[].extend.自定义键 | JSON | 履歴/メンテナンス拡張キー。 |
| content.overrideInfos[].replacedTargetInfo | object または null | オプションの対象概要。解決できない場合は null になることがあります。 |
| content.overrideInfos[].replacedTargetInfo.uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.overrideInfos[].replacedTargetInfo.status | integer | 主体ステータス。 |
| content.overrideInfos[].replacedTargetInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.overrideInfos[].replacedTargetInfo.username | string | ログイン名または Key 名。 |
| content.overrideInfos[].replacedTargetInfo.name | string | 表示名。 |
| content.overrideInfos[].replacedTargetInfo.iconUrl | string | アバターURL。空の場合があります。 |
| content.overrideInfos[].replacedTargetInfo.email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.overrideInfos[].replacedTargetInfo.mobile | string | 電話番号。空の場合があります。 |
| content.overrideInfos[].replacedTargetInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.overrideInfos[].replacedTargetInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.overrideInfos[].replacedTargetInfo.id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.overrideInfos[].replacedTargetInfo.groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.overrideInfos[].replacedTargetInfo.groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.overrideInfos[].replacedTargetInfo.groupMembers[].name | string | 表示名。 |
| content.overrideInfos[].replacedTargetInfo.groupMembers[].email | string | メールアドレス。 |
| content.overrideInfos[].replacedTargetInfo.groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.overrideInfos[].replacedTargetInfo.type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.overrideInfos[].substituteTargetInfo | object または null | オプションの対象概要。解決できない場合は null になることがあります。 |
| content.overrideInfos[].substituteTargetInfo.uuid | string | 主体UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.overrideInfos[].substituteTargetInfo.status | integer | 主体ステータス。 |
| content.overrideInfos[].substituteTargetInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.overrideInfos[].substituteTargetInfo.username | string | ログイン名または Key 名。 |
| content.overrideInfos[].substituteTargetInfo.name | string | 表示名。 |
| content.overrideInfos[].substituteTargetInfo.iconUrl | string | アバターURL。空の場合があります。 |
| content.overrideInfos[].substituteTargetInfo.email | string | メールアドレス。Key 主体の場合は自身のUUIDとなることがあり、配信可能であることは保証されません。 |
| content.overrideInfos[].substituteTargetInfo.mobile | string | 電話番号。空の場合があります。 |
| content.overrideInfos[].substituteTargetInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.overrideInfos[].substituteTargetInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.overrideInfos[].substituteTargetInfo.id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.creator | string | 作成主体UUIDまたは履歴システム主体。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.updator | string | 最終更新主体。未更新の場合は空になることがあります。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.createAt | integer | Unix 秒の作成時刻。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.workspaceUUID | string | 現在の Key が所属するワークスペース。チームオブジェクトのみ。 |
| content.overrideInfos[].substituteTargetInfo.groupMembers | array<object> |
チーム概要に含まれる、有効で解決可能なメンバーのリスト。 |
| content.overrideInfos[].substituteTargetInfo.groupMembers[].uuid | string | チームメンバーのアカウントUUID。 |
| content.overrideInfos[].substituteTargetInfo.groupMembers[].name | string | 表示名。 |
| content.overrideInfos[].substituteTargetInfo.groupMembers[].email | string | メールアドレス。 |
| content.overrideInfos[].substituteTargetInfo.groupMembers[].acntWsNickname | string | ワークスペースのニックネーム。 |
| content.overrideInfos[].substituteTargetInfo.type | string | notify_ 通知先タイプのみ。通知認証情報は含みません。 |
| content.tagFilterInfos | array<object> |
タグの完全なエンティティ概要。一覧/詳細に付加されます。 |
| content.tagFilterInfos[].id | integer または null | データベース行ID。パスの特定には使用しません。送信前スナップショットでは null になる場合があります。 |
| content.tagFilterInfos[].uuid | string | タグUUID。接頭辞は tag_。 |
| content.tagFilterInfos[].status | integer | リソースステータス。通常 0。ソフト削除の 3 はクエリから除外されます。 |
| content.tagFilterInfos[].creator | string | 作成主体UUIDまたは履歴システム主体。 |
| content.tagFilterInfos[].updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.tagFilterInfos[].createAt | integer | Unix 秒の作成時刻。 |
| content.tagFilterInfos[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。 |
| content.tagFilterInfos[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。 |
| content.tagFilterInfos[].workspaceUUID | string | 現在の Key が所属するワークスペース。 |
| content.tagFilterInfos[].name | string | タグ名。 |
| content.tagFilterInfos[].description | string | 説明。 |
| content.tagFilterInfos[].colour | string | 表示色。 |
| content.tagFilterInfos[].scope | array<string> |
スコープ配列: all/scene/monitor/dialing/security/infrastructure/catalog。タグの実際の定義に従います。 |
| content.tagFilterInfos[].scope[] | string | 1つの実際のスコープ。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 7,
"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": [],
"notifyTargetsInfos": [
{
"uuid": "acnt_example",
"name": "值班成员",
"email": "xxx@guance.com"
}
],
"rawWatchkeepers": [],
"effectiveWatchkeepers": [],
"rawWatchkeepersInfos": [],
"effectiveWatchkeepersInfos": [],
"onCallNow": [],
"onCallNext": [],
"overrideInfos": [],
"tagFilterInfos": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.IncidentsScheduleNotFound | 現在のワークスペースで削除されていない対象オンコールスケジュールが存在しない | 指定されたインシデントオンコールが見つかりません | 管理一覧から uuid を更新してください。 |
| 406 | ft.ParameterValidationFailed | tagFilterInfos の読み取り時に履歴タグの scope が無効 | invalid scope | 管理者に連絡して関連タグの scope を確認してください。このエラーはパスUUID/Queryの無効によるものではないため、むやみにリクエストを変更しないでください。 |
| 500 | ft.InternalServerError | データベース/履歴オンコールスケジュールポリシー、通知先、無効なタイムゾーン/存在しない日付などの未処理例外 | 内部エラー | タイムゾーン、日付、履歴設定の形式を確認し、traceId を保持してバックオフしてください。例外をもってオンコール担当者がいないと判断しないでください。 |