作成¶
POST /api/v1/issue/notification_policy/add
概要¶
通知ポリシーを作成します。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | 通知ポリシー名 空文字許可: False 最大長: 256 空文字列許可: False |
| notificationScheduleUUIDs | array | 通知スケジュールUUIDのリスト 例: ['nsche_xxx', 'nsche_yyy'] 空文字許可: False |
|
| extend | json | 拡張情報。通知範囲、アップグレード設定を含む 空文字許可: False |
|
| extend.notifyTypes | array | 通知タイプ 例: ['issue.add', 'issue.modify', 'issueUpgrade.noManager', 'issueUpgrade.processTimeout', 'issueReply.add', 'issueReply.modify', 'issueReply.delete', 'dailySummary'] 空文字許可: False |
|
| extend.upgradeCfg | json | アップグレード設定 空文字許可: False |
パラメータ補足説明¶
1. リクエストパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | String | 必須 | 名称 |
| notificationScheduleUUIDs | Array | 必須 | 関連付けるスケジュールのリスト |
| extend | Json | 拡張情報 |
2. extend 内のパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| notifyTypes | Array | 通知をトリガーするタイプ。選択肢: "issue.add","issue.modify","issueUpgrade.noManager","issueUpgrade.processTimeout","issueReply.add","issueReply.modify","issueReply.delete","dailySummary", "issueUpgrade.eventStorm"（2025-05-28のリリースで追加） | |
| upgradeCfg | Json | 通知タイプにアップグレード通知が含まれる場合のアップグレード時間設定 |
3. extend.upgradeCfg 内のパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| noManager | Json | extend.notifyTypes で issueUpgrade.noManager が有効な場合に設定するフィールド | |
| processTimeout | json | extend.notifyTypes で issueUpgrade.processTimeout が有効な場合に設定するフィールド | |
| openProcessTimeout | Json | extend.notifyTypes で issueUpgrade.processTimeout が有効な場合に設定するフィールド（2025-02-19のリリースで追加） | |
| eventStorm | Json | extend.notifyTypes で issueUpgrade.eventStorm が有効な場合に設定するフィールド（2025-05-28のリリースで追加） |
3.1 extend.upgradeCfg 内の noManager、processTimeout、openProcessTimeout、eventStorm の内部構造とパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| duration | integer | トリガー間隔（秒単位） | |
| notifyType | string | 通知タイプ。1回: once、繰り返し: cycle。デフォルトは once（2025-02-19のリリースで追加） | |
| cycleDuration | integer | 繰り返し通知の場合の通知頻度（秒単位）（2025-02-19のリリースで追加） | |
| cycleTimes | integer | 繰り返し通知の場合の通知回数（1～30）（2025-02-19のリリースで追加） | |
| exceedTimes | integer | Issue アップグレード通知におけるイベントストームの関連イベント閾値回数（2025-05-28のリリースで追加） |
注: extend.notifyTypes で issueUpgrade.processTimeout が有効な場合、extend.upgradeCfg 内の processTimeout と openProcessTimeout を同時に設定可能です。
extend.upgradeCfg フィールドの例:
{
"noManager": {
"duration": 600
},
"processTimeout": {
"duration": 600,
"cycleDuration": 600,
"notifyType": "cycle",
"cycleTimes": 10
},
"openProcessTimeout": {
"duration": 600,
"notifyType": "once"
},
"eventStorm": {
"exceedTimes": 60,
"notifyType": "once"
}
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/issue/notification_policy/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"api_add test","notificationScheduleUUIDs":["nsche_a15990d7e6ec4514842dbee74e26a1cf"],"extend":{"notifyTypes":["issue.add","issue.modify","issueUpgrade.noManager","issueReply.add","issueReply.modify"],"upgradeCfg":{"noManager":{"duration":1200},"processTimeout":{}}}}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"createAt": 1735801143,
"creator": "wsak_f2ba9858f4414655be39efc882b120dd",
"declaration": {},
"deleteAt": -1,
"extend": {
"notifyTypes": [
"issue.add",
"issue.modify",
"issueUpgrade.noManager",
"issueReply.add",
"issueReply.modify"
],
"upgradeCfg": {
"noManager": {
"duration": 1200
},
"processTimeout": {}
}
},
"id": null,
"name": "api_add test",
"notificationScheduleUUIDs": [
"nsche_a15990d7e6ec4514842dbee74e26a1cf"
],
"status": 0,
"updateAt": null,
"updator": null,
"uuid": "inpy_c79b26b3f6a540888f1773317093c0bd",
"workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-844F87BE-34E5-4C96-B2AC-65A2433011BC"
}