3.1统一用户管理 | 智慧教育基座赋能平台

# 3.1统一用户管理

# 3.1.1获取用户信息

调用地址（GET）:

http://ip:port/api/apicenter/api/user/userinfo

请求参数：

参数名	类型	描述	为空
userName	String	用户工号	必填

请求示例（Query）：

?userName=yyh

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.profile.userId	用户id
data.profile.sex	性别
data.profile.avatar	头像地址
data.profile.username	用户工号
data.profile.nick	用户昵称
data.profile.phonenumber	用户手机号
data.roles.id	角色id
data.roles.name	角色名称
data.roles.code	角色代码
data.roles.deptId	部门id
data.roles.deptCode	部门代码
data.roles.deptName	部门名称
data.roles.dataScope	数据范围(1.全部数据权限,3.部门数据权限,4.部门及以下数据权限,5.个人数据权限)
data.roles.permissions	权限集合
data.roles.deptIds	权限部门集合
data.recordTime	请求记录时间

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "profile": {
            "userId": 47262,
            "sex": "男",
            "avatar": "",
            "username": "yyh",
            "nick": "nick"
        },
        "roles": [
            {
                "id": 112,
                "name": "网办普通用户",
                "code": "wb:user",
                "deptId": 0,
                "deptCode": null,
                "deptName": null,
                "dataScope": "1",
                "permissions": [
                    "swgl:dbsx:interrupt",
                    "wb:front:wfqd"
                ],
                "deptIds": []
            }
        ],
        "recordTime": "2022-09-19T20:24:25.881+08:00"
    }
}

# 3.1.2获取用户的所有权限标识

调用地址（GET）：

http://ip:port/api/apicenter/api/user/permissions

请求参数：

参数名	类型	描述	为空
userName	String	用户工号	必填

请求示例（Query）：

?userName=yyh

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.id	权限id
data.pid	父级权限id
data.name	权限名称
data.code	权限代码
data.type	菜单类型（M目录 C菜单 F按钮）

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": [
        {
            "id": 3997,
            "pid": 0,
            "name": "网办系统",
            "code": "wb",
            "type": "M",
            "orderNum": 1,
            "path": null
        }
    ]
}

# 3.1.3获取所有用户列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllUser

请求参数：

参数名	类型	描述
pageNum	Integer	当前页
pageSize	Integer	每页数量
deptId	Long	部门id

请求示例（json body）：

{
    "pageNum": 1,
    "pageSize": 1,
    "deptId": 1054
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.userId	用户id
rows.avatar	头像地址
data.username	用户工号
data.nick	用户昵称
data.authApp	是否授权应用

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 36,
    "rows": [
        {
            "userId": 1,
            "sex": "女",
            "avatar": "",
            "username": "admin",
            "nick": "半云admin",
            "authApp": false
        }
    ],
    "pageNum": 36,
    "pageSize": 1,
    "currPage": 1
}

# 3.1.4获取用户的角色部门授权信息

调用地址（GET）：

http://ip:port/api/apicenter/api/user/deptRoles

请求参数：

参数名	类型	描述	为空
userName	String	用户工号	必填

请求示例（Query）：

?userName=yyh

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.id	角色id
data.name	角色名称
data.code	角色代码
data.deptCode	部门代码
data.deptName	部门名称
data.dataScope	数据范围(1.全部数据权限,3.部门数据权限,4.部门及以下数据权限,5.个人数据权限)

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": [
        {
            "id": 112,
            "name": "网办普通用户",
            "code": "wb:user",
            "deptId": null,
            "deptCode": null,
            "deptName": null,
            "dataScope": "1"
        }
    ]
}

# 3.2统一角色管理

# 3.2.1获取客户端角色详情

调用地址（GET）：

http://ip:port/api/apicenter/api/client/role/{roleId}

请求参数：

参数名	类型	描述	为空
roleId	Long	角色id	必填

请求示例（Path）：

roleId=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.id	角色id
data.name	角色名称
data.code	角色代码
data.permissions	角色拥有的权限代码集合

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "id": 112,
        "name": "网办普通用户",
        "code": "wb:user",
        "permissions": [
            "wb:front:dbsx"
        ]
    }
}

# 3.2.2获取认证角色列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllRole

请求参数：

参数名	类型	描述	为空
pageNum	Integer	当前页
pageSize	Integer	每页数量

请求示例（Query）：

?pageNum=1&pageSize=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.id	角色id
rows.name	角色名称
data.code	角色代码

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 8,
    "rows": [
        {
            "id": 2,
            "name": "普通用户",
            "code": "normal_user"
        }
    ],
    "pageNum": 8,
    "pageSize": 1,
    "currPage": 1
}

# 3.2.3判断用户是否拥有角色

调用地址（GET）：

http://ip:port/api/apicenter/api/user/hasRole

请求参数：

参数名	类型	描述	为空
userName	String	用户工号	必填
roleKey	String	角色代码	必填

请求示例（Query）：

??userName=yyh&roleKey=wb:admin

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	无

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

错误示例：

{
    "msg": "当前角色不存在,请刷新重试",
    "code": 500
}

{
    "msg": "用户没有当前角色权限!",
    "code": 500
}

# 3.3统一部门管理

# 3.3.1获取部门详情

调用地址（GET）：

http://ip:port/api/apicenter/api/user/deptDetailById

请求参数：

参数名	类型	描述	为空
id	Long	部门id	必填

请求示例（Query）：

?id=10643

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.id	部门id
data.pid	父部门id
data.name	部门名称
data.code	部门代码
data.type	部门类型(0其他1二级学院2年级3班级4科研机构5专业6学科建设7科研团队8研究中心)

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "id": 10643,
        "pid": 1054,
        "name": "部门001",
        "code": "bm001",
        "type": "1"
    }
}

# 3.3.2获取认证部门列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllDept

请求参数：

参数名	类型	描述	为空
pageNum	Integer	当前页
pageSize	Integer	每页数量

请求示例（Query）：

?pageNum=1&pageSize=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.id	部门id
rows.pid	父部门id
data.name	部门名称
data.code	部门代码
data.type	部门类型(0其他1二级学院2年级3班级4科研机构5专业6学科建设7科研团队8研究中心)

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 10,
    "rows": [
        {
            "id": 1054,
            "pid": 0,
            "name": "华南女院",
            "code": "0",
            "type": "0"
        }
    ],
    "pageNum": 10,
    "pageSize": 1,
    "currPage": 1
}

# 3.4应用授权集成规范

# 3.4.1获取应用用户列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllUserByApp

请求参数：

参数名	类型	描述
pageNum	Integer	当前页
pageSize	Integer	每页数量
deptId	Long	部门id

请求示例（Query）：

?pageNum=1&pageSize=1&deptId=1054

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.userId	用户id
rows.avatar	头像地址
data.username	用户工号
data.nick	用户昵称

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 36,
    "rows": [
        {
            "userId": 1,
            "sex": "女",
            "avatar": "",
            "username": "admin",
            "nick": "半云admin"
        }
    ],
    "pageNum": 36,
    "pageSize": 1,
    "currPage": 1
}

# 3.4.2获取应用角色列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllRoleByApp

请求参数（Query）：

参数名	类型	描述	为空
pageNum	Integer	当前页
pageSize	Integer	每页数量

请求示例：

?pageNum=1&pageSize=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.id	角色id
rows.name	角色名称
data.code	角色代码

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 8,
    "rows": [
        {
            "id": 2,
            "name": "普通用户",
            "code": "normal_user"
        }
    ],
    "pageNum": 8,
    "pageSize": 1,
    "currPage": 1
}

# 3.4.3获取应用部门列表

调用地址（GET）：

http://ip:port/api/apicenter/api/user/getAllDeptByApp

请求参数：

参数名	类型	描述	为空
pageNum	Integer	当前页
pageSize	Integer	每页数量

请求示例（Query）：

?pageNum=1&pageSize=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数量
pageNum	总页数
pageSize	当前数量
currPage	当前页
rows.id	部门id
rows.pid	父部门id
data.name	部门名称
data.code	部门代码
data.type	部门类型(0其他1二级学院2年级3班级4科研机构5专业6学科建设7科研团队8研究中心)

返回示例：

{
    "code": 0,
    "msg": null,
    "total": 10,
    "rows": [
        {
            "id": 1054,
            "pid": 0,
            "name": "华南女院",
            "code": "0",
            "type": "0"
        }
    ],
    "pageNum": 10,
    "pageSize": 1,
    "currPage": 1
}

# 3.4.4获取用户在本应用的角色部门授权信息

调用地址（GET）：

http://ip:port/api/apicenter/api/user/deptRoles

请求参数：

参数名	类型	描述	为空
userName	String	用户工号	必填

请求示例（Query）：

?userName=yyh

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.id	角色id
data.name	角色名称
data.code	角色代码
data.deptCode	部门代码
data.deptName	部门名称
data.dataScope	数据范围(1.全部数据权限,3.部门数据权限,4.部门及以下数据权限,5.个人数据权限)

返回示例：

{
    "code": 0,
    "msg": "请求成功",
    "data": [
        {
            "id": 112,
            "name": "网办普通用户",
            "code": "wb:user",
            "deptId": null,
            "deptCode": null,
            "deptName": null,
            "dataScope": "1"
        }
    ]
}

# 3.4.5更新本应用角色数据权限信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateRoleDataScope

请求参数

参数名	描述	类型	为空	备注
roleId	角色id	Long	必填
dataScope	权限范围	String	必填	1=所有数据权限,2=自定义数据权限,3=本部门数据权限,4=本部门及以下数据权限
deptIds	自定义数据权限时的部门id	List< Long >		当权限范围为自定义数据权限时传递

请求示例（json-body）

{
    "roleId": 483,
    "dataScope": 2,
    "deptIds": [15954]
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.6更新本应用角色菜单授权

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateRoleMenu

请求参数

参数名	描述	类型	为空	备注
roleId	角色id	Long	必填
menuId	菜单id	Long	必填

请求示例（json-body）

[{
    "roleId": 482,
    "menuId": 5814
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.7更新本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateDept

请求参数

参数名	描述	类型	为空
deptId	部门id	Long	必填
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）

{
  "deptId": 1054,
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum":2
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.8批量更新本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateDeptBatch

请求参数

参数名	描述	类型	为空
deptId	部门id	Long	必填
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）

[{
  "deptId": 15954,
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum":2
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.9更新本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateMenu

请求参数

参数名	描述
menuId	菜单id
parentId	上级菜单id
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

{
    "menuId": 209
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.10批量更新本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateMenuBatch

请求参数

参数名	描述
menuId	菜单id
parentId	上级菜单id（空时填0）
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

[{
    "menuId": 209
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.11更新本应用角色信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/updateRole

请求参数

参数名	描述	类型	为空
roleId	角色id	Long	必填
roleName	角色名称	String	必填
roleKey	角色标识	String	必填
roleSort	排序	Integer

请求示例（json body）

{
    "roleId": 401,
    "roleName": "测试角色",
    "roleKey": "role:test",
    "roleSort": 1
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.12批量删除本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/deleteMenuBatch

请求参数

参数名	描述	类型	为空	备注
menuId	菜单	Long	必填

请求示例（json-data）

[209]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.13删除本应用角色信息

调用地址（GET）：

http://ip:port/api/apicenter/api/client/deleteRole

请求参数

参数名	描述	类型	为空	备注
roleId	角色id	Long	必填

请求示例（Query）

?roleId=481

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.14批量删除本应用角色信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/deleteRoleBatch

请求参数

参数名	描述	类型	为空	备注
roleId	角色id	Long	必填

请求示例（json body）

[482]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.15删除授权本应用用户权限

调用地址（POST）：

http://ip:port/api/apicenter/api/client/deleteUserAuth

请求参数

参数名	描述	类型	为空
userId	用户id	Long	必填
deptId	部门id	Long	必填
roleId	角色id	Long	必填

请求示例（json body）

[{
    "userId": 101,
    "deptId": 1054,
    "roleId": 10
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.16获取本应用菜单列表

调用地址（GET）：

http://ip:port/api/apicenter/api/client/menus

请求示例（json body）

{}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.menuId	菜单id
data.parentId	上级菜单id
data.menuName	菜单名称
data.menuType	菜单类型（M.目录 C.菜单 F.按钮）
data.menuKey	路由唯一键
data.redirect	重定向定制
data.perms	权限标识
data.orderNum	菜单排序
data.visible	显示状态（0.显示 1.隐藏）

返回示例：

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "menuId": 5811,
            "menuName": "父菜单",
            "parentId": 0,
            "orderNum": "1",
            "menuType": "C",
            "visible": "1",
            "perms": "auth:key:demo",
            "menuKey": "parent",
            "redirect": "/DataDevelop/DataSourceManage"
        },
        {
            "menuId": 5812,
            "menuName": "子菜单",
            "parentId": 5811,
            "orderNum": "1",
            "menuType": "M",
            "visible": "0",
            "perms": "",
            "menuKey": "child",
            "redirect": "/wb/myAppFront/myAppList",
        }
    ]
}

# 3.4.17批量新增本应用角色信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addRoleBatch

请求参数

参数名	描述	类型	为空
roleName	角色名称	String	必填
roleKey	角色标识	String	必填
roleSort	排序	Integer

请求示例（json body）

[{
    "roleName": "测试角色",
    "roleKey": "role:test",
    "roleSort": 1
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增后的角色id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": [10]
}

# 3.4.18授权本应用用户权限

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addUserAuth

请求参数

参数名	描述	类型	为空
userId	用户id	Long	必填
deptId	部门id	Long	必填
roleId	角色id	Long	必填

请求示例（json body）

[{
    "userId": 101,
    "deptId": 1054,
    "roleId": 10
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.20删除本应用部门信息

调用地址（GET）：

http://ip:port/api/apicenter/api/client/deleteDept

请求参数

参数名	描述	类型	为空	备注
deptId	部门id	Long	必填

请求示例（Query）

?deptId=1054

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.21批量删除本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/deleteDept

请求参数

参数名	描述	类型	为空	备注
deptId	部门id	Long	必填

请求示例（json body）

[15954]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.22删除本应用菜单信息

调用地址（GET）：

http://ip:port/api/apicenter/api/client/deleteMenu

请求参数

参数名	描述	类型	为空	备注
menuId	菜单	Long	必填

请求示例（Query）

?menuId=209

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.23新增本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addDept

请求参数

参数名	描述	类型	为空
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）

{
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum": 1
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增的部门id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": 15953
}

# 3.4.24批量新增本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addDeptBatch

请求参数

参数名	描述	类型	为空
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）

[{
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum":1
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增的部门id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": [15954]
}

# 3.4.25新增本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addMenu

请求参数

参数名	描述
parentId	上级菜单id
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

{
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增后的菜单id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": 5815
}

# 3.4.26批量新增本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addMenuBatch

请求参数

参数名	描述
parentId	上级菜单id（空时填0）
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

[{
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.27授权本应用用户权限

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addUserAuth

请求参数

参数名	描述	类型	为空
userId	用户id	Long	必填
deptId	部门id	Long	必填
roleId	角色id	Long	必填

请求示例（json body）

[{
    "userId": 101,
    "deptId": 1054,
    "roleId": 10
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.28删除本应用部门信息

调用地址（GET）：

http://ip:port/api/apicenter/api/client/deleteDept

请求参数

参数名	描述	类型	为空	备注
deptId	部门id	Long	必填

请求示例（Query）

?deptId=1054

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.29批量删除本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/deleteDept

请求参数

参数名	描述	类型	为空	备注
deptId	部门id	Long	必填

请求示例（json body）

[15954]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.30删除本应用菜单信息

调用地址（GET）：

http://ip:port/api/apicenter/api/client/deleteMenu

请求参数

参数名	描述	类型	为空	备注
menuId	菜单	Long	必填

请求示例（Query）

?menuId=209

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.31新增本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addDept

请求参数

参数名	描述	类型	为空
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）


{
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum": 1
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增的部门id

返回示例


{
  "code": 0,
  "msg": "操作成功",
  "data": 15953
}

# 3.4.32批量新增本应用部门信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addDeptBatch

请求参数

参数名	描述	类型	为空
deptName	部门名称	String	必填
parentId	上级部门id	String
deptNo	部门编号	String
orderNum	排序	Integer

请求示例（json body）

[{
  "deptName": "测试部门",
  "parentId": null,
  "deptNo": "0",
  "orderNum":1
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增的部门id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": [15954]
}

# 3.4.33新增本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addMenu

请求参数

参数名	描述
parentId	上级菜单id
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

{
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增后的菜单id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": 5815
}

# 3.4.34批量新增本应用菜单信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addMenuBatch

请求参数

参数名	描述
parentId	上级菜单id（空时填0）
menuName	菜单名称
menuType	菜单类型（M.目录 C.菜单 F.按钮）
menuKey	路由唯一键
redirect	重定向定制
perms	权限标识
orderNum	菜单排序
visible	显示状态（0.显示 1.隐藏）

请求示例（json body）：

[{
	"menuName": "父菜单",
	"parentId": 0,
	"orderNum": "1",
	"menuType": "C",
	"visible": "1",
	"perms": "auth:key:demo",
	"menuKey": "parent",
	"redirect": "/DataDevelop/DataSourceManage"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": null
}

# 3.4.35新增本应用角色信息

调用地址（POST）：

http://ip:port/api/apicenter/api/client/addRole

请求参数

参数名	描述	类型	为空
roleName	角色名称	String	必填
roleKey	角色标识	String	必填
roleSort	排序	Integer

请求示例（json body）

{
    "roleName": "测试角色",
    "roleKey": "role:test",
    "roleSort": 1
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	新增后的角色id

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": 401
}

# 3.4.36删除该菜单和其角色关联下的所有菜单

调用地址（DELETE）：

http://ip:port/api/system/menu/three/{menuId}

请求参数

参数名	描述	类型	为空	备注
menuId	菜单id	String	必填

请求示例（Path）

menuId=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data

返回示例

{
  "code": 0,
  "msg": "操作成功",
  "data": 401
}

# 3.5消息中心集成规范

# 3.5.1获取全部消息通道列表

调用地址（GET）

http://ip:port/api/apicenter/api/message/channel/listAll

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data.name	通道名称
data.code	通道编码
data.type	通道类型(mail:邮件 dingTalk:钉钉工作通知 vx:企业微信工作通知 vxProgress:微信公众号)

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": [
        {
            "name": "QQ邮件通道",
            "code": "MC00001",
            "type": "mail"
        },
        {
            "name": "钉钉通道",
            "code": "MC00002",
            "type": "dingTalk"
        },
        {
            "name": "企业微信",
            "code": "MC00003",
            "type": "vx"
        },
        {
            "name": "微信公众号通道",
            "code": "MC00004",
            "type": "vxProgress"
        }
    ]
}

# 3.5.2发送消息

调用地址（POST）

http://ip:port/api/apicenter/api/notice/push

请求参数

参数名	描述	类型	为空	备注
userName	操作人员工号	String	必填
title	消息标题	String	必填
content	消息内容	String	必填
availableTimeStart	通知有效期开始时间	String	必填
availableTimeEnd	通知有效期结束时间	String	必填
userIds	接收用户id集合	String		多个时有逗号(,)分割
roleIds	接收角色id集合	String		多个时有逗号(,)分割
deptIds	接收部门id集合	String		多个时有逗号(,)分割
channelCodes	外部消息通道编号集合	String		多个时有逗号(,)分割，没有填写则只发送系统通知

请求示例（json body）

{
    "userName": "admin",
    "title": "测试标题",
    "content": "内容",
    "availableTimeStart": "2022-10-10",
    "availableTimeEnd": "2023-10-10",
    "userIds": "1",
    "channelCodes": "MC00001"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	通知id

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": 4
}

# 3.5.3发送邮件

调用地址（POST）

http://ip:port/api/apicenter/api/message/sendEmail

请求参数

参数名	描述	类型	为空
sendTo	邮件地址	List< String >	必填
subject	标题	String	必填
content	内容	String	必填

请求示例（json body）

{
    "sendTo": ["xx@qq.com"],
    "subject": "标题",
    "content": "内容"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.4批量发送邮件

调用地址（POST）

http://ip:port/api/apicenter/api/message/sendEmailBatch

请求参数

参数名	描述	类型	为空
sendTo	邮件地址	List< String >	必填
subject	标题	String	必填
content	内容	String	必填

请求示例（json body）

[{
    "sendTo": ["xx@qq.com"],
    "subject": "标题",
    "content": "内容"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.5发送短信验证码

调用地址（GET）

http://ip:port/api/apicenter/api/message/sendSMSCaptcha

请求参数

参数名	描述	类型	为空	备注
sendTo	发送手机号	String	必填
content	验证码内容	String	必填

请求示例（Query）

?sendTo=13000000000&content=123456

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.6发送短信

调用地址（POST）

http://ip:port/api/apicenter/api/message/sendSMSContent

请求参数

参数名	描述	类型	为空	备注
sendToList	接受手机号集合	List< String >	必填
content	验证码内容	String	必填

请求示例（json body）

{
    "sendToList": ["13000000000", "13000000001"],
    "content": "保护环境"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.7删除消息通知(本应用)

调用地址（GET）

http://ip:port/api/apicenter/api/notice/delete

请求参数

参数名	描述	类型	为空	备注
id	通知id	Long	必填

请求示例（Query）

?id=4

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.8批量删除消息通知(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/notice/deleteBatch

请求参数

参数名	描述	类型	为空	备注
id	通知id	Long	必填

请求示例（json body）

[10]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.9删除公告(本应用)

调用地址（GET）

http://ip:port/api/apicenter/api/gg/delete

请求参数

参数名	描述	类型	为空	备注
id	公告id	Long	必填

请求示例（Query）

?id=4187

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.10批量删除公告(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/gg/deleteBatch

请求参数

参数名	描述	类型	为空	备注
id	公告id	Long	必填

请求示例（json body）

[4188]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.5.11发送公告(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/gg/push

请求参数

参数名	描述	类型	为空
userName	操作人员工号	String	必填
title	消息标题	String	必填
content	消息内容	String	必填
availableTimeStart	通知有效期开始时间	String	必填
availableTimeEnd	通知有效期结束时间	String	必填

请求示例（json body）

{
    "userName": "admin",
    "title": "测试标题",
    "content": "内容",
    "availableTimeStart": "2022-10-10",
    "availableTimeEnd": "2023-10-10"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	公告id

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": 4
}

# 3.5.12批量发送公告(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/gg/pushBatch

请求参数

参数名	描述	类型	为空
userName	操作人员工号	String	必填
title	消息标题	String	必填
content	消息内容	String	必填
availableTimeStart	通知有效期开始时间	String	必填
availableTimeEnd	通知有效期结束时间	String	必填

请求示例（json body）

[{
    "userName": "admin",
    "title": "测试标题",
    "content": "内容",
    "availableTimeStart": "2022-10-10",
    "availableTimeEnd": "2023-10-10"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	通知id

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": [4187]
}

# 3.5.13发送消息通知(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/notice/push

请求参数

参数名	描述	类型	为空	备注
userName	操作人员工号	String	必填
title	消息标题	String	必填
content	消息内容	String	必填
availableTimeStart	通知有效期开始时间	String	必填
availableTimeEnd	通知有效期结束时间	String	必填
userIds	接收用户id集合	String		多个时有逗号(,)分割
roleIds	接收角色id集合	String		多个时有逗号(,)分割
deptIds	接收部门id集合	String		多个时有逗号(,)分割
channelCodes	外部消息通道编号集合	String		多个时有逗号(,)分割，没有填写则只发送系统通知

请求示例（json body）

{
    "userName": "admin",
    "title": "测试标题",
    "content": "内容",
    "availableTimeStart": "2022-10-10",
    "availableTimeEnd": "2023-10-10",
    "userIds": "1",
    "channelCodes": "MC00001"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	通知id

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": 4
}

# 3.5.14批量发送消息通知(本应用)

调用地址（POST）

http://ip:port/api/apicenter/api/notice/pushBatch

请求参数

参数名	描述	类型	为空	备注
userName	操作人员工号	String	必填
title	消息标题	String	必填
content	消息内容	String	必填
availableTimeStart	通知有效期开始时间	String	必填
availableTimeEnd	通知有效期结束时间	String	必填
userIds	接收用户id集合	String		多个时有逗号(,)分割
roleIds	接收角色id集合	String		多个时有逗号(,)分割
deptIds	接收部门id集合	String		多个时有逗号(,)分割
channelCodes	外部消息通道编号集合	String		多个时有逗号(,)分割，没有填写则只发送系统通知

请求示例（json body）

[{
    "userName": "admin",
    "title": "测试标题",
    "content": "内容",
    "availableTimeStart": "2022-10-10",
    "availableTimeEnd": "2023-10-10",
    "userIds": "1",
    "channelCodes": "MC00001"
}]

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	通知id

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": [4]
}

# 3.5.15获取通道列表

调用地址（GET）

http://ip:port/api/msg/message/channel/list

请求参数

参数名	描述	类型	为空	备注
name	通道名称	String
type	通道类型	String

请求示例（Query）

?name=福大短信&type=fdsms

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
rows	返回数据

返回示例

{
	"code": 0,
	"msg": null,
	"total": 1,
	"rows": [
		{
			"id": 9,
			"name": "福大短信",
			"code": "MC00009",
			"type": "fdsms",
		}
	],
	"pageNum": 1,
	"pageSize": 10,
	"currPage": 1
}

# 3.5.17获取通道详情和模板

调用地址（GET）

http://ip:port/api/msg/message/channel/getInfo

请求参数

参数名	描述	类型	为空	备注
id	通道id	Long

请求示例（Query）

?id=9

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
	"code": 0,
	"msg": "请求成功",
	"data": {
		"id": 9,
		"name": "福大短信",
		"code": "MC00009",
		"type": "fdsms"	
	}
}

# 3.5.18消息通道-能力集成

调用地址（POST）

http://ip:port/api/msg/message/chanel/Capability

请求参数

参数名	描述	类型	为空
channlCode	通道代码	String	必填
channlName	通道名称	String	必填
templateId	模板Id	String	必填
userNames	工号	List< String >	必填

请求示例（json body）

{
	"channlCode": "MC00009",
	"channlName": "福大短信",
	"templateId": "61",
	"userNames": ["49961",""]
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
	"code": 0,
	"msg": "请求成功",
	"data": null
}

# 3.5.19电话拨号

调用地址（POST）

http://ip:port/api/msg/mail/sendMakeCall

请求参数

参数名	描述	类型	为空	备注
form	发送人	String	必填
to	接收人	String	必填

请求示例（json body）

{
	"form": "1",
	"to": "福大短信",
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
	"code": 0,
	"msg": "请求成功",
	"data": null
}

# 3.6文件中心集成规范

# 3.6.1新增文件

调用地址（POST）

http://ip:port/api/apicenter/api/file/client/add

请求参数

参数名	描述	类型	为空	备注
file	文件	MultipartFile	必填
userName	操作人工号	String

请求示例（Query）

?file=aaa&userName=bbb

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data.createBy	创建人
data.createTime	创建时间
data.id	文件id
data.fname	文件名
data.furl	文件访问路径
data.ftype	文件类型

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "createBy": "admin",
        "createTime": "2022-12-07 10:31:15",
        "id": "0545bc5e040245b2af41f56cca8c0ab7",
        "fname": "1.jpg",
        "furl": "http://192.168.100.120:30614/my-bucket/74a8fd427fda4954b71f59e669ee9140.jpg",
        "ftype": "jpg"
    }
}

# 3.6.2删除文件

调用地址（GET）

http://ip:port/api/apicenter/api/file/client/delete

请求参数

参数名	描述	类型	为空	备注
id	文件id	String	必填

请求示例（Query）

?id=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

# 3.6.3下载文件

调用地址（GET）

http://ip:port/api/apicenter/api/file/client/download

请求参数

参数名	描述	类型	为空	备注
id	文件id	String	必填

请求示例（Query）

?id=1

返回值

文件流

# 3.6.4获取文件列表

调用地址（GET）

http://ip:port/api/apicenter/api/file/client/list

请求参数

参数名	描述	类型	为空	备注
pageNum	当前页	Integer	必填
pageSize	每页数量	Integer	必填
fname	文件名	String		模糊查询

请求示例（Query）

?pageNum=1&pageSize=1&fname=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
total	总数量
pageNum	总页数
pageSize	每页数量
currPage	当前页
rows.createBy	上传用户工号
rows.createTime	上传时间
rows.id	文件id
rows.fname	文件名
rows.furl	文件路径
rows.ftype	文件类型

返回示例

{
    "code": 0,
    "msg": "查询成功",
    "total": 2,
    "rows": [
        {
            "createBy": "admin",
            "createTime": "2022-12-06 15:36:53",
            "id": "6df50f1f7b64466b9a422c3ce39af482",
            "fname": "e74038e22e93494f82f6b2da4127c298.jpg",
            "furl": "http://192.168.100.120:30614/my-bucket/110e47632bed45598337d01db6d36f89.jpg",
            "ftype": "jpg"
        }
    ],
    "pageNum": 2,
    "pageSize": 1,
    "currPage": 1
}

# 3.6.5判断文件是否存在

调用地址（GET）

http://ip:port/api/apicenter/api/file/client/exist

请求参数

参数名	描述	类型	为空	备注
id	文件id	String	必填

请求示例（Query）

?id=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

{
    "code": 500,
    "msg": "当前文件不存在",
    "data": null
}

# 3.6.6判断文件是否有权限

调用地址（GET）

http://ip:port/api/apicenter/api/file/client/hasPermission

请求参数

参数名	描述	类型	为空	备注
id	文件id	String	必填

请求示例（Query）

?id=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "请求成功",
    "data": null
}

{
    "code": 500,
    "msg": "无权查看该文件",
    "data": null
}

# 3.7日志审计集成规范

# 3.7.1添加操作日志

调用地址（POST）

http://ip:port/api/apicenter/api/operlog

请求头

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

请求头参数

参数名	描述	类型	为空
api-token	token	String	必填
clientId	应用id	String	必填
clientSecret	应用密钥	String	必填

请求参数

参数名	描述	类型	必填	备注
title	操作模块	String	否
businessType	业务类型	int	否	0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据
method	请求方法	String	否
requestMethod	请求方式	String	否
operatorType	操作类别	int	否	0=其它,1=后台用户,2=手机端用户
operName	操作人员账号	String	否
operNick	操作人员昵称	String	否
operRole	操作人员角色	String	否
deptName	部门名称	String	否
operUrl	请求地址	String	否
operIp	操作地址	String	否
operParam	请求参数	String	否
jsonResult	返回参数	String	否
status	状态	int	否	0=正常,1=异常
errorMsg	错误消息	String	否
operTime	操作时间	String	否	格式yyyy-MM-dd HH:mm:ss

请求示例（json body）

{
    "title":"测试"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	数据

返回示例

{
    "code": 0,
    "msg": "操作成功",
    "data": null
}

# 3.7.2获取操作日志列表

调用地址（GET）

http://ip:port/api/apicenter/api/operlog/list

请求头

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

请求头参数

参数名	描述	类型	为空
api-token	token	String	必填
clientId	应用id	String	必填
clientSecret	应用密钥	String	必填

请求参数

参数名	描述	类型	必填	备注
title	操作模块	String	否
businessType	业务类型	int	否	0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据
operName	操作人员账号	String	否
operNick	操作人员昵称	String	否
status	状态	int	否	0=正常,1=异常
beginTime	开始时间	String	否
endTime	结束时间	String	否
appId	系统id	long	否
parentId	系统组id	long	否

请求示例（Query）

?title=123

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
total	总数据量
rows	数据集合
pageNum	总页数
pageSize	每页数据量
currPage	当前页数
rows.oper_id	日志主键
rows.title	模块标题
rows.business_type	业务类型（0其它 1新增 2修改 3删除）
rows.method	方法名称
rows.request_method	请求方式
rows.operator_type	操作类别（0其它 1后台用户 2手机端用户）
rows.oper_name	操作人员账号
rows.oper_nick	操作人员昵称
rows.oper_role	操作人员角色名称
rows.oper_user_id	操作人员id
rows.dept_name	部门名称
rows.oper_url	请求URL
rows.oper_location	主机地址
rows.oper_param	请求参数
rows.json_result	返回参数
rows.status	操作状态（0正常 1异常）
rows.error_msg	错误消息
rows.oper_time	操作时间
rows.del_flag	删除标志,未删除0,已删除-1,默认0
rows.create_by	创建者
rows.create_time	创建时间
rows.update_by	更新者
rows.update_time	更新时间
rows.remark	备注
rows.app_id	系统id
rows.parent_id	系统组id

返回示例

{
    "code": 0,
    "msg": null,
    "total": 1,
    "rows": [
        {
            "searchValue": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "remark": null,
            "params": null,
            "operId": null,
            "title": null,
            "businessType": null,
            "businessTypes": null,
            "method": null,
            "requestMethod": null,
            "operatorType": null,
            "operName": null,
            "operNick": null,
            "operRole": null,
            "deptName": null,
            "operUrl": null,
            "operIp": null,
            "operParam": null,
            "status": null,
            "errorMsg": null,
            "operTime": null,
            "appId": null,
            "appName": null,
            "parentId": null,
            "parentName": null,
            "reqAppId": null,
            "reqServerType": null
        }
    ],
    "pageNum": 1,
    "pageSize": 3000,
    "currPage": 1
}

# 3.8日程中心集成规范

# 3.8.1新增或更新日程

调用地址（POST）

http://ip:port/api/apicenter/api/msg/rcInfo

请求参数

参数名	描述	类型	为空	备注
userName	用户工号	String	必填
content	日程内容	String	必填
remind	是否提醒	Boolean	必填
remindWay	提醒方式	String		1.邮箱 2.短信 3.站内信多个时用逗号`,`分割
remindTime	提醒时间	String
startDate	日程开始日期	String	必填
endDate	日程结束日期	String	必填

请求示例（json body）

{
  "userName": "admin",
  "content": "需求会议",
  "remind": true,
  "remindWay": "1,2",
  "remindTime": "23:00",
  "startDate": "2022-09-01",
  "endDate": "2022-09-01"
}

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	操作信息
data	返回数据

返回示例

{
    "code": 0,
    "msg": "操作成功",
    "data": null
}

# 3.8.2删除日程

调用地址（GET）

http://ip:port/api/apicenter/api/msg/rcInfo/delete/{id}

请求参数

参数名	描述	类型	为空	备注
id	日程id	Long	必填

请求示例（Path）

id=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data	返回数据

返回示例

{
  "code": 0,
  "msg": "请求成功",
  "data": null
}

# 3.8.3查询日程列表

调用地址（GET）

http://ip:port/api/apicenter/api/msg/rcInfo/list

请求参数

参数名	描述	类型	为空
userName	用户工号	String	必填
	当前页	Integer	必填
pageSize	每页数量	Integer	必填
startDate	日程开始日期	String	必填
endDate	日程结束日期	String	必填

请求示例（Query）

?userName=admin&pageNum=1&pageSize=10&startDate=2022-08-01&endDate=2022-10-01

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
pageNum	总页数
pageSize	每页数量
currPage	当前页数
rows.id	日程id
rows.content	日程内容
rows.remind	是否提醒
rows.remindWay	提醒方式（1.邮箱 2.短信 3.站内信多个时用逗号`,`分割）
rows.remindTime	提醒时间
rows.startDate	日程开始时间
rows.startDate	日程结束时间

返回示例

{
  "code": 0,
  "msg": null,
  "total": 1,
  "rows": [
    {
      "id": 27,
      "content": "需求会议",
      "remind": true,
      "remindWay": "1,2",
      "remindTime": "23:00",
      "startDate": "2022-09-01",
      "endDate": "2022-09-01"
    }
  ],
  "pageNum": 1,
  "pageSize": 1,
  "currPage": 1
}

# 3.8.4查询日程详情

调用地址（GET）

http://ip:port/api/apicenter/api/msg/rcInfo/info/{id}

请求参数

参数名	描述	类型	为空	备注
id	日程id	Long	必填

请求示例（Path）

id=1

返回值

参数名	描述
code	返回标识（0.正常 500.错误）
msg	结果信息
data.id	日程id
data.content	日程内容
data.remind	是否提醒
data.remindWay	提醒方式（1.邮箱 2.短信 3.站内信多个时用逗号`,`分割）
data.remindTime	提醒时间
data.startDate	日程开始时间
data.startDate	日程结束时间

返回示例

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "id": 27,
    "userName": null,
    "content": "需求会议",
    "remind": true,
    "remindWay": "1,2",
    "remindTime": "23:00",
    "startDate": "2022-09-01",
    "endDate": "2022-09-01"
  }
}

← 二、接入要求四、统一待办集成规范（非工作流） →