角色

# 概述

角色API 角色分为项目与系统两种，项目角色主要用于对项目资源的权限控制，系统角色用于除项目资源外的所有资源的权限控制该API提供了对角色本体的CRUD

类名

RoleApi.java

成员方法

名称	方法	Method	Path
添加角色	addRole	POST	/api-organization/role/addRole
删除角色	deleteRole	POST	/api-organization/role/deleteRole
查询有权限的角色列表	getAuthRoleList	POST	/api-organization/role/getAuthRoleList
查询当前登录用户的角色列表	getLoginUserRole	POST	/api-organization/role/getLoginUserRole
查询角色	getRole	POST	/api-organization/role/getRole
查询角色列表	getRoleList	POST	/api-organization/role/getRoleList
查询角色列表	getRoleListV2	POST	/api-organization/role/getRoleListV2
修改角色	updateRole	POST	/api-organization/role/updateRole

# 添加角色

ResultObject addRole(departmentId, name, rangeType, type)

添加角色

# 请求参数

名称	类型	描述	备注
departmentId	String	部门ID	-
name	String	角色名称	-
rangeType	Integer	角色范围	-
type	Integer	角色类型	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
String departmentId = "departmentId_example";
String name = "name_example";
Integer rangeType = 56;
Integer type = 56;

try {
    ResultObject result = apiInstance.addRole(departmentId, name, rangeType, type);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.addRole异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/addRole
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"departmentId":"",
	"name":"",
	"rangeType":0,
	"type":0
}

1
2
3
4
5
6

# 删除角色

ResultObject deleteRole(roleId)

删除角色

# 请求参数

名称	类型	描述	备注
roleId	String	角色ID

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
String roleId = "roleId_example";

try {
    ResultObject result = apiInstance.deleteRole(roleId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.deleteRole异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/deleteRole
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleId":""
}

1
2
3

# 查询有权限的角色列表

ResultListRole getAuthRoleList(roleType)

根据角色类型查询角色列表

# 请求参数

名称	类型	描述	备注
roleType	Integer	角色类型(0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色,6超级管理员,7个人企业)

# 返回参数

ResultListRole

名称	类型	描述	备注
code	String	响应码	-
data	List<Role>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Role

名称	类型	描述	备注
areaId	List<String>		-
companyId	String	企业标识	-
controlTypeId	List<String>		-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认:0否,1是	-
departmentId	String	部门id	-
disabled	Boolean		-
id	String	主键id	-
name	String	角色名	-
rangeType	Integer	范围 0公共的、1私有的	-
remark	String	备注信息	-
type	Integer	类型:0系统角色，1项目角色	-
updatedTime	OffsetDateTime	修改时间	-
userId	String		-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
Integer roleType = 56;

try {
    ResultListRole result = apiInstance.getAuthRoleList(roleType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.getAuthRoleList异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/getAuthRoleList
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleType":0
}

1
2
3

# 查询当前登录用户的角色列表

ResultListString getLoginUserRole(roleType)

查询当前登录用户的角色列表

# 请求参数

名称	类型	描述	备注
roleType	Integer	角色类型(0系统角色,1项目角色)

# 返回参数

ResultListString

名称	类型	描述	备注
code	String	响应码	-
data	List<String>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
Integer roleType = 56;

try {
    ResultListString result = apiInstance.getLoginUserRole(roleType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.getLoginUserRole异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/getLoginUserRole
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleType":0
}

1
2
3

# 查询角色

ResultRole getRole(roleId)

根据id查询角色

# 请求参数

名称	类型	描述	备注
roleId	String	角色ID

# 返回参数

ResultRole

名称	类型	描述	备注
code	String	响应码	-
data	Role	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Role

名称	类型	描述	备注
areaId	List<String>		-
companyId	String	企业标识	-
controlTypeId	List<String>		-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认:0否,1是	-
departmentId	String	部门id	-
disabled	Boolean		-
id	String	主键id	-
name	String	角色名	-
rangeType	Integer	范围 0公共的、1私有的	-
remark	String	备注信息	-
type	Integer	类型:0系统角色，1项目角色	-
updatedTime	OffsetDateTime	修改时间	-
userId	String		-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
String roleId = "roleId_example";

try {
    ResultRole result = apiInstance.getRole(roleId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.getRole异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/getRole
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleId":""
}

1
2
3

# 查询角色列表

ResultListRole getRoleList(roleType)

根据角色类型查询角色列表

# 请求参数

名称	类型	描述	备注
roleType	Integer	角色类型(0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色,6超级管理员,7个人企业)

# 返回参数

ResultListRole

名称	类型	描述	备注
code	String	响应码	-
data	List<Role>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Role

名称	类型	描述	备注
areaId	List<String>		-
companyId	String	企业标识	-
controlTypeId	List<String>		-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认:0否,1是	-
departmentId	String	部门id	-
disabled	Boolean		-
id	String	主键id	-
name	String	角色名	-
rangeType	Integer	范围 0公共的、1私有的	-
remark	String	备注信息	-
type	Integer	类型:0系统角色，1项目角色	-
updatedTime	OffsetDateTime	修改时间	-
userId	String		-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
Integer roleType = 56;

try {
    ResultListRole result = apiInstance.getRoleList(roleType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.getRoleList异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/getRoleList
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleType":0
}

1
2
3

# 查询角色列表

ResultListDepartment getRoleListV2(roleType)

根据角色类型查询角色列表

# 请求参数

名称	类型	描述	备注
roleType	Integer	角色类型(0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色,6超级管理员,7个人企业)

# 返回参数

ResultListDepartment

名称	类型	描述	备注
code	String	响应码	-
data	List<Department>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

Department

名称	类型	描述	备注
children	List<Department>	子部门	-
companyId	String	企业id	-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
id	String	主键	-
maintenanceType	Integer	部门类型 0普通部门 1维保部门	-
name	String	名称	-
parentId	String	父级id	-
remark	String	备注	-
roles	List<Role>	角色	-
sort	Integer	排序号	-
updatedTime	OffsetDateTime	修改时间	-

Department

名称	类型	描述	备注
children	List<Department>	子部门	-
companyId	String	企业id	-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
id	String	主键	-
maintenanceType	Integer	部门类型 0普通部门 1维保部门	-
name	String	名称	-
parentId	String	父级id	-
remark	String	备注	-
roles	List<Role>	角色	-
sort	Integer	排序号	-
updatedTime	OffsetDateTime	修改时间	-

Role

名称	类型	描述	备注
areaId	List<String>		-
companyId	String	企业标识	-
controlTypeId	List<String>		-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认:0否,1是	-
departmentId	String	部门id	-
disabled	Boolean		-
id	String	主键id	-
name	String	角色名	-
rangeType	Integer	范围 0公共的、1私有的	-
remark	String	备注信息	-
type	Integer	类型:0系统角色，1项目角色	-
updatedTime	OffsetDateTime	修改时间	-
userId	String		-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
Integer roleType = 56;

try {
    ResultListDepartment result = apiInstance.getRoleListV2(roleType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.getRoleListV2异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/getRoleListV2
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"roleType":0
}

1
2
3

# 修改角色

ResultObject updateRole(updateRoleForm)

修改角色

# 请求参数

名称	类型	描述	备注
updateRoleForm	UpdateRoleForm	updateRoleForm

# UpdateRoleForm

名称	类型	描述	备注
departmentId	String	部门ID
id	String	角色id(修改时必须要)	-
name	String	角色名
rangeType	Integer	0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色
type	Integer	0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
UpdateRoleForm updateRoleForm = new UpdateRoleForm();

try {
    ResultObject result = apiInstance.updateRole(updateRoleForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用RoleApi.updateRole异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/role/updateRole
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"rangeType":0,
	"departmentId":"",
	"name":"",
	"id":"",
	"type":0
}

1
2
3
4
5
6
7

← 用户部门→

角色

# 概述

# 添加角色

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 删除角色

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询有权限的角色列表

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询当前登录用户的角色列表

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询角色

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询角色列表

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 查询角色列表

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# ** 修改角色**

# 请求参数

# UpdateRoleForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 修改角色