工作流通知管理列表

说明

  • 管理工作流通知管理

1、工作流通知管理列表、新增工作流通知管理、批量删除工作流通知管理 API

请求方式: GET(查询) POST(新增) DELETE(批量删除)

请求地址: /api/template/template/notification/

Content-Type:

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

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

查询参数:

参数 数据类型 是否必须 说明
offset int 数据起始位置
limit int 查询条数
name string 项目名称
search string 模糊查询,查询字段为name和description

输入参数(新增):

参数 数据类型 是否必须 说明
template int 模版id
notification int 通知id
notification string 通知id中文名称
notification_channel int 通知渠道
result string 运行结果

输出参数:

参数 数据类型 是否必须 说明
id int id
template int 模版id
notification int 通知id
notification string 通知id中文名称
notification_channel int 通知渠道
result string 运行结果

批量删除参数:

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

排序:

参数 数据类型 是否必须 说明
ordering string
一般默认按id倒叙
  • ordering=id表示按id排序ordering=-id表示按id倒叙
  • 多个字段排序用半角逗号分隔

GET返回数据例子:

{
    "count": 6,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 22,
            "template": 26,
            "notification": 12,
            "notification_name": "notification weixin",
            "notification_channel": "QiYeWeiXin",
            "result": "成功"
        },
        {
            "id": 21,
            "template": 12,
            "notification": 7,
            "notification_name": "钉钉通知",
            "notification_channel": "DingTalk",
            "result": "成功"
            }
        ]
    }

新增工作流通知管理返回数据例子:

{
    "id": 22,
    "template": 26,
    "notification": 12,
    "notification_name": "notification weixin",
    "notification_channel": "QiYeWeiXin",
    "result": "成功"
}

2、获取单个工作流通知管理,修改工作流通知管理、删除工作流通知管理 API

请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)

请求地址: /api/template/template/notification/22/

请求地址中22为工作流通知管理的id

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

返回数据例子:

{
    "id": 22,
    "template": 26,
    "notification": 12,
    "notification_name": "notification weixin",
    "notification_channel": "QiYeWeiXin",
    "result": "成功"
}