通知策略新增¶

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		升级配置例子: {'noManager': {'duration': 600}, 'processTimeout': {'duration': 600}} 允许为空: 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"
upgradeCfg	Json		通知类型存在升级通知时的升级时间配置, 示列: {"noManager":{"duration":600},"processTimeout":{"duration":600}}

请求例子¶

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"
}