团队管理

说明

  • 管理授权权限时默认的团队,用于授权团队中团队名称参数选择的默认值

1、团队列表、新增团队、批量删除团队 API

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

请求地址: /api/system/team/

Content-Type:

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

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

查询参数:

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

输入参数(新增):

参数 数据类型 是否必须 说明
name string 团队名称
description string 描述
username string 用户名
last_name string 名称

输出参数:

参数 数据类型 是否必须 说明
id int 团队id
name string 团队名称
description string 描述
username string 用户名
last_name string 名称

批量删除参数:

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

排序:

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

GET返回数据例子:

{
     "count": 1,
     "next": null,
     "previous": null,
     "results": [
         {
             "id": 1,
             "name": "测试组",
             "description": "测试团队所有成员",
             "users": [
                 {
                     "username": 1,
                     "last_name": "David"
                 },
                 {
                     "username": 5,
                     "last_name": "Mary"
                 }
             ]
         }
     ]
 }

新增团队返回数据例子:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "测试组",
            "description": "测试团队所有成员",
            "users": [
                {
                    "username": 1,
                    "last_name": "David"
                },
                {
                    "username": 5,
                    "last_name": "Mary"
                }
            ]
        }
    ]
}

2、获取单个团队,修改团队、删除团队 API

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

请求地址: /api/system/team/1/

请求地址中1为团队的id

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

返回数据例子:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "测试组",
            "description": "测试团队所有成员",
            "users": [
                {
                    "username": 1,
                    "last_name": "David"
                },
                {
                    "username": 5,
                    "last_name": "Mary"
                }
            ]
        }
    ]
}