通知管理¶

说明¶

管理通知管理中默认的通知，用于选择通知方式时选择的默认值

1、通知列表、新增通知、批量删除通知 API¶

请求方式： GET（查询） POST（新增） DELETE（批量删除）

请求地址： /api/notification/notification/

Content-Type：

新增数据的时候需要指定Content-Type，以下对Content-Type进行说明:

application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串

查询参数：

参数	数据类型	是否必须	说明
offset	int	否	数据起始位置
limit	int	否	查询条数
name	string	否	通知名称
search	string	否	模糊查询，查询字段为name

输入参数（新增）：

参数	数据类型	是否必须	说明
name	string	是	通知名称
channel	string	是	渠道类型
channel_name	string	是	渠道类型中文名称
description	string	否	描述
channel_id	int	是	通知渠道
channel_type_name	string	是	通知渠道中文名称
target_list	string	否	通知目标

输出参数：

参数	数据类型	是否必须	说明
id	int	是	通知id
name	string	是	通知名称
channel	string	是	渠道类型
channel_name	string	是	渠道类型中文名称
description	string	否	描述
channel_id	int	是	通知渠道
channel_type_name	string	是	通知渠道中文名称
target_list	string	否	通知目标

批量删除参数：

参数	数据类型	是否必须	说明
pk	string	与pk[]不能都为空	主键，多个主键用半角逗号隔开。通过http body传入
pk[]	array	与pk不能都为空	主键数组。通过http body传入

排序：

参数

数据类型

是否必须

说明

ordering

string

否

一般默认按id倒叙

ordering=id表示按id排序ordering=-id表示按id倒叙
多个字段排序用半角逗号分隔

GET返回数据例子：

{
    "count": 9,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 12,
            "name": "notification weixin",
            "channel": "QiYeWeiXin",
            "description": "",
            "target_list": "admin@shfanxi.com",
            "channel_name": "企业微信",
            "channel_id": 2,
            "channel_type_name": "Alex企业微信"
        },
        {
            "id": 11,
            "name": "notification dingtalk",
            "channel": "DingTalk",
            "description": "",
            "target_list": "admin@shfanxi,com",
            "channel_name": "钉钉",
            "channel_id": 4,
            "channel_type_name": "Alex钉钉账号"
        },
        {
            "id": 10,
            "name": "notification",
            "channel": "Email",
            "description": "",
            "target_list": "admin@shfanxi.com",
            "channel_name": "邮件",
            "channel_id": 3,
            "channel_type_name": "研发"
        },
        {
            "id": 8,
            "name": "企业微信通知",
            "channel": "QiYeWeiXin",
            "description": "",
            "target_list": "ChenShaong\r\nCenCeng",
            "channel_name": "企业微信",
            "channel_id": 2,
            "channel_type_name": "Alex企业微信"
        },
        {
            "id": 7,
            "name": "钉钉通知",
            "channel": "DingTalk",
            "description": "",
            "target_list": "0217301181107\r\n06401815301228434",
            "channel_name": "钉钉",
            "channel_id": 4,
            "channel_type_name": "Alex钉钉账号"
        },
        {
            "id": 1,
            "name": "测试通知",
            "channel": "Email",
            "description": "",
            "target_list": "31915580@qq.com\r\nalex@shfanxi.com",
            "channel_name": "邮件",
            "channel_id": 1,
            "channel_type_name": "测试用户"
        }
    ]
}

新增通知返回数据例子：

{
    "id": 1,
    "name": "测试通知",
    "channel": "Email",
    "description": "",
    "target_list": "31915580@qq.com\r\nalex@shfanxi.com",
    "channel_name": "邮件",
    "channel_id": 1,
    "channel_type_name": "测试用户"
}

2、获取单个通知，修改通知、删除通知 API¶

请求方式： GET（查询） PUT（修改） PATCH（修改） DELETE（删除）

请求地址： /api/notification/notification/1/

请求地址中1为通知的id

输入/输出参数： 见章节1中输入和输出参数说明，修改数据时输入参数均为非必须

返回数据例子：

{
    "id": 1,
    "name": "测试通知",
    "channel": "Email",
    "description": "",
    "target_list": "31915580@qq.com\r\nalex@shfanxi.com",
    "channel_name": "邮件",
    "channel_id": 1,
    "channel_type_name": "测试用户"
}