取得¶
GET /api/v1/notification_schedule/{notification_schedule_uuid}/get
概要¶
指定したスケジュールの完全な設定と、解決可能な通知先を読み取ります。
呼び出し前の準備と使用手順¶
スケジュール一覧から UUID をコピーして呼び出します。この API は現在有効な通知先と整形済みの有効期間を返しません。必要に応じてスケジュール一覧を参照してください。現行バージョンでは、実際にポリシーから参照されていても関連通知ポリシー一覧が空になる場合があります。関連情報が必要な場合は一覧でクロスチェックし、この空配列のみで関連がないと判断しないでください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| notification_schedule_uuid | string | Y | 対象スケジュールの UUID。現在の API Key のワークスペースに属している必要があります。 例: nsche_example取得・入力方法: スケジュール一覧が返す content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足¶
本 API が返す name、timezone、start、end、notifyTargets、extend をコピーすると、完全な更新の基礎として利用できます。レスポンスの全フィールドをそのまま返さないでください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notification_schedule/nsche_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 対象スケジュールの設定。 |
| content.id | integer | データベースレコード番号。スケジュールの操作には uuid を使用します。 |
| content.uuid | string | スケジュール UUID。照会、変更、削除、および通知ポリシーからの参照に使用します。 |
| content.workspaceUUID | string | 所属ワークスペースの UUID。 |
| content.name | string | スケジュール名。 |
| content.timezone | string | このスケジュールが当日の時間帯と有効日を解釈する際に使用する IANA タイムゾーン。 |
| content.start | string | 当日の開始時刻 HH:MM。 |
| content.end | string | 当日の終了時刻 HH:MM。終了分の最後の秒まで有効です。 |
| content.notifyTargets | array<string> |
順序どおりに保存されたメンバー、通知先 UUID、またはメールアドレス。 |
| content.notifyTargets[] | string | acnt_ アカウント、notify_ 通知先、またはメールアドレスの文字列。 |
| content.extend | object | 拡張設定。未設定の場合は {} になります。 |
| content.extend.enableRotateNotification | boolean | ローテーションを有効にするか。省略時は false として扱います。 |
| content.extend.rotationCycle | string | ローテーション有効時の周期。day は日単位、week は月曜日起点の週単位、month は暦月単位、workDay は平日のみを日単位、weekend は週末のみを日単位とします。祝日は認識しません。未設定の場合は省略できます。 |
| content.extend.effectiveTime | object | 全体的な有効期間。未設定の場合は省略できます。 |
| content.extend.effectiveTime.start | integer | 有効期間の開始 Unix 秒。0 または省略時は制限なし。 |
| content.extend.effectiveTime.end | integer | 有効期間の終了 Unix 秒。0 または省略時は制限なし。 |
| content.rotationUpdateAt | integer | ローテーション計算の開始時刻(Unix 秒)。ローテーション関連の設定を変更するとリセットされます。 |
| content.status | integer | レコードステータス。有効なレコードは 0 です。 |
| content.creator | string | 作成した呼び出し元の識別子。 |
| content.updator | string | 最終更新者の識別子。未更新の場合は空文字列。 |
| content.createAt | integer | 作成時刻(Unix 秒)。 |
| content.updateAt | integer | 更新時刻(Unix 秒)。未更新の場合は -1。 |
| content.deleteAt | integer | 削除時刻(Unix 秒)。未削除の場合は -1。 |
| content.notifyTargetsInfos | array<object> |
解決済みの通知先情報。無効または既に存在しない通知先は返されない場合があり、フィールドはアカウント、通知先、メールアドレスの 3 種類によって異なります。 |
| content.notifyTargetsInfos[].uuid | string | アカウント/通知先の UUID。メールアドレス通知先の場合はメールアドレス自体を UUID とします。 |
| content.notifyTargetsInfos[].name | string | 通知先の表示名。メールアドレス通知先の場合はメールアドレス。 |
| content.notifyTargetsInfos[].status | integer | アカウントまたは通知先のレコードステータス。メールアドレス通知先にはこのフィールドは含まれません。 |
| content.notifyTargetsInfos[].type | string | 通知先のみで提供される、通知先のタイプ。 |
| content.notifyTargetsInfos[].wsAccountStatus | integer | アカウントのみで提供される、アカウントのワークスペース内でのステータス。 |
| content.notifyTargetsInfos[].username | string | アカウントのみで提供される、ログインユーザー名。 |
| content.notifyTargetsInfos[].iconUrl | string | アカウントのみで提供される、アイコン画像のアドレス。 |
| content.notifyTargetsInfos[].email | string | アカウントのメールアドレス、またはメールアドレス通知先のアドレス。通知先では提供されない場合があります。 |
| content.notifyTargetsInfos[].mobile | string | アカウントのみで提供される、電話番号。空の場合があります。 |
| content.notifyTargetsInfos[].countryCode | string | アカウントのみで提供される、電話番号の国/地域コード。 |
| content.notifyTargetsInfos[].acntWsNickname | string | アカウントのみで提供される、ワークスペース内のニックネーム。 |
| content.issueNotificationPolicyInfos | array<object> |
関連する通知ポリシーと、そのポリシーを参照するチャンネル。関連がない場合は空になります。 |
| content.issueNotificationPolicyInfos[].id | integer | ポリシーのレコード番号。 |
| content.issueNotificationPolicyInfos[].uuid | string | 通知ポリシーの UUID。 |
| content.issueNotificationPolicyInfos[].workspaceUUID | string | ポリシーが所属するワークスペース。 |
| content.issueNotificationPolicyInfos[].name | string | ポリシー名。 |
| content.issueNotificationPolicyInfos[].extend | object | 通知範囲とエスカレーション設定。完全な設定の意味は通知ポリシー一覧を参照してください。 |
| content.issueNotificationPolicyInfos[].extend.notifyTypes | array<string> |
通知をトリガーするイベントタイプの一覧。省略可能。 |
| content.issueNotificationPolicyInfos[].extend.notifyTypes[] | string | 例: issue.add、issue.modify、issueReply.add、dailySummary。 |
| content.issueNotificationPolicyInfos[].extend.upgradeCfg | object | エスカレーションのトリガータイプごとに保存される設定。省略可能。 |
| content.issueNotificationPolicyInfos[].extend.upgradeCfg.動的キー | object | noManager、processTimeout、openProcessTimeout、eventStorm など、設定済みのエスカレーションのトリガータイプ。 |
| content.issueNotificationPolicyInfos[].extend.upgradeCfg.動的キー.duration | integer | 待機または判定時間(秒)。実際のトリガータイプに応じて提供されます。 |
| content.issueNotificationPolicyInfos[].extend.upgradeCfg.動的キー.その他のフィールド | number、boolean、string、array または object | トリガータイプごとに異なる追加ルール。通知ポリシーの詳細とそのパラメータ表を参照してください。 |
| content.issueNotificationPolicyInfos[].status | integer | 有効なステータスは 0 です。 |
| content.issueNotificationPolicyInfos[].creator | string | 作成者の識別子。 |
| content.issueNotificationPolicyInfos[].updator | string | 更新者の識別子。 |
| content.issueNotificationPolicyInfos[].createAt | integer | 作成 Unix 秒。 |
| content.issueNotificationPolicyInfos[].updateAt | integer | 更新 Unix 秒。未更新は -1。 |
| content.issueNotificationPolicyInfos[].deleteAt | integer | 削除 Unix 秒。未削除は -1。 |
| content.issueNotificationPolicyInfos[].channelInfos | array<object> |
この通知ポリシーを参照するチャンネルエンティティの一覧。 |
| content.issueNotificationPolicyInfos[].channelInfos[].id | integer | データベースレコード番号。チャンネルの操作には uuid を使用してください。 |
| content.issueNotificationPolicyInfos[].channelInfos[].uuid | string | チャンネル UUID。変更、削除、またはサブスクリプションに使用します。 |
| content.issueNotificationPolicyInfos[].channelInfos[].workspaceUUID | string | チャンネルが所属するワークスペース。 |
| content.issueNotificationPolicyInfos[].channelInfos[].name | string | チャンネル名。default はデフォルトチャンネルを表します。 |
| content.issueNotificationPolicyInfos[].channelInfos[].description | string | チャンネルの説明。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyTarget | array<string> |
このチャンネルに直接設定された通知先 UUID。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyTarget[] | string | 単一の通知先 UUID。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg | object | エスカレーション通知の設定。未設定の場合は空のオブジェクト。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.triggerTime | integer | エスカレーション通知をトリガーするまでの待機時間(秒)。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
エスカレーション通知先 UUID の一覧。 |
| content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget[] | string | エスカレーション通知先 UUID。 |
| content.issueNotificationPolicyInfos[].channelInfos[].status | integer | レコードステータス。正常な場合は 0 です。 |
| content.issueNotificationPolicyInfos[].channelInfos[].creator | string | 作成した呼び出し元の識別子。 |
| content.issueNotificationPolicyInfos[].channelInfos[].updator | string | 最終更新者の識別子。未更新の場合は空文字列になります。 |
| content.issueNotificationPolicyInfos[].channelInfos[].createAt | integer | 作成時刻(Unix 秒)。 |
| content.issueNotificationPolicyInfos[].channelInfos[].updateAt | integer | 更新時刻(Unix 秒)。未更新の場合は -1。 |
| content.issueNotificationPolicyInfos[].channelInfos[].deleteAt | integer | 削除時刻(Unix 秒)。未削除の場合は -1。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 42,
"uuid": "nsche_example",
"workspaceUUID": "wksp_example",
"name": "本番オンコール",
"timezone": "Asia/Shanghai",
"start": "09:00",
"end": "18:00",
"notifyTargets": [
"notify_example"
],
"extend": {
"enableRotateNotification": false
},
"rotationUpdateAt": 1785427200,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"notifyTargetsInfos": [
{
"uuid": "notify_example",
"name": "本番オンコールグループ",
"status": 0,
"type": "dingtalk"
}
],
"issueNotificationPolicyInfos": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通のリクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | スケジュールが存在しない、削除済み、または現在のワークスペースに属していない | 指定されたオブジェクトが存在しません | スケジュール一覧から有効な UUID を再コピーしてください。 |
| 500 | ft.InternalServerError | データベースクエリまたは履歴設定情報の読み取りで例外が発生 | 内部エラー | traceId を保持したまま再試行してください。継続的に失敗する場合は、スケジュール UUID とマスク済みのレスポンスを添えてサポートへお問い合わせください。 |