생성¶
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 | 트리거 시간 간격, 단위 s | |
| notifyType | string | 알림 유형, 단일: once, 반복: cycle, 기본값 단일, 2025-02-19 반복 추가 | |
| cycleDuration | integer | 반복 알림 시 반복 알림 빈도, 단위 s, 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"
}