4.1.9 获取所有角色
接口说明:
名称 | 内容 |
---|---|
URL | https://xxx/tums/account/v1/queryRoleList |
功能说明 | 获取当前系统中的角色 |
使用限制 | 需要用户管理权限 |
请求参数:
参数名称 | 参数描述 | ||||
---|---|---|---|---|---|
start Integer | 搜索开始的位置,范围不小于0 | ||||
limit Integer | 范围1~1000 | ||||
filterAnd Map | 与条件 可通过关键词“projectEqual”、“nameEqual”和“commonMenuEqual”、“sysMenuEqual”、“sysDefaultEqual”、“projectIn”,分别对项目名、角色名、通用权限、监控权限、系统默认值和角色关联项目包含进行筛选显示。 | ||||
filterOr Map | 或条件 通过关键词“projectLike”对项目名进行模糊匹配,通过关键词“menuLike”对角色权限菜单名进行模糊匹配,通过关键词“nameLike”对角色名进行模糊匹配。 | ||||
sort List | 表示返回数据的排序方式,数组第一个元素是第一优先级,依次降低 限制: 1.可选参数; 2.包含一组key/value,key必须是如下的参数之一:
3.接口中声明的是key的合集,实际调用可以是key的子集; 4.value为asc/desc,分别表升序和降序 |
返回参数
参数名称 | 参数描述 | ||
---|---|---|---|
result | total int | 总数 | |
list list | roleId int | 角色ID | |
roleName String | 角色名 | ||
sysDefault bool | 是否为系统默认角色 | ||
projectList List | 关联的项目信息,包含项目ID和项目名称 | ||
menuList List | 角色可入功能菜单的列表,包含菜单ID和菜单名称 | ||
description String | 可选,角色描述 | ||
error_code | 返回码,0 – 成功,其他- 失败,具体请参考返回码章节 |
代码示例
https://xxx/tums/account/v1/queryRoleList request: { "start":0, "limit":20, "filterAnd":{}, "filterOr":{}, "sort":[] } response: { "result": { "total": 1, "list": [ { "roleId": 7, "roleName": "testRole1", "description": "拥有所有项目的管理和设备操作权限", "sysDefault": 0, "projectList": [ { "projectId": 1, "projectName": "管理中心" } ], "menuList": [ { "menuId": 1, "menuName": "设备管理", "menuUrl": "equipment", "sysType": 0 }, { "menuId": 2, "menuName": "监控设备", "menuUrl": "deviceManager", "sysType": 0, "menuType": 2 }] } ] }, "error_code": 0 }