VersionUpdate TimeStatusAuthorDescription

1.6

2020/09/16

update

novel

1. 验证码控制器

1.1. 验证码生成

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 验证码生成

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

1.2. 获取项目基本信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取项目基本信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

2. 文件处理接口

2.1. 通用上传请求

Type: POST

Author: novel

Content-Type: application/json; charset=utf-8

Description: 通用上传请求

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

file

file

文件

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

2.2. 查看文件

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查看文件

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

2.3. 通用下载请求

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 通用下载请求

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

fileName

string

文件名称

true

-

delete

boolean

是否删除

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

3. 用户登录控制器

3.1. 用户登录

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 用户登录

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

userName

string

用户名

true

-

password

string

密码

true

-

key

string

验证码key

true

-

code

string

验证码

true

-

rememberMe

boolean

是否记住登录

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

3.2. 注销

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 注销

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

4. 服务器监控

4.1. 获取服务器运行信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取服务器运行信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5. 参数配置 信息操作处理

5.1. 查询参数配置列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查询参数配置列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

configName

string

参数名称

true

-

configKey

string

参数键名

true

-

configValue

string

参数键值

true

-

configType

boolean

系统内置(1是 0否)

true

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

5.2. 新增参数配置

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 新增参数配置

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

configName

string

参数名称

true

-

configKey

string

参数键名

true

-

configValue

string

参数键值

true

-

configType

boolean

系统内置(1是 0否)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5.3. 保存编辑参数配置

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 保存编辑参数配置

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

configName

string

参数名称

true

-

configKey

string

参数键名

true

-

configValue

string

参数键值

true

-

configType

boolean

系统内置(1是 0否)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5.4. 删除参数配置

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除参数配置

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

参数配置ID,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5.5. 校验参数键是否唯一

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验参数键是否唯一

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

configName

string

参数名称

true

-

configKey

string

参数键名

true

-

configValue

string

参数键值

true

-

configType

boolean

系统内置(1是 0否)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5.6. 导出参数配置

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出参数配置

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

configName

string

参数名称

true

-

configKey

string

参数键名

true

-

configValue

string

参数键值

true

-

configType

boolean

系统内置(1是 0否)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

5.7. 根据参数键名查询参数值

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据参数键名查询参数值

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

configKey

string

参数键名 (This is path param)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6. 部门信息

6.1. 部门列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 部门列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

parentId

int64

父部门ID

false

-

ancestors

string

祖级列表

false

-

deptName

string

部门名称

true

-

orderNum

string

显示顺序

true

-

leader

string

负责人

true

-

phone

string

联系电话

true

-

email

string

邮箱

false

-

status

string

部门状态:0正常,1停用

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

parentName

string

父部门名称

false

-

children

array

子部门

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

6.2. 树形部门列表信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 树形部门列表信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

parentId

int64

父部门ID

false

-

ancestors

string

祖级列表

false

-

deptName

string

部门名称

true

-

orderNum

string

显示顺序

true

-

leader

string

负责人

true

-

phone

string

联系电话

true

-

email

string

邮箱

false

-

status

string

部门状态:0正常,1停用

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

parentName

string

父部门名称

false

-

children

array

子部门

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.3. 新增保存部门

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 新增保存部门

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

parentId

int64

父部门ID

false

-

ancestors

string

祖级列表

false

-

deptName

string

部门名称

true

-

orderNum

string

显示顺序

true

-

leader

string

负责人

true

-

phone

string

联系电话

true

-

email

string

邮箱

false

-

status

string

部门状态:0正常,1停用

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

parentName

string

父部门名称

false

-

children

array

子部门

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.4. 编辑部门信息

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 编辑部门信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

parentId

int64

父部门ID

false

-

ancestors

string

祖级列表

false

-

deptName

string

部门名称

true

-

orderNum

string

显示顺序

true

-

leader

string

负责人

true

-

phone

string

联系电话

true

-

email

string

邮箱

false

-

status

string

部门状态:0正常,1停用

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

parentName

string

父部门名称

false

-

children

array

子部门

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.5. 删除部门

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除部门

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

部门id,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.6. 校验部门名称

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验部门名称

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

parentId

int64

父部门ID

false

-

ancestors

string

祖级列表

false

-

deptName

string

部门名称

true

-

orderNum

string

显示顺序

true

-

leader

string

负责人

true

-

phone

string

联系电话

true

-

email

string

邮箱

false

-

status

string

部门状态:0正常,1停用

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

parentName

string

父部门名称

false

-

children

array

子部门

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.7. 加载部门列表树

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载部门列表树

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

6.8. 加载角色部门(数据权限)列表树

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载角色部门(数据权限)列表树

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

any object

object

any object.

-

6.9. 根据id查询部门

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据id查询部门

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

部门id (This is path param)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

7. 系统访问记录

7.1. 查看日志列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查看日志列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户账号

false

-

status

string

登录状态 0成功 1失败

false

-

ipaddr

string

登录IP地址

false

-

loginLocation

string

登录地点

false

-

browser

string

浏览器类型

false

-

os

string

操作系统

false

-

msg

string

提示消息

false

-

loginTime

string

访问时间

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

7.2. 删除登录日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除登录日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

日志id,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

7.3. 清空登录日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空登录日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

7.4. 导出操作日志

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出操作日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户账号

false

-

status

string

登录状态 0成功 1失败

false

-

ipaddr

string

登录IP地址

false

-

loginLocation

string

登录地点

false

-

browser

string

浏览器类型

false

-

os

string

操作系统

false

-

msg

string

提示消息

false

-

loginTime

string

访问时间

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8. 菜单信息

8.1. 加载所有菜单列表树

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载所有菜单列表树

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.2. 加载所有菜单树

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载所有菜单树

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.3. 加载所有菜单树,不含按钮

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载所有菜单树,不含按钮

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.4. 添加菜单信息

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 添加菜单信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

menuName

string

菜单名称

true

-

parentName

string

父菜单名称

false

-

parentId

int64

父菜单ID

false

-

orderNum

string

显示顺序

true

-

url

string

菜单URL

false

-

menuType

string

类型:M目录,C菜单,F按钮

true

-

visible

string

菜单状态:0显示,1隐藏

false

-

perms

string

权限字符串

false

-

icon

string

菜单图标

false

-

component

string

组件地址

false

-

redirect

string

菜单默认路由

false

-

children

array

子菜单

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.5. 修改保存菜单

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改保存菜单

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

menuName

string

菜单名称

false

-

parentName

string

父菜单名称

false

-

parentId

int64

父菜单ID

false

-

orderNum

string

显示顺序

false

-

url

string

菜单URL

false

-

menuType

string

类型:M目录,C菜单,F按钮

false

-

visible

string

菜单状态:0显示,1隐藏

false

-

perms

string

权限字符串

false

-

icon

string

菜单图标

false

-

component

string

组件地址

false

-

redirect

string

菜单默认路由

false

-

children

array

子菜单

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.6. 删除菜单

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除菜单

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

菜单id,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

8.7. 校验菜单名称

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验菜单名称

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

menuName

string

菜单名称

true

-

parentName

string

父菜单名称

false

-

parentId

int64

父菜单ID

false

-

orderNum

string

显示顺序

true

-

url

string

菜单URL

false

-

menuType

string

类型:M目录,C菜单,F按钮

true

-

visible

string

菜单状态:0显示,1隐藏

false

-

perms

string

权限字符串

false

-

icon

string

菜单图标

false

-

component

string

组件地址

false

-

redirect

string

菜单默认路由

false

-

children

array

子菜单

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

9. 操作日志记录

9.1. 系统菜单日志列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 系统菜单日志列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

title

string

操作模块

false

-

businessType

int32

业务类型(0其它 1新增 2修改 3删除)

false

-

method

string

请求方法

false

-

requestMethod

string

请求方式

false

-

operatorType

int32

操作类别(0其它 1后台用户 2手机端用户)

false

-

operName

string

操作人员

false

-

deptName

string

部门名称

false

-

operUrl

string

请求url

false

-

operIp

string

操作地址

false

-

operLocation

string

操作地点

false

-

operParam

string

请求参数

false

-

jsonResult

string

返回参数

false

-

status

int32

操作状态(0正常 1异常)

false

-

processingTime

int64

处理耗时

false

-

errorMsg

string

错误消息

false

-

operTime

string

操作时间

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

9.2. 删除操作日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除操作日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

日志id数组,[array of int32]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

9.3. 清空操作日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空操作日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

9.4. 导出操作日志

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出操作日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

title

string

操作模块

false

-

businessType

int32

业务类型(0其它 1新增 2修改 3删除)

false

-

method

string

请求方法

false

-

requestMethod

string

请求方式

false

-

operatorType

int32

操作类别(0其它 1后台用户 2手机端用户)

false

-

operName

string

操作人员

false

-

deptName

string

部门名称

false

-

operUrl

string

请求url

false

-

operIp

string

操作地址

false

-

operLocation

string

操作地点

false

-

operParam

string

请求参数

false

-

jsonResult

string

返回参数

false

-

status

int32

操作状态(0正常 1异常)

false

-

processingTime

int64

处理耗时

false

-

errorMsg

string

错误消息

false

-

operTime

string

操作时间

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10. 岗位信息操作处理

10.1. 获取岗位列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取岗位列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

true

-

postName

string

岗位名称

true

-

postSort

string

岗位排序

true

-

status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

10.2. 删除岗位信息

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除岗位信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

string

岗位id数组

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10.3. 新增保存岗位

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 新增保存岗位

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

true

-

postName

string

岗位名称

true

-

postSort

string

岗位排序

true

-

status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10.4. 修改保存岗位

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改保存岗位

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

false

-

postName

string

岗位名称

false

-

postSort

string

岗位排序

false

-

status

string

状态(0正常 1停用)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10.5. 校验岗位名称

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验岗位名称

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

true

-

postName

string

岗位名称

true

-

postSort

string

岗位排序

true

-

status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10.6. 校验岗位编码

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验岗位编码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

true

-

postName

string

岗位名称

true

-

postSort

string

岗位排序

true

-

status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

10.7. 导出岗位信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出岗位信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

postCode

string

岗位编码

true

-

postName

string

岗位名称

true

-

postSort

string

岗位排序

true

-

status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

11. 个人信息 业务处理

11.1. 获取当前用户登录信息,用户基本信息、权限、菜单

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取当前用户登录信息,用户基本信息、权限、菜单

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

11.2. 获取当前登录用户详细信息,用户基本信息、部门

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取当前登录用户详细信息,用户基本信息、部门

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

11.3. 修改用户

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改用户

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

false

-

deptId

int64

部门ID

false

-

name

string

用户姓名

false

-

sex

string

用户性别
0=男,1=女,2=未知

false

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

false

-

└─postName

string

岗位名称

false

-

└─postSort

string

岗位排序

false

-

└─status

string

状态(0正常 1停用)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

11.4. 修改密码

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改密码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

oldPassWord

string

旧密码

true

-

newPassWord

string

新密码

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12. 角色信息

12.1. 获取角色列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取角色列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

12.2. 保存编辑角色信息

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 保存编辑角色信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.3. 保存编辑角色信息

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 保存编辑角色信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

false

-

roleKey

string

角色权限

false

-

roleSort

string

角色排序

false

-

status

string

角色状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.4. 删除角色信息

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除角色信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

角色ID,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.5. 加载角色菜单列表树

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 加载角色菜单列表树

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.6. 校验角色名称

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验角色名称

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.7. 校验角色权限

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验角色权限

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

12.8. 导出角色信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出角色信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

roleName

string

角色名称

true

-

roleKey

string

角色权限

true

-

roleSort

string

角色排序

true

-

status

string

角色状态(0正常 1停用)

true

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

menuIds

array

菜单组

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13. 用户操作控制器

13.1. 添加用户信息

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 添加用户信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.2. 删除用户信息

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除用户信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

用户ID数组,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.3. 保存编辑用户信息

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 保存编辑用户信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

false

-

deptId

int64

部门ID

false

-

name

string

用户姓名

false

-

sex

string

用户性别
0=男,1=女,2=未知

false

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

false

-

└─postName

string

岗位名称

false

-

└─postSort

string

岗位排序

false

-

└─status

string

状态(0正常 1停用)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.4. 查询用户列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 查询用户列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

13.5. 获取用户所拥有的角色

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取用户所拥有的角色

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

用户id

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.6. 获取用户所拥有的岗位

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取用户所拥有的岗位

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

用户id

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.7. 根据用户id查询岗位信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 根据用户id查询岗位信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

用户id (This is path param)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.8. 重置密码

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 重置密码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

用户id (This is path param)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.9. 校验用户名

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验用户名

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.10. 校验手机号码

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验手机号码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.11. 校验email邮箱

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验email邮箱

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.12. 导出excel

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出excel

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

userName

string

用户名

true

-

deptId

int64

部门ID

false

-

name

string

用户姓名

true

-

sex

string

用户性别
0=男,1=女,2=未知

true

-

avatar

string

头像

false

-

email

string

邮箱

false

-

phoneNumber

string

手机号码

false

-

age

int32

用户年龄

false

-

status

string

帐号状态(0正常 1停用)

false

-

delFlag

string

删除标志(0代表存在 2代表删除)

false

-

loginIp

string

最后登陆IP

false

-

loginDate

string

最后登陆时间

false

-

roleIds

array

用户的角色Id

false

-

roleName

string

用户的角色名

false

-

permissionCodeList

array

用户的角色对应的权限code

false

-

dept

object

部门对象

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─parentId

int64

父部门ID

false

-

└─ancestors

string

祖级列表

false

-

└─deptName

string

部门名称

true

-

└─orderNum

string

显示顺序

true

-

└─leader

string

负责人

true

-

└─phone

string

联系电话

true

-

└─email

string

邮箱

false

-

└─status

string

部门状态:0正常,1停用

true

-

└─delFlag

string

删除标志(0代表存在 2代表删除)

false

-

└─parentName

string

父部门名称

false

-

└─children

array

子部门

false

-

postIds

array

用户的岗位id

false

-

posts

array

用户的岗位列表

false

-

└─id

int64

Id

false

-

└─createBy

string

创建者

false

-

└─createTime

string

创建时间

false

-

└─updateBy

string

更新者

false

-

└─updateTime

string

更新时间

false

-

└─remark

string

备注

false

-

└─postCode

string

岗位编码

true

-

└─postName

string

岗位名称

true

-

└─postSort

string

岗位排序

true

-

└─status

string

状态(0正常 1停用)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.13. 导入excel

Type: POST

Author: novel

Content-Type: multipart/form-data

Description: 导入excel

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

file

file

导入的excel

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

13.14. 数据导入模板

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 数据导入模板

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

14. 在线用户监控

14.1. 在线用户列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 在线用户列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ipaddr

string

查询条件,ip地址

true

-

userName

string

查询条件,用户名

true

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

14.2. 强退用户

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 强退用户

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

sessionId

string

用户会话id (This is path param)

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

15. 代码生成 操作处理

15.1. 获取数据表信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取数据表信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

tableName

string

表名称

false

-

tableComment

string

表描述

false

-

primaryKey

object

表的主键列信息

false

-

└─columnName

string

字段名称

false

-

└─dataType

string

字段类型

false

-

└─columnComment

string

列描述

false

-

└─attrType

string

Java属性类型

false

-

└─attrName

string

Java属性名称(第一个字母大写),如:user_name => UserName

false

-

└─attrname

string

Java属性名称(第一个字母小写),如:user_name => userName

false

-

└─isPk

string

是否主键(1是)

false

-

└─isIncrement

string

是否自增(1是)

false

-

└─isRequired

string

是否必填(1是)

false

-

└─sort

int32

排序

false

-

columns

array

表的列名(不包含主键)

false

-

└─columnName

string

字段名称

false

-

└─dataType

string

字段类型

false

-

└─columnComment

string

列描述

false

-

└─attrType

string

Java属性类型

false

-

└─attrName

string

Java属性名称(第一个字母大写),如:user_name => UserName

false

-

└─attrname

string

Java属性名称(第一个字母小写),如:user_name => userName

false

-

└─isPk

string

是否主键(1是)

false

-

└─isIncrement

string

是否自增(1是)

false

-

└─isRequired

string

是否必填(1是)

false

-

└─sort

int32

排序

false

-

className

string

类名(第一个字母大写)

false

-

classname

string

类名(第一个字母小写)

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

15.2. 生成代码

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 生成代码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

tableName

string

表名 (This is path param)

true

-

15.3. 批量生成代码

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 批量生成代码

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

tableNames

array

表名数组,[array of string]

true

16. 调度任务信息操作处理

16.1. 获取任务列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 获取任务列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

16.2. 删除任务

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除任务

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

任务id数组,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.3. 任务调度状态修改

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 任务调度状态修改

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.4. 任务调度立即执行一次

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 任务调度立即执行一次

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.5. 新增保存调度

Type: POST

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 新增保存调度

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.6. 修改保存调度

Type: PUT

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 修改保存调度

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.7. 校验cron表达式是否有效

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 校验cron表达式是否有效

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

16.8. 导出定时任务信息

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出定时任务信息

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

true

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

true

-

cronExpression

string

cron执行表达式

true

-

misfirePolicy

string

cron计划策略

false

-

concurrent

string

是否并发执行(0允许 1禁止)

false

-

status

string

任务状态(0正常 1暂停)

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

17. 调度日志操作处理

17.1. 任务日志列表

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 任务日志列表

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

false

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

false

-

jobMessage

string

日志信息

false

-

status

string

执行状态(0正常 1失败)

false

-

exceptionInfo

string

异常信息

false

-

startTime

string

开始时间

false

-

endTime

string

结束时间

false

-

Response-fields:

FieldTypeDescriptionSince

total

int64

总记录数

-

rows

array

列表数据

-

code

int32

响应代码

-

17.2. 删除任务日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 删除任务日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

任务日志id数组,[array of int64]

true

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

17.3. 清空任务日志

Type: DELETE

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 清空任务日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-

17.4. 导出任务日志

Type: GET

Author: novel

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 导出任务日志

Request-headers:

HeaderTypeDescriptionRequiredSince

authorization

string

用户认证token

true

-

Request-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

Id

false

-

createBy

string

创建者

false

-

createTime

string

创建时间

false

-

updateBy

string

更新者

false

-

updateTime

string

更新时间

false

-

remark

string

备注

false

-

jobName

string

任务名称

false

-

jobGroup

string

任务组名

false

-

invokeTarget

string

调用目标字符串

false

-

jobMessage

string

日志信息

false

-

status

string

执行状态(0正常 1失败)

false

-

exceptionInfo

string

异常信息

false

-

startTime

string

开始时间

false

-

endTime

string

结束时间

false

-

Response-fields:

FieldTypeDescriptionSince

code

int32

响应代码

-

result

boolean

结果状态,true成功,false:失败

-

msg

string

响应消息

-

data

object

响应数据

-