角色
## 概述
> 角色
类名
`
RoleApi.java
`
成员方法
名称 | 方法 | Method | Path
------------- | ------------- | ------------- | -------------
[添加角色](#addRole) | [**addRole**](#addRole) | POST | /api-organization/role/addRole
[删除角色](#deleteRole) | [**deleteRole**](#deleteRole) | POST | /api-organization/role/deleteRole
[查询角色](#getRole) | [**getRole**](#getRole) | POST | /api-organization/role/getRole
[查询角色列表](#getRoleList) | [**getRoleList**](#getRoleList) | POST | /api-organization/role/getRoleList
[ 修改角色](#updateRole) | [**updateRole**](#updateRole) | POST | /api-organization/role/updateRole
<a id="addRole"></a>
## **添加角色**
> ResultObject addRole(name, type)
添加角色
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**name** | **String**| name | -
**type** | **Integer**| type | -
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化api类，传入token
RoleApi apiInstance = new RoleApi(token);
//实例化请求参数
String name = "name_example";
Integer type = 56;
try {
ResultObject result = apiInstance.addRole(name, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用RoleApi.addRole异常: " + e.getMessage());
e.printStackTrace();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/role/addRole|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"name":"",
"type":0
}
```
<a id="deleteRole"></a>
## **删除角色**
> ResultObject deleteRole(roleId)
删除角色
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**roleId** | **String**| 角色ID | -
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化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();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/role/deleteRole|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"roleId":""
}
```
<a id="getRole"></a>
## **查询角色**
> 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是 | -
**disabled** | **Boolean** | | -
**id** | **String** | 主键id | -
**name** | **String** | 角色名 | -
**remark** | **String** | 备注信息 | -
**type** | **Integer** | 类型:0系统角色，1项目角色 | -
**updatedTime** | **OffsetDateTime** | 修改时间 | -
**userId** | **String** | | -
### java-sdk 调用示例
```java
//实例化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();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/role/getRole|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"roleId":""
}
```
<a id="getRoleList"></a>
## **查询角色列表**
> 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是 | -
**disabled** | **Boolean** | | -
**id** | **String** | 主键id | -
**name** | **String** | 角色名 | -
**remark** | **String** | 备注信息 | -
**type** | **Integer** | 类型:0系统角色，1项目角色 | -
**updatedTime** | **OffsetDateTime** | 修改时间 | -
**userId** | **String** | | -
### java-sdk 调用示例
```java
//实例化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();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/role/getRoleList|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"roleType":0
}
```
<a id="updateRole"></a>
## ** 修改角色**
> ResultObject updateRole(updateRoleForm)
修改角色
### 请求参数
名称 | 类型 | 描述 | 备注
------------- | ------------- | ------------- | -------------
**updateRoleForm** | **UpdateRoleForm**| updateRoleForm |
#### UpdateRoleForm
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**id** | **String** | 角色id(修改时必须要) | -
**name** | **String** | 角色名 |
**type** | **Integer** | 0系统角色,1项目角色,2企业管理,3部门管理,4所有用户通用,5super角色 |
### 返回参数
ResultObject
名称 | 类型 | 描述 | 备注
------------ | ------------- | ------------- | -------------
**code** | **String** | 响应码 | -
**data** | **Object** | 响应数据 | -
**msg** | **String** | 响应消息 | -
**time** | **OffsetDateTime** | 响应时间 | -
### java-sdk 调用示例
```java
//实例化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();
}
```
### HTTP 调用示例
| 属性 | 名称 |
| --------------- | ------------------------ |
| HTTP请求地址 | http://[server]:[port]/api-organization/role/updateRole|
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization|
| header:value |Bearer *YOUR_ACCESS_TOKEN*|
请求参数：
```json
{
"name":"",
"id":"",
"type":0
}
```