# 服务平台
版本 | 创建时间 | 作者 | 备注信息
---|---|---|---
v1.0|2022-01-20|zxfei| 接口文档
## 数据类型
类型名称|类型描述|参考样例
---|---|---
String |字符串|A、a、ab
Integer|数字类型|1、12、-1
Long|长整型数字|1、12、-1
date|时间类型,单位纳秒数字|167988745573
BigDecimal|小数类型|545.256
object|对象类型|{"name":"zhang3"}
arrays|数组类型|[{"name":"zhang3"},{"name":"zhang2"}]
## 系统服务
### 登录
**请求URL:** login/login
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户登录
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
loginName|String|用户名称|是|-
password|String|用户密码|是|-
**请求样例:**
```
{
"loginName":"zhang3",
"password":"123456"
}
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|Object|数据对象|-
 token|String|jwt token认证信息|-
 user|Object|用户信息|-
  id|Long|用户ID
  loginName|String|登录名
  realName|String|用户名
  mobile|String|用户手机号
  phone|String|用户联系电话
  email|String|用户邮箱
  qq|String|QQ号码
  siteIds|String|所属站点id,多个逗号分隔
  areaCodes|String|所属区域code,多个逗号分隔
  areaNames|String|所属区域名称,多个逗号分隔
  menuList|Arrays|菜单列表，树结构
   id|Long|菜单ID，主键
   name|String|菜单名称
   url|String|连接地址
   parentId|Long|父菜单ID，一级菜单的该字段值为-1
   linkType|Integer|链接方式，(0.内链，1.外链，2.脚本)
   imgPath|String|主菜单图标，主菜单图标的css样式名
   buttonImgPath|String|按钮图标
   imgCommPath|String|常用菜单图标
   visible|Integer|菜单显示(0.隐藏，1.显示)
   menuType|Integer|菜单类型(0.目录，1.菜单，2.按钮)
   status|Integer|菜单状态(0.禁用，1.启用)
   authType|Integer|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
   orderId|Integer|排序编号
   childList|Arrays|菜单子列表
**响应消息样例:**
```
{
"msg":"用户登录系统成功!",
"code":1,
"data":{
"user":{
"areaCodes":"",
"areaNames":"",
"createTime":1654132346000,
"createUserId":1,
"createUserName":"admin",
"expireTime":1654223524841,
"id":1,
"lastLoginAddress":"127.0.0.1",
"lastLoginTime":1654132346000,
"loginName":"admin",
"loginTime":1654137124841,
"manager":false,
"menuList":[
{
"authType":0,
"childList":[
{
"authType":1,
"childList":[
{
"authType":1,
"childList":[
],
"id":3,
"linkType":1,
"menuType":2,
"name":"排号系统",
"orderId":3,
"parentId":2,
"status":1,
"url":"http://www.baidu.com",
"visible":1
}
],
"id":2,
"linkType":0,
"menuType":0,
"name":"聚集服务",
"orderId":2,
"parentId":1,
"status":1,
"visible":1
}
],
"id":1,
"linkType":0,
"menuType":0,
"name":"数据管理",
"orderId":1,
"parentId":-1,
"status":1,
"visible":1
}
],
"mobile":"13808095770",
"realName":"系统管理员",
"siteIds":""
},
"token":"eyJhbGciOiJIUzI1NiJ9.eyJsb2dpbl91c2VyX2tleSI6IjI0OGNlYTkxYzZlNTQ4MTU5ZWQ2MWYzNjgxNDg4ZDY3In0.XOwzDtTpAayGbH8auQbG96Qqmd1sivx8w59S60pm19g"
}
}
```
### 首页
**请求URL:** login/index
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户首页
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
**请求样例:**
```
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|Object|数据对象|同登录返回数据一样，包含用户信息及菜单
**响应消息样例:**
```
```
### 登出
**请求URL:** login/logout
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户退出注销
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
**请求样例:**
```
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
```
### 修改密码
**请求URL:** user/change/password
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户修改密码
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
loginName|String|用户名称|是|-
oldPwd|String|用户加密后密码|是|-
newPwd|String|用户加密后新密码|是|-
**请求样例:**
```
{
"loginName":"zhang3",
"oldPwd":"123456",
"newPwd":"5455"
}
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"msg":"修改密码成功",
"code":1,
"data":{}
}
```
### 上传附件
**请求URL:** file/commonupload
**请求方式:** POST
**内容类型:** multipart/form-data
**简要描述:** 用户上传附件
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
file|multipart|附件|是|-
prePath|String|附件存放相对路径|否|不填时候默认为/file/fileupload
**请求样例:**
```
http://127.0.0.1/file/commonupload?prePath=/file/fileupload
Content-Type: multipart/form-data; boundary=WebAppBoundary
--WebAppBoundary
Content-Disposition: form-data; name="file"; filename="1.excel"
Content-Type: multipart/form-data
```
**响应参数:**
**响应消息样例:**
```
```
## 用户信息业务
### 查询用户信息业务列表
**请求URL:** user/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询用户信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
roleId|String|否|角色权限id
orConditionList|Arrays|否|复合查询条件，对象间关系为或，
 loginName|String|否|登录名称
 realName|String|否|用户姓名
 mobile|String|否|手机号码
**请求样例:**
```
{
"page":1,
"size":10,
"roleId":"1",
"orConditionList":[
{
"loginName":"zhang3"
},
{
"realName":"张三"
},
{
"mobile":"13281114856"
}
]
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|用户ID
  loginName|String|登录名
  realName|String|用户名
  mobile|String|用户手机号
  siteIds|String|所属站点id,多个逗号分隔
  areaCodes|String|所属区域code,多个逗号分隔
  areaNames|String|所属区域名称,多个逗号分隔
  roleId|String|所属角色id,多个逗号分隔
  roleName|String|所属角色名称,多个逗号分隔
  lastLoginTime|Date|最后登录时间
dict|object|字典对象
 userType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
 roleId|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看用户信息业务
**请求URL:** user/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看用户信息业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/user/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|用户ID，主键，自增长
 loginName|String|登录名
 loginLimitAddress|String|登录限制地址，多个IP地址用逗号分隔，可以使用IP段匹配，如：172.17.*非空：则只能该值内的IP可以登录
 realName|String|用户名
 mobile|String|用户手机号
 userType|Integer|用户类型(0.系统用户,1.普通用户,2.工作人员)
 siteIds|String|所属站点id,多个逗号分隔
 areaCodes|String|所属区域code,多个逗号分隔
 areaNames|String|所属区域名称,多个逗号分隔
 roleId|String|所属角色Id,多个逗号分隔
 roleName|String|所属角色名称,多个逗号分隔
 lastLoginTime|Date|最后登录时间
dict|object|字典对象
 userType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
}
}
```
### 保存更新用户信息业务
**请求URL:** user/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新用户信息业务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
loginName|String|是|登录名
loginPwd|String|是|登录密码
realName|String|是|用户真实姓名
mobile|String|是|用户手机号
siteIds|String|否|所属站点id,多个逗号分隔
areaCodes|String|否|所属区域code,多个逗号分隔
areaNames|String|否|所属区域名称,多个逗号分隔
roleId|String|所属角色Id,多个逗号分隔
roleName|String|所属角色名称,多个逗号分隔
**请求样例:**
```
{
"loginName":"6njc9h",
"realName":"coyvcd",
"mobile":"avklzq",
"siteIds":"hgh6s1",
"areaCodes":"a4cexd",
"areaNames":"a4cexd"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|用户ID
  loginName|String|登录名
  realName|String|用户名
  mobile|String|用户手机号
  userType|Integer|用户类型(0.系统用户,1.普通用户,2.工作人员)
  siteIds|String|所属站点id,多个逗号分隔
  areaCodes|String|所属区域code,多个逗号分隔
  areaNames|String|所属区域名称,多个逗号分隔
  roleId|String|所属角色id,多个逗号分隔
  roleName|String|所属角色名称,多个逗号分隔
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除用户信息业务
**请求URL:** user/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除用户信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/user/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
### 用户站点授权
**请求URL:** user/siteAuth
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 给用户授权站点
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
userId|Long|是|用户ID
areaCodeList|Arrays|否|所属区域code列表
**请求样例:**
```
{
"userId":2,
"areaCodeList":["510105521000","513400000000"]
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 查询数据管理
**请求URL:** site/model/census/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询数据管理
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
siteId|Long|是|站点id
**请求样例:**
```
{
"siteId":2
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
**响应消息样例:**
```
{
"data": {
"data": {
"CensusType_1": [
{
"id": 1,
"modelId": 23,
"censusName": "测试",
"censusUrl": "aaa",
"censusType": 1,
"status": 1,
"createUserName": "1",
"updateUserName": "1",
"censusTypeName": "聚焦服务",
"statusName": "已开通"
},
{
"id": 2,
"modelId": 23,
"censusName": "测试zzz",
"censusUrl": "aaa",
"censusType": 1,
"status": 1,
"createUserName": "系统管理员",
"updateUserName": "系统管理员",
"censusTypeName": "聚焦服务",
"statusName": "已开通"
}
]
}
},
"code": 1,
"msg": "查询数据管理成功"
}
```
### 查询站点编排
**请求URL:** site/model/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询数据管理
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
siteId|Long|是|站点id
**请求样例:**
```
{
"siteId":2
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
**响应消息样例:**
```
{
"data": {
"data": [
{
"id": 23,
"modelName": "基础设置平台",
"modelCode": "basic setting ",
"modelIcon": "",
"modelUrl": "http://192.168.0.98:11071/#",
"remark": "基础设置平台-test"
}
]
},
"code": 1,
"msg": "查询站点编排成功"
}
```
### 查询菜单权限
**请求URL:** menu/list/tree
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询数据管理
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
roleId|Long|是|角色id
**请求样例:**
```
{
"roleId":2
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 menu|Arrays|所有菜单
 sjgl|Arrays|当前用户已分配的数据管理权限
 zdbp|Arrays|当前用户已分配的站点编排权限
 sjjs|Arrays|当前用户已分配的数据精算权限
 ptsz|Arrays|当前用户已分配的平台设置权限
**响应消息样例:**
```
{
"code": 1,
"data": {
"zdbp": [
23,
26,
27
],
"sjjs": [
6
],
"sjgl": [
1,
2
],
"menu": [
{
"childList": [
{
"nodeId": 1,
"nodeName": "测试",
"nodeType": 1,
"parentId": 1
},
{
"nodeId": 2,
"nodeName": "测试zzz",
"nodeType": 1,
"parentId": 1
}
],
"nodeId": 1,
"nodeName": "数据管理",
"nodeType": 3,
"parentId": -1
},
{
"childList": [
{
"nodeId": 23,
"nodeName": "基础设置平台",
"nodeType": 2,
"parentId": 2
},
{
"nodeId": 26,
"nodeName": "排号系统",
"nodeType": 2,
"parentId": 2
},
{
"nodeId": 27,
"nodeName": "易政秀",
"nodeType": 2,
"parentId": 2
},
{
"nodeId": 28,
"nodeName": "设备管理系统",
"nodeType": 2,
"parentId": 2
}
],
"nodeId": 2,
"nodeName": "站点编排",
"nodeType": 3,
"parentId": -1
},
{
"childList": [
{
"nodeId": 5,
"nodeName": "业务数据分析",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 6,
"nodeName": "用户画像图谱",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 7,
"nodeName": "企业画像图谱",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 8,
"nodeName": "使用行为分析",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 9,
"nodeName": "数据汇聚一张图",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 10,
"nodeName": "数据预处理",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 11,
"nodeName": "数据仓库",
"nodeType": 3,
"parentId": 3
},
{
"nodeId": 12,
"nodeName": "数据开放门户",
"nodeType": 3,
"parentId": 3
}
],
"nodeId": 3,
"nodeName": "数据精算",
"nodeType": 3,
"parentId": -1
},
{
"childList": [
{
"nodeId": 13,
"nodeName": "RBAC用户-权限模型",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 14,
"nodeName": "API服务",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 15,
"nodeName": "应用服务",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 16,
"nodeName": "产品管理",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 17,
"nodeName": "菜单管理",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 18,
"nodeName": "消息服务",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 19,
"nodeName": "字典管理",
"nodeType": 3,
"parentId": 4
},
{
"nodeId": 20,
"nodeName": "日志服务",
"nodeType": 3,
"parentId": 4
}
],
"nodeId": 4,
"nodeName": "平台设置",
"nodeType": 3,
"parentId": -1
}
],
"ptsz": [
15
]
}
}
```
## 角色信息
### 查询角色信息列表
**请求URL:** role/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询角色信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
name|String|角色名称|否|模糊查询前后添加%%
**请求样例:**
```
{
"page":1,
"size":10,
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|序号，主键，自增长
  name|String|角色名称
  roleCode|String|角色编码
  roleSort|Integer|角色排序字段
  remark|String|备注
  menuIdList|Arrays|菜单ID列表,值为long
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
dict|object|字典对象
 roleType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看角色信息
**请求URL:** role/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看角色信息，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/role/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 name|String|角色名称
 roleCode|String|角色编码
 roleSort|Integer|角色排序字段
 remark|String|备注
 createTime|Date|创建时间
 createUserId|Long|创建用户
 createUserName|String|创建用户名称
dict|object|字典对象
 roleType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":7241,
"name":"c9szsk",
"roleCode":"c2f41g",
"roleSort":2788,
"remark":"tym2dx",
"createTime":"2022-06-02",
"createUserId":5091,
"createUserName":"zx9ud1"
}
}
```
### 保存更新角色信息
**请求URL:** role/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新角色信息：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
name|String|是|角色名称
roleCode|String|是|角色编码
roleSort|Integer|是|角色排序字段
remark|String|是|备注
createUserName|String|是|创建用户名称
**请求样例:**
```
{
"name":"i8scn3",
"roleCode":"nthtg2",
"roleSort":3063,
"remark":"32xaq6",
"createUserName":"ztwqjn"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  name|String|角色名称
  roleCode|String|角色编码
  roleSort|Integer|角色排序字段
  remark|String|备注
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
**响应消息样例:**
```
{
"msg":"新增成功",
"code":1,
"data":{}
}
}
```
### 删除角色信息
**请求URL:** role/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除角色信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/role/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 角色用户
### 分配用户到角色
**请求URL:** role/user/assignRoleToUser
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 分配用户到角色
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
userId|Long|是|用户ID
roleIdList|Arrays|否|角色ID列表,值为long
**请求样例:**
```
{
"userId":1,
"roleIdList":[1,2]
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|序号，主键，自增长
  roleId|Long|角色ID
  userId|Long|用户ID
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
## 角色菜单权限关联
### 分配菜单到角色
**请求URL:** role/auth/assignMenuToRole
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 分配菜单到角色
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
roleId|Long|是|角色ID
menuIdList|Arrays|否|菜单ID列表,值为long
modelIds|String|否|角色对应站点编排
censusIds|String|否|角色对应数据管理
**请求样例:**
```
{
"roleId":2,
"menuIdList":[2],
"modelIds":"1,2,4",
"censusIds":"2,3,4"
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
## 菜单信息业务
### 查询菜单信息业务列表
**请求URL:** menu/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询菜单信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
parentId|Integer|否|通过父id查询子集
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|菜单ID，主键，自增长
  name|String|菜单名称
  url|String|连接地址
  parentId|Long|父菜单ID，一级菜单的该字段值为-1
  linkType|Integer|链接方式，(0.普通，1.弹出，2.脚本)
  imgPath|String|主菜单图标，主菜单图标的css样式名
  buttonImgPath|String|按钮图标
  imgCommPath|String|常用菜单图标
  visible|Integer|菜单显示(0.隐藏，1.显示)
  menuType|Integer|菜单类型(0.目录，1.菜单，2.按钮)
  status|Integer|菜单状态(0.禁用，1.启用)
  authType|Integer|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
  orderId|Integer|排序编号
  firstLevel|String|一级菜单
  firstLevel|Long|一级菜单ID
  secondLevel|String|二级菜单
  secondMenuId|Long|二级菜单ID
  thirdLevel|String|三级菜单
  thirdMenuId|Long|三级菜单ID
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
  remark|String|描述备注
dict|object|字典对象
 linkType|object|字典属性对象，详见附录
 visible|object|字典属性对象，详见附录
 menuType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
 authType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
"per_page":10,
"total":4,
"data":[
{
"authType":0,
"childList":[
],
"firstLevel":"数据管理",
"id":1,
"linkType":0,
"menuType":0,
"name":"数据管理",
"orderId":1,
"parentId":-1,
"secondLevel":"",
"status":1,
"thirdLevel":"",
"visible":1
},
{
"authType":3,
"buttonImgPath":"vcr5tv",
"childList":[
],
"createTime":1654150239000,
"createUserId":1,
"createUserName":"系统管理员",
"firstLevel":"测试菜单2",
"id":4,
"imgCommPath":"qnglei",
"imgPath":"7mqw6a",
"linkType":0,
"menuType":0,
"name":"测试菜单2",
"orderId":2,
"parentId":-1,
"secondLevel":"",
"status":1,
"thirdLevel":"",
"url":"",
"visible":1
},
{
"authType":1,
"childList":[
],
"firstLevel":"数据管理",
"id":2,
"linkType":0,
"menuType":0,
"name":"聚集服务",
"orderId":2,
"parentId":1,
"secondLevel":"聚集服务",
"status":1,
"thirdLevel":"",
"visible":1
},
{
"authType":1,
"childList":[
],
"firstLevel":"数据管理",
"id":3,
"linkType":1,
"menuType":2,
"name":"排号系统",
"orderId":3,
"parentId":2,
"secondLevel":"聚集服务",
"status":1,
"thirdLevel":"排号系统",
"url":"http://www.baidu.com",
"visible":1
}
],
"last_page":1,
"pageInfo":{
"beginIndex":0,
"countPage":true,
"currPage":1,
"displayPageSize":5,
"hasNextPage":false,
"hasPrePage":false,
"prePageResult":10,
"totalPage":1,
"totalResult":4
},
"current_page":1
},
"dict":{
"commMenu":{
"0":"非常用",
"1":"常用"
},
"linkType":{
"0":"内链",
"1":"外链",
"2":"脚本"
},
"menuType":{
"0":"主菜单",
"1":"非主菜单"
},
"authType":{
"0":"无限制",
"1":"无需登录查看",
"2":"需要登录查看",
"3":"需要角色权限查看"
},
"status":{
"0":"禁用",
"1":"启用"
}
}
}
```
### 查看菜单信息业务
**请求URL:** menu/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看菜单信息业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/menu/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|菜单ID，主键，自增长
 name|String|菜单名称
 url|String|连接地址
 parentId|Long|父菜单ID，一级菜单的该字段值为-1
 linkType|Integer|链接方式，(0.普通，1.弹出，2.脚本)
 imgPath|String|主菜单图标，主菜单图标的css样式名
 buttonImgPath|String|按钮图标
 imgCommPath|String|常用菜单图标
 visible|Integer|菜单显示(0.隐藏，1.显示)
 menuType|Integer|菜单类型(0.目录，1.菜单，2.按钮)
 status|Integer|菜单状态(0.禁用，1.启用)
 authType|Integer|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
 orderId|Integer|排序编号
 createTime|Date|创建时间
 createUserId|Long|创建用户
 createUserName|String|创建用户名称
  remark|String|描述备注
dict|object|字典对象
 linkType|object|字典属性对象，详见附录
 visible|object|字典属性对象，详见附录
 menuType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
 authType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":6665,
"name":"4hfb9i",
"url":"aozik5",
"parentId":7827,
"linkType":6399,
"imgPath":"3q4cuk",
"buttonImgPath":"ctbxdj",
"imgCommPath":"ie3v9e",
"visible":5636,
"menuType":6851,
"status":7330,
"authType":9906,
"orderId":6861,
"createTime":"2022-06-02",
"createUserId":2189,
"createUserName":"zov8bo",
"remark":"zov8bo"
}
}
```
### 保存更新菜单信息业务
**请求URL:** menu/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新菜单信息业务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
name|String|是|菜单名称
url|String|是|连接地址
parentId|Long|是|父菜单ID，一级菜单的该字段值为-1
linkType|Integer|是|链接方式，(0.普通，1.弹出，2.脚本)
imgPath|String|是|主菜单图标，主菜单图标的css样式名
buttonImgPath|String|是|按钮图标
imgCommPath|String|是|常用菜单图标
visible|Integer|是|菜单显示(0.隐藏，1.显示)
menuType|Integer|是|菜单类型(0.目录，1.菜单，2.按钮)
status|Integer|是|菜单状态(0.禁用，1.启用)
authType|Integer|是|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
orderId|Integer|是|排序编号
remark|String|是|描述备注
**请求样例:**
```
{
"name":"测试菜单2",
"url":"",
"parentId":-1,
"linkType":0,
"imgPath":"7mqw6a",
"buttonImgPath":"vcr5tv",
"imgCommPath":"qnglei",
"visible":1,
"menuType":0,
"status":1,
"authType":3,
"orderId":0,
"remark":"qnglei"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|菜单ID，主键，自增长
  name|String|菜单名称
  url|String|连接地址
  parentId|Long|父菜单ID，一级菜单的该字段值为-1
  linkType|Integer|链接方式，(0.普通，1.弹出，2.脚本)
  imgPath|String|主菜单图标，主菜单图标的css样式名
  buttonImgPath|String|按钮图标
  imgCommPath|String|常用菜单图标
  visible|Integer|菜单显示(0.隐藏，1.显示)
  menuType|Integer|菜单类型(0.目录，1.菜单，2.按钮)
  status|Integer|菜单状态(0.禁用，1.启用)
  authType|Integer|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
  orderId|Integer|排序编号
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
  remark|String|描述备注
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除菜单信息业务
**请求URL:** menu/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除菜单信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/menu/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
### 查询所有可用菜单
**请求URL:** menu/findAll
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询菜单信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
**请求样例:**
```
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|菜单ID，主键，自增长
  name|String|菜单名称
  url|String|连接地址
  parentId|Long|父菜单ID，一级菜单的该字段值为-1
  linkType|Integer|链接方式，(0.普通，1.弹出，2.脚本)
  imgPath|String|主菜单图标，主菜单图标的css样式名
  buttonImgPath|String|按钮图标
  imgCommPath|String|常用菜单图标
  visible|Integer|菜单显示(0.隐藏，1.显示)
  menuType|Integer|菜单类型(0.目录，1.菜单，2.按钮)
  status|Integer|菜单状态(0.禁用，1.启用)
  authType|Integer|权限类型(0.无限制，1.无需登录查看，2.需要登录查看，3.需要角色权限查看)
  orderId|Integer|排序编号
  firstLevel|String|一级菜单
  secondLevel|String|二级菜单
  thirdLevel|String|三级菜单
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
  childList|Arrays|菜单子列表
dict|object|字典对象
 linkType|object|字典属性对象，详见附录
 visible|object|字典属性对象，详见附录
 menuType|object|字典属性对象，详见附录
 status|object|字典属性对象，详见附录
 authType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{}
}
```
## 上传文件业务
### 查询上传文件业务列表
**请求URL:** uploadfile/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询上传文件业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|ID，主键，自增长
  fileName|String|文件名称
  filePath|String|文件路径
  fileType|Integer|文件类型，(1.excel ,2. img,3.zip, 4.pdf)
  createTime|Date|创建时间
  createUser|String|创建用户
dict|object|字典对象
 fileType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看上传文件业务
**请求URL:** uploadfile/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看上传文件业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/uploadfile/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|ID，主键，自增长
 fileName|String|文件名称
 filePath|String|文件路径
 fileType|Integer|文件类型，(1.excel ,2. img,3.zip, 4.pdf)
 createTime|Date|创建时间
 createUser|String|创建用户
dict|object|字典对象
 fileType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":333,
"fileName":"hoic00",
"filePath":"59xnyt",
"fileType":1497,
"createTime":"2022-06-02",
"createUser":"l5t7ok"
}
}
```
### 保存更新上传文件业务
**请求URL:** uploadfile/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新上传文件业务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
fileName|String|是|文件名称
filePath|String|是|文件路径
fileType|Integer|是|文件类型，(1.excel ,2. img,3.zip, 4.pdf)
**请求样例:**
```
{
"fileName":"bznd4w",
"filePath":"10n94m",
"fileType":6866,
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|ID，主键，自增长
  fileName|String|文件名称
  filePath|String|文件路径
  fileType|Integer|文件类型，(1.excel ,2. img,3.zip, 4.pdf)
  createTime|Date|创建时间
  createUser|String|创建用户
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除上传文件业务
**请求URL:** uploadfile/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除上传文件业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/uploadfile/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## API服务
### 查询API服务列表
**请求URL:** system/service/api/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询API服务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
apiName|String|否|api服务名称，模糊查询添加%%
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集
  serviceName|String|服务名称
  serviceCode|String|服务编码
  count|Integer|服务数量
  serviceList|Arrays|服务列表
   id|Long|系统API的ID，主键，自增长
   systemServiceName|String|模块名称
   systemServiceCode|String|模块编码
   systemServiceUrl|String|模块地址
   apiName|String|API接口名称
   apiUrl|String|API接口（链接）
   apiVersion|String|API接口版本
   apiStatus|Integer|API接口状态(1:启用,0:停用)
   createTime|Date|创建时间
   lapseTime|Date|失效时间
   apiRemark|String|API接口说明
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看API服务
**请求URL:** system/service/api/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看API服务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/system/service/api/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|系统API的ID，主键，自增长
 systemServiceName|String|模块名称
 systemServiceCode|String|模块编码
 systemServiceUrl|String|模块地址
 apiName|String|API接口名称
 apiUrl|String|API接口（链接）
 apiVersion|String|API接口版本
 apiStatus|Integer|API接口状态(1:启用,0:停用)
 createTime|Date|创建时间
 lapseTime|Date|失效时间
 apiRemark|String|API接口说明
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":7011,
"systemServiceName":"tygqb6",
"systemServiceCode":"bvuijc",
"systemServiceUrl":"rrzv6a",
"apiName":"37zhe1",
"apiUrl":"b5x1bd",
"apiVersion":"hjsc6r",
"apiStatus":9227,
"createTime":"2022-06-02",
"lapseTime":"2022-06-02",
"apiRemark":"1s93wj"
}
}
```
### 保存更新API服务
**请求URL:** system/service/api/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新API服务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
systemServiceName|String|是|模块名称
systemServiceCode|String|是|模块编码
systemServiceUrl|String|是|模块地址
apiName|String|是|API接口名称
apiUrl|String|是|API接口（链接）
apiVersion|String|是|API接口版本
apiStatus|Integer|是|API接口状态(1:启用,0:停用)
lapseTime|Date|是|失效时间
apiRemark|String|是|API接口说明
**请求样例:**
```
{
"systemServiceName":"qjphl0",
"systemServiceCode":"d5huw6",
"systemServiceUrl":"51krbp",
"apiName":"hmaj25",
"apiUrl":"hvikv5",
"apiVersion":"angohp",
"apiStatus":8269,
"lapseTime":"2022-06-02",
"apiRemark":"la6o62"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|系统API的ID，主键，自增长
  systemServiceName|String|模块名称
  systemServiceCode|String|模块编码
  systemServiceUrl|String|模块地址
  apiName|String|API接口名称
  apiUrl|String|API接口（链接）
  apiVersion|String|API接口版本
  apiStatus|Integer|API接口状态(1:启用,0:停用)
  createTime|Date|创建时间
  lapseTime|Date|失效时间
  apiRemark|String|API接口说明
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除API服务
**请求URL:** system/service/api/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除API服务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/system/service/api/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## APP服务
### 查询API服务列表
**请求URL:** system/service/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询APP服务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
packageName|String|否|模糊查询添加%packageName%
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  serviceName|String|服务名称
  serviceCode|String|服务编码
  count|Integer|服务数量
  serviceList|Arrays|服务列表
   id|Long|系统API的ID，主键，自增长
   systemServiceName|String|模块名称
   systemServiceCode|String|模块编码
   systemServiceUrl|String|模块地址
   packageName|String|包名称
   packagePath|String|包的下载路径
   packageVersion|String|包的版本
   apiStatus|Integer|包的状态(1:启用,0:停用)
   createTime|Date|创建时间
   lapseTime|Date|失效时间
   packageRemark|String|包的说明
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看API服务
**请求URL:** system/service/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看API服务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/system/service/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|系统API的ID，主键，自增长
 systemServiceName|String|模块名称
 systemServiceCode|String|模块编码
 systemServiceUrl|String|模块地址
 packageName|String|包名称
 packagePath|String|包的下载路径
 packageVersion|String|包的版本
 apiStatus|Integer|包的状态(1:启用,0:停用)
 createTime|Date|创建时间
 lapseTime|Date|失效时间
 packageRemark|String|包的说明
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":9737,
"systemServiceName":"79g6p0",
"systemServiceCode":"muoxnm",
"systemServiceUrl":"fwy71w",
"packageName":"rxiw2c",
"packagePath":"knwyb3",
"packageVersion":"slmu46",
"apiStatus":4063,
"createTime":"2022-06-02",
"lapseTime":"2022-06-02",
"packageRemark":"uaovbk"
}
}
```
### 保存更新API服务
**请求URL:** system/service/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新API服务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
systemServiceName|String|是|模块名称
systemServiceCode|String|是|模块编码
systemServiceUrl|String|是|模块地址
packageName|String|是|包名称
packagePath|String|是|包的下载路径
packageVersion|String|是|包的版本
apiStatus|Integer|是|包的状态(1:启用,0:停用)
lapseTime|Date|是|失效时间
packageRemark|String|是|包的说明
**请求样例:**
```
{
"systemServiceName":"72pftp",
"systemServiceCode":"5r4y52",
"systemServiceUrl":"yq978x",
"packageName":"ow8fl3",
"packagePath":"juz77b",
"packageVersion":"55quoy",
"apiStatus":2792,
"lapseTime":"2022-06-02",
"packageRemark":"j31p56"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|系统API的ID，主键，自增长
  systemServiceName|String|模块名称
  systemServiceCode|String|模块编码
  systemServiceUrl|String|模块地址
  packageName|String|包名称
  packagePath|String|包的下载路径
  packageVersion|String|包的版本
  apiStatus|Integer|包的状态(1:启用,0:停用)
  createTime|Date|创建时间
  lapseTime|Date|失效时间
  packageRemark|String|包的说明
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除API服务
**请求URL:** system/service/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除API服务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/system/service/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 字典参数业务
### 查询参数信息业务列表
**请求URL:** param/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询参数信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|序号，主键，自增长
  name|String|参数名称
  firstOrganize|String|一级组织，如：平台配置
  secondOrganize|String|二级组织，如：基础配置
  paramKey|String|参数键，全局唯一
  paramValue|String|参数值
  validStatus|Integer|参数有效状态，(0.禁用，1.启用)
  modStatus|Integer|参数修改状态(0.隐藏，1.页面仅查看，2.页面可修改，3.页面可删除，4.页面可修改删除)
  displayType|Integer|展现类型(0.普通文本框，1.多行文本框，2.开关，3.块输入框)
  remark|String|备注
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
dict|object|字典对象
 validStatus|object|字典属性对象，详见附录
 modStatus|object|字典属性对象，详见附录
 displayType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看参数信息业务
**请求URL:** param/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看参数信息业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/param/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 name|String|参数名称
 firstOrganize|String|一级组织，如：平台配置
 secondOrganize|String|二级组织，如：基础配置
 paramKey|String|参数键，全局唯一
 paramValue|String|参数值
 validStatus|Integer|参数有效状态，(0.禁用，1.启用)
 modStatus|Integer|参数修改状态(0.隐藏，1.页面仅查看，2.页面可修改，3.页面可删除，4.页面可修改删除)
 displayType|Integer|展现类型(0.普通文本框，1.多行文本框，2.开关，3.块输入框)
 remark|String|备注
 createTime|Date|创建时间
 createUserId|Long|创建用户
 createUserName|String|创建用户名称
dict|object|字典对象
 validStatus|object|字典属性对象，详见附录
 modStatus|object|字典属性对象，详见附录
 displayType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":1964,
"name":"ki4jof",
"firstOrganize":"n8hp8g",
"secondOrganize":"vytdjr",
"paramKey":"2va33d",
"paramValue":"uvqalw",
"validStatus":95,
"modStatus":8891,
"displayType":118,
"remark":"1igdsr",
"createTime":"2022-06-02",
"createUserId":9470,
"createUserName":"hf2ro7"
}
}
```
### 保存更新参数信息业务
**请求URL:** param/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新参数信息业务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
name|String|是|参数名称
firstOrganize|String|是|一级组织，如：平台配置
secondOrganize|String|是|二级组织，如：基础配置
paramKey|String|是|参数键，全局唯一
paramValue|String|是|参数值
validStatus|Integer|是|参数有效状态，(0.禁用，1.启用)
modStatus|Integer|是|参数修改状态(0.隐藏，1.页面仅查看，2.页面可修改，3.页面可删除，4.页面可修改删除)
displayType|Integer|是|展现类型(0.普通文本框，1.多行文本框，2.开关，3.块输入框)
remark|String|是|备注
createUserName|String|是|创建用户名称
**请求样例:**
```
{
"name":"f07rkf",
"firstOrganize":"bdwqlr",
"secondOrganize":"zfi108",
"paramKey":"f9vj9x",
"paramValue":"m1yxt4",
"validStatus":6996,
"modStatus":6263,
"displayType":4365,
"remark":"cnu1t0",
"createUserName":"l31hcb"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  name|String|参数名称
  firstOrganize|String|一级组织，如：平台配置
  secondOrganize|String|二级组织，如：基础配置
  paramKey|String|参数键，全局唯一
  paramValue|String|参数值
  validStatus|Integer|参数有效状态，(0.禁用，1.启用)
  modStatus|Integer|参数修改状态(0.隐藏，1.页面仅查看，2.页面可修改，3.页面可删除，4.页面可修改删除)
  displayType|Integer|展现类型(0.普通文本框，1.多行文本框，2.开关，3.块输入框)
  remark|String|备注
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除参数信息业务
**请求URL:** param/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除参数信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/param/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 任务信息业务
### 查询任务信息业务列表
**请求URL:** task/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询任务信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|序号，主键，自增长
  name|String|任务名称
  taskKey|String|任务关键字，区分任务执行流程
  status|Integer|任务状态，(0,未启动，1.执行中)
  excuteService|String|任务执行服务
  excuteParam|String|任务执行参数
  excuteHost|String|任务执行主机，为空表示不限制任务的执行主机，多个用逗号分隔
  excuteStrategy|Integer|执行策略(1.按日，2.按周，3.按月，4.按间隔时间)
  excuteDate|Long|执行日期，按日：则为0；按周：则为1-7；按月：则为：1-31；按间隔时间：则为间隔时间，单位：秒；
  excuteTime|String|执行时间，格式：HH:mm，
  remark|String|备注
  lastExcuteHost|String|最后执行主机
  lastExcuteTime|Date|最后执行时间
  interimExcuteStatus|Integer|临时执行状态，(0.未启用，1.立即执行并保留，2.立即执行并删除)
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
dict|object|字典对象
 status|object|字典属性对象，详见附录
 excuteStrategy|object|字典属性对象，详见附录
 interimExcuteStatus|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看任务信息业务
**请求URL:** task/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看任务信息业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/task/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 name|String|任务名称
 taskKey|String|任务关键字，区分任务执行流程
 status|Integer|任务状态，(0,未启动，1.执行中)
 excuteService|String|任务执行服务
 excuteParam|String|任务执行参数
 excuteHost|String|任务执行主机，为空表示不限制任务的执行主机，多个用逗号分隔
 excuteStrategy|Integer|执行策略(1.按日，2.按周，3.按月，4.按间隔时间)
 excuteDate|Long|执行日期，按日：则为0；按周：则为1-7；按月：则为：1-31；按间隔时间：则为间隔时间，单位：秒；
 excuteTime|String|执行时间，格式：HH:mm，
 remark|String|备注
 lastExcuteHost|String|最后执行主机
 lastExcuteTime|Date|最后执行时间
 interimExcuteStatus|Integer|临时执行状态，(0.未启用，1.立即执行并保留，2.立即执行并删除)
 createTime|Date|创建时间
 createUserId|Long|创建用户
 createUserName|String|创建用户名称
dict|object|字典对象
 status|object|字典属性对象，详见附录
 excuteStrategy|object|字典属性对象，详见附录
 interimExcuteStatus|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":6172,
"name":"hbt2lp",
"taskKey":"x6t812",
"status":8987,
"excuteService":"pvba97",
"excuteParam":"0x3ln2",
"excuteHost":"n0eg2u",
"excuteStrategy":9806,
"excuteDate":3911,
"excuteTime":"ayetg0",
"remark":"ldtl5d",
"lastExcuteHost":"jcztp4",
"lastExcuteTime":"2022-06-02",
"interimExcuteStatus":7901,
"createTime":"2022-06-02",
"createUserId":1471,
"createUserName":"mmso1q"
}
}
```
### 保存更新任务信息业务
**请求URL:** task/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新任务信息业务：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
name|String|是|任务名称
taskKey|String|是|任务关键字，区分任务执行流程
status|Integer|是|任务状态，(0,未启动，1.执行中)
excuteService|String|是|任务执行服务
excuteParam|String|是|任务执行参数
excuteHost|String|是|任务执行主机，为空表示不限制任务的执行主机，多个用逗号分隔
excuteStrategy|Integer|是|执行策略(1.按日，2.按周，3.按月，4.按间隔时间)
excuteDate|Long|是|执行日期，按日：则为0；按周：则为1-7；按月：则为：1-31；按间隔时间：则为间隔时间，单位：秒；
excuteTime|String|是|执行时间，格式：HH:mm，
remark|String|是|备注
lastExcuteHost|String|是|最后执行主机
lastExcuteTime|Date|是|最后执行时间
interimExcuteStatus|Integer|是|临时执行状态，(0.未启用，1.立即执行并保留，2.立即执行并删除)
createUserName|String|是|创建用户名称
**请求样例:**
```
{
"name":"mw99q3",
"taskKey":"ik0shq",
"status":1748,
"excuteService":"x9xq4q",
"excuteParam":"k1x6jh",
"excuteHost":"5qha0s",
"excuteStrategy":2523,
"excuteDate":9933,
"excuteTime":"fgiec0",
"remark":"khc1mc",
"lastExcuteHost":"rbntny",
"lastExcuteTime":"2022-06-02",
"interimExcuteStatus":8141,
"createUserName":"cb5yx5"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  name|String|任务名称
  taskKey|String|任务关键字，区分任务执行流程
  status|Integer|任务状态，(0,未启动，1.执行中)
  excuteService|String|任务执行服务
  excuteParam|String|任务执行参数
  excuteHost|String|任务执行主机，为空表示不限制任务的执行主机，多个用逗号分隔
  excuteStrategy|Integer|执行策略(1.按日，2.按周，3.按月，4.按间隔时间)
  excuteDate|Long|执行日期，按日：则为0；按周：则为1-7；按月：则为：1-31；按间隔时间：则为间隔时间，单位：秒；
  excuteTime|String|执行时间，格式：HH:mm，
  remark|String|备注
  lastExcuteHost|String|最后执行主机
  lastExcuteTime|Date|最后执行时间
  interimExcuteStatus|Integer|临时执行状态，(0.未启用，1.立即执行并保留，2.立即执行并删除)
  createTime|Date|创建时间
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除任务信息业务
**请求URL:** task/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除任务信息业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/task/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 操作日志业务
### 查询操作日志业务列表
**请求URL:** oper/log/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询操作日志业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
**请求样例:**
```
{
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:------|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表
  id|Long|序号，主键，自增长
  platformMark|String|平台标识
  userId|Long|用户id
  userName|String|用户名称
  loginName|String|用户登录名
  requestUrl|String|请求地址
  content|String|操作内容，记录操作具体信息，如修改前修改或的数据
  ip|String|操作IP地址
  logDate|Date|操作时间
  operType|Integer|操作类型，(0.新增,1.修改,2.删除)
  createTime|Date|创建时间
  createUserId|Long|创建用户
dict|object|字典对象
 operType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看操作日志业务
**请求URL:** oper/log/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看操作日志业务，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/oper/log/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 platformMark|String|平台标识
 userId|Long|用户id
 userName|String|用户名称
 loginName|String|用户登录名
 requestUrl|String|请求地址
 content|String|操作内容，记录操作具体信息，如修改前修改或的数据
 ip|String|操作IP地址
 logDate|Date|操作时间
 operType|Integer|操作类型，(0.新增,1.修改,2.删除)
 createTime|Date|创建时间
 createUserId|Long|创建用户
dict|object|字典对象
 operType|object|字典属性对象，详见附录
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":6064,
"platformMark":"8kzvmw",
"userId":261,
"userName":"197cjh",
"loginName":"0sku2y",
"requestUrl":"bim4px",
"content":"udmwqz",
"ip":"kyeyk0",
"logDate":"2022-06-02",
"operType":2651,
"createTime":"2022-06-02",
"createUserId":2668
}
}
```
## 区域
### 查询区域列表
**请求URL:** area/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询区域
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
page|Integer|当前页|否|-
size|Integer|每页条数|否|-1查询所有
name|String|区域名称|否|模糊查询前后添加%%
areaCode|String|区域编码|否|模糊查询前后添加%%
**请求样例:**
```
{
"name":"%zt2h08%",
"page":1,
"size":10
}
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|object|数据对象|-
 per_page|Integer|每页条数|-
 total|Integer|总条数|-
 last_page|Integer|总页数|-
 current_page|Integer|当前页|-
 data|array|结果集列表|数组
  id|Long|序号，主键，自增长|-
  ancestors|String|祖级列表，逗号分隔|-
  name|String|区域名称|-
  iid|String|一体化的ID号|-
  parentId|String|一体化的父id|-
  haveSonArea|String|是否有下级区域（True.是，False.否）|-
  haveSonDept|String|是否有下级部门（True.是，False.否）|-
  haveGetDept|String|是否获取部门（true.是，false.否）|-
  haveGetMatterList|String|是否获取事项列表（true.是，false.否）|-
  areaCode|String|区域编码|-
  areaLevel|Integer|区域等级(1.省，2.地市州，3.区县，4.街道，5.社区)|-
  shortName|String|名称简称|-
  domain|String|访问地址|-
  status|Integer|区域状态 (0.停用，1.正常)|-
  createTime|Date|创建时间|-
  createUserId|Long|创建用户|-
  updateTime|Date|修改时间|-
dict|object|字典对象|-
 haveSonArea|object|字典属性对象，详见附录|-
 haveSonDept|object|字典属性对象，详见附录|-
 haveGetDept|object|字典属性对象，详见附录|-
 haveGetMatterList|object|字典属性对象，详见附录|-
 areaLevel|object|字典属性对象，详见附录|-
 status|object|字典属性对象，详见附录|-
**响应消息样例:**
```
{
"code":1,
"data":{
"per_page":10,
"total":0,
"data":[],
"last_page":0,
"current_page":1
},
"query":{
"modelCode":"phxt1",
"modelName":"排号系统"
}
}
```
### 查看区域
**请求URL:** area/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看区域，返回实例详细信息
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
id|Long|区域ID|是|-
**请求样例:**
```
http://localhost/area/info?id=549
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|object|数据对象|-
 id|Long|序号，主键，自增长|-
 ancestors|String|祖级列表，逗号分隔|-
 name|String|区域名称|-
 iid|String|一体化的ID号|-
 parentId|String|一体化的父id|-
 haveSonArea|String|是否有下级区域（True.是，False.否）|-
 haveSonDept|String|是否有下级部门（True.是，False.否）|-
 haveGetDept|String|是否获取部门（true.是，false.否）|-
 haveGetMatterList|String|是否获取事项列表（true.是，false.否）|-
 areaCode|String|区域编码|-
 areaLevel|Integer|区域等级(1.省，2.地市州，3.区县，4.街道，5.社区)|-
 shortName|String|名称简称|-
 domain|String|访问地址|-
 status|Integer|区域状态 (0.停用，1.正常)|-
 createTime|Date|创建时间|-
 createUserId|Long|创建用户|-
 updateTime|Date|修改时间|-
dict|object|字典对象|-
 haveSonArea|object|字典属性对象，详见附录|-
 haveSonDept|object|字典属性对象，详见附录|-
 haveGetDept|object|字典属性对象，详见附录|-
 haveGetMatterList|object|字典属性对象，详见附录|-
 areaLevel|object|字典属性对象，详见附录|-
 status|object|字典属性对象，详见附录|-
**响应消息样例:**
```
```
### 查看区域子信息
**请求URL:** area/getListByParentId
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看区域，返回实例详细信息
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
parentId|String|区域树父id|是|0为树的顶层节点
**请求样例:**
```
http://localhost/area/getListByParentId?parentId=549
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|object|数据对象|-
 data|object|数据对象|-
  id|String|节点ID|-
  label|String|节点名称|-
  areaCode|String|区域编码|-
  isLeaf|String|是否叶子节点|-
  type|String|节点类型|type='site'表示站点，type='area'表示区域
  icon|String|图标|-
  children|Arrays|子节点|-
**响应消息样例:**
```
```
### 获取所有区域信息
**请求URL:** area/treeselect
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 返回所有区域信息，树结构，数据量巨大
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
**请求样例:**
```
http://localhost/area/treeselect
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
data|object|数据对象|-
 data|Arrays|数组对象|-
  id|String|节点ID|-
  label|String|节点名称|-
  areaCode|String|区域编码|-
  isLeaf|String|是否叶子节点|-
  type|String|节点类型|-
  icon|String|图标|-
  children|Arrays|子节点|-
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":9986,
}
}
```
## 数据管理
### 获取站点下的数据管理列表
**请求URL:** apps/census/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询系统应用数据统计
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
siteId|String|是|站点id
**请求样例:**
```
{
"siteId": 1
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组，CensusType_1到5分别对应聚焦服务、协同、监管、数据、运营
  id|Long|主键ID，主键，自增长
  appId|Long|应用ID，主键
  censusName|String|数据统计名称
  censusUrl|String|链接地址
  censusType|Integer|统计类型， 1：服务，2：协同，3：监管，4：数据，5：运营。默认1
  status|Integer|状态，0暂未开通，1已开通
  createUserId|Long|创建用户
  createUserName|String|创建用户名称
  createTime|Date|创建时间
  updateTime|Date|更新时间
  updateUserId|Long|更新用户
  updateUserName|String|更新用户名称
dict|object|字典对象
**响应消息样例:**
```
{
"data": {
"per_page": -1,
"total": 10,
"data": {
"CensusType_1": [
{
"id": 1,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表1",
"censusUrl": null,
"censusType": 1,
"status": 0
},
{
"id": 2,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表2",
"censusUrl": null,
"censusType": 1,
"status": 0
}
],
"CensusType_2": [
{
"id": 3,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表3",
"censusUrl": null,
"censusType": 2,
"status": 0
},
{
"id": 4,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表4",
"censusUrl": null,
"censusType": 2,
"status": 0
}
],
"CensusType_3": [
{
"id": 5,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表5",
"censusUrl": null,
"censusType": 3,
"status": 0
},
{
"id": 6,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表6",
"censusUrl": null,
"censusType": 3,
"status": 0
}
],
"CensusType_4": [
{
"id": 3,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表3",
"censusUrl": null,
"censusType": 2,
"status": 0
},
{
"id": 4,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表4",
"censusUrl": null,
"censusType": 2,
"status": 0
}
],
"CensusType_5": [
{
"id": 7,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表7",
"censusUrl": null,
"censusType": 4,
"status": 0
},
{
"id": 8,
"createUserId": 1,
"createUserName": "系统管理员",
"createTime": "2022-06-22 17:20:04",
"deleted": 0,
"updateUserId": 1,
"updateUserName": "系统管理员",
"updateTime": "2022-06-22 17:20:04",
"siteId": null,
"appIdList": null,
"appId": 1,
"censusName": "预约记录报表8",
"censusUrl": null,
"censusType": 4,
"status": 0
}
]
},
"last_page": -10,
"pageInfo": {
"beginIndex": 0,
"prePageResult": -1,
"totalResult": 10,
"totalPage": -10,
"currPage": 1,
"displayPageSize": 5,
"hasNextPage": false,
"hasPrePage": false,
"lastRecordKey": null,
"countPage": true
},
"current_page": 1
},
"code": 1,
"msg": "",
"dict": {
"censusType": {
"1": "聚焦服务",
"2": "聚焦协同",
"3": "聚焦监管",
"4": "聚焦数据",
"5": "聚焦运营"
},
"status": {
"0": "暂未开通",
"1": "已开通"
}
}
}
```
## 站点编排
### 查询站点编排列表
**请求URL:** apps/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询系统应用列
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
siteId|String|是|站点id
**请求样例:**
```
{
"siteId": 1
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|主键,自增长
  name|String|应用名称
  imgPath|String|图标地址
  url|String|连接地址
  status|Integer|状态，0暂未开通，1已开通
  sortNum|Integer|排序号
  remark|String|描述
  createTime|Date|创建时间
  updateTime|Date|更新时间
  createUserId|Long|创建用户ID
  createUserName|String|创建用户名称
  updateUserId|Long|更新用户
  updateUserName|String|更新用户名称
dict|object|字典对象
**响应消息样例:**
```
{
"data": {
"per_page": -1,
"total": 4,
"data": [
{
"id": 2,
"createUserId": 1,
"createUserName": "管理员",
"createTime": "2022-06-22 06:55:01",
"deleted": 0,
"updateUserId": null,
"updateUserName": null,
"updateTime": null,
"siteId": null,
"idList": null,
"name": "基础设置",
"imgPath": "testCode",
"url": "testUrl",
"status": 1,
"sortNum": 0,
"remark": "基础设置"
},
{
"id": 3,
"createUserId": 1,
"createUserName": "管理员",
"createTime": "2022-06-22 06:55:01",
"deleted": 0,
"updateUserId": null,
"updateUserName": null,
"updateTime": null,
"siteId": null,
"idList": null,
"name": "预约系统",
"imgPath": "testCode",
"url": "testUrl",
"status": 0,
"sortNum": 0,
"remark": "预约系统"
},
{
"id": 4,
"createUserId": 1,
"createUserName": "管理员",
"createTime": "2022-06-22 06:55:01",
"deleted": 0,
"updateUserId": null,
"updateUserName": null,
"updateTime": null,
"siteId": null,
"idList": null,
"name": "排号系统",
"imgPath": "testCode",
"url": "testUrl",
"status": 1,
"sortNum": 0,
"remark": "排号系统"
},
{
"id": 5,
"createUserId": 1,
"createUserName": "管理员",
"createTime": "2022-06-22 06:55:01",
"deleted": 0,
"updateUserId": null,
"updateUserName": null,
"updateTime": null,
"siteId": null,
"idList": null,
"name": "评价系统",
"imgPath": "testCode",
"url": "testUrl",
"status": 0,
"sortNum": 0,
"remark": "评价系统"
}
],
"last_page": -4,
"pageInfo": {
"beginIndex": 0,
"prePageResult": -1,
"totalResult": 4,
"totalPage": -4,
"currPage": 1,
"displayPageSize": 5,
"hasNextPage": false,
"hasPrePage": false,
"lastRecordKey": null,
"countPage": true
},
"current_page": 1
},
"code": 1,
"msg": "",
"dict": {
"status": {
"0": "暂未开通",
"1": "已开通"
}
}
}
```
## 产品信息
### 查询产品信息列表
**请求URL:** product/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询产品信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
productName|String|否|产品名称,字段前后添加%%模糊查询
**请求样例:**
```
{
"productName":"jw0zaw",
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|序号，主键，自增长
  siteId|Long|站点id
  productName|String|产品名称
  logoUrl|String|Logo图片地址
  productCode|String|产品编码
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看产品信息
**请求URL:** product/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看产品信息，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/product/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 siteId|Long|站点id
 productName|String|产品名称
 logoUrl|String|Logo图片地址
 productCode|String|产品编码
 createUserId|Long|创建用户
 createTime|Date|创建时间
 updateUserId|Long|更新用户
 updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":2951,
"siteId":7224,
"productName":"1cesv6",
"logoUrl":"lffuww",
"productCode":"fyqjsh",
"createUserId":3088,
"createTime":"2023-02-22",
"updateUserId":6392,
"updateTime":"2023-02-22"
}
}
```
### 保存更新产品信息
**请求URL:** product/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新产品信息：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
siteId|Long|是|站点id
productName|String|是|产品名称
logoUrl|String|否|Logo图片地址
productCode|String|否|产品编码
**请求样例:**
```
{
"siteId":9818,
"productName":"2ruf5h",
"logoUrl":"x3fzju",
"productCode":"atu4eb",
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  siteId|Long|站点id
  productName|String|产品名称
  logoUrl|String|Logo图片地址
  productCode|String|产品编码
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除产品信息
**请求URL:** product/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除产品信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/product/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 产品接口
### 查询产品接口列表
**请求URL:** product/interface/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询皮肤配置
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
interfaceName|String|否|接口名称,字段前后添加%%模糊查询
**请求样例:**
```
{
"interfaceName":"6r9byq",
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|序号，主键，自增长
  productId|Long|产品id
  interfaceName|String|接口名称
  versionNumber|String|版本号
  requestType|Integer|请求类型1:POST,2:GET
  requestProtocol|Integer|请求协议1:HTTP,2:HTTPS
  requestUrl|String|请求路径
  timeoutValue|Long|超时时间（秒）
  limitStrategy|Integer|限流策略1:分钟,2:小时
  network|String|访问网络1互联网2政务网
  description|String|接口描述
  flowControl|String|流控信息
  authorizeInfo|String|授权信息
  interfaceTag|Integer|标签
  interfaceSource|Integer|来源1自有2非自有
  requestParameters|String|请求参数
  responseParameters|String|响应数据
  errorCode|String|错误码
  changeHistory|String|变更历史
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看产品接口
**请求URL:** product/interface/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看皮肤配置，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/product/interface/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 productId|Long|产品id
 interfaceName|String|接口名称
 versionNumber|String|版本号
 requestType|Integer|请求类型1:POST,2:GET
 requestProtocol|Integer|请求协议1:HTTP,2:HTTPS
 requestUrl|String|请求路径
 timeoutValue|Long|超时时间（秒）
 limitStrategy|Integer|限流策略1:分钟,2:小时
 network|String|访问网络1互联网2政务网
 description|String|接口描述
 flowControl|String|流控信息
 authorizeInfo|String|授权信息
 interfaceTag|Integer|标签
 interfaceSource|Integer|来源1自有2非自有
 requestParameters|String|请求参数
 responseParameters|String|响应数据
 errorCode|String|错误码
 changeHistory|String|变更历史
 createUserId|Long|创建用户
 createTime|Date|创建时间
 updateUserId|Long|更新用户
 updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":7206,
"productId":5818,
"interfaceName":"obik94",
"versionNumber":"63w89e",
"requestType":3731,
"requestProtocol":4957,
"requestUrl":"nsgum9",
"timeoutValue":6492,
"limitStrategy":7226,
"network":"xyh4zk",
"description":"xduu8d",
"flowControl":"qowkjr",
"authorizeInfo":"lpwmrs",
"interfaceTag":6647,
"interfaceSource":4194,
"requestParameters":"06p0p6",
"responseParameters":"xjrdki",
"errorCode":"gqpdfz",
"changeHistory":"zrewsd",
"createUserId":2945,
"createTime":"2023-02-22",
"updateUserId":5948,
"updateTime":"2023-02-22"
}
}
```
### 保存更新产品接口
**请求URL:** product/interface/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新皮肤配置：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
interfaceName|String|是|接口名称
versionNumber|String|是|版本号
requestType|Integer|否|请求类型1:POST,2:GET
requestProtocol|Integer|否|请求协议1:HTTP,2:HTTPS
requestUrl|String|否|请求路径
timeoutValue|Long|否|超时时间（秒）
limitStrategy|Integer|否|限流策略1:分钟,2:小时
network|String|否|访问网络1互联网2政务网
description|String|否|接口描述
flowControl|String|否|流控信息
authorizeInfo|String|否|授权信息
interfaceTag|Integer|否|标签
interfaceSource|Integer|否|来源1自有2非自有
requestParameters|String|否|请求参数
responseParameters|String|否|响应数据
errorCode|String|否|错误码
changeHistory|String|否|变更历史
**请求样例:**
```
{
"productId":5754,
"interfaceName":"oonsdl",
"versionNumber":"u8h8j7",
"requestType":2679,
"requestProtocol":6410,
"requestUrl":"fzehdo",
"timeoutValue":6733,
"limitStrategy":7588,
"network":"r7mg3s",
"description":"2x0ngs",
"flowControl":"3kbeme",
"authorizeInfo":"ydaai8",
"interfaceTag":3004,
"interfaceSource":545,
"requestParameters":"57bggp",
"responseParameters":"ts01jo",
"errorCode":"t0kax8",
"changeHistory":"sz500m",
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  productId|Long|产品id
  interfaceName|String|接口名称
  versionNumber|String|版本号
  requestType|Integer|请求类型1:POST,2:GET
  requestProtocol|Integer|请求协议1:HTTP,2:HTTPS
  requestUrl|String|请求路径
  timeoutValue|Long|超时时间（秒）
  limitStrategy|Integer|限流策略1:分钟,2:小时
  network|String|访问网络1互联网2政务网
  description|String|接口描述
  flowControl|String|流控信息
  authorizeInfo|String|授权信息
  interfaceTag|Integer|标签
  interfaceSource|Integer|来源1自有2非自有
  requestParameters|String|请求参数
  responseParameters|String|响应数据
  errorCode|String|错误码
  changeHistory|String|变更历史
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除产品接口
**请求URL:** product/interface/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除皮肤配置
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/product/interface/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 产品应用
### 查询产品应用列表
**请求URL:** product/apps/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询产品应用
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
appName|String|否|应用名称,字段前后添加%%模糊查询
deveLanguage|Integer|否|开发语言
**请求样例:**
```
{
"appName":"dabj6s",
"deveLanguage":4517,
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|序号，主键，自增长
  productId|Long|产品id
  appName|String|应用名称
  deveLanguage|Integer|开发语言
  versionNumber|String|版本号
  versionInfo|String|版本信息
  appFileUrl|String|应用文件地址
  isEnable|Integer|是否启用1是0否
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看产品应用
**请求URL:** product/apps/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看产品应用，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/product/apps/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 productId|Long|产品id
 appName|String|应用名称
 deveLanguage|Integer|开发语言
 versionNumber|String|版本号
 versionInfo|String|版本信息
 appFileUrl|String|应用文件地址
 isEnable|Integer|是否启用1是0否
 createUserId|Long|创建用户
 createTime|Date|创建时间
 updateUserId|Long|更新用户
 updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":8611,
"productId":897,
"appName":"mrwlbh",
"deveLanguage":8480,
"versionNumber":"xqvvhl",
"versionInfo":"iojhc3",
"appFileUrl":"lbf7gh",
"isEnable":3475,
"createUserId":2170,
"createTime":"2023-02-22",
"updateUserId":7758,
"updateTime":"2023-02-22"
}
}
```
### 保存更新产品应用
**请求URL:** product/apps/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新产品应用：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
appName|String|是|应用名称
deveLanguage|Integer|是|开发语言
versionNumber|String|否|版本号
versionInfo|String|否|版本信息
appFileUrl|String|否|应用文件地址
isEnable|Integer|否|是否启用1是0否
**请求样例:**
```
{
"productId":9130,
"appName":"791dbh",
"deveLanguage":2422,
"versionNumber":"28txka",
"versionInfo":"8vptzo",
"appFileUrl":"vcq9rb",
"isEnable":1340,
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  productId|Long|产品id
  appName|String|应用名称
  deveLanguage|Integer|开发语言
  versionNumber|String|版本号
  versionInfo|String|版本信息
  appFileUrl|String|应用文件地址
  isEnable|Integer|是否启用1是0否
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除产品应用
**请求URL:** product/apps/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除产品应用
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/product/apps/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 产品资料表
### 查询产品资料表列表
**请求URL:** product/document/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询产品资料表
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
docName|String|否|资料名称,字段前后添加%%模糊查询
**请求样例:**
```
{
"docName":"9ya7p4",
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|序号，主键，自增长
  productId|Long|产品id
  docName|String|资料名称
  versionNumber|String|版本号
  versionInfo|String|版本信息
  docFileUrl|String|资料文件地址
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 查看产品资料表
**请求URL:** product/document/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看产品资料表，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/product/document/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|序号，主键，自增长
 productId|Long|产品id
 docName|String|资料名称
 versionNumber|String|版本号
 versionInfo|String|版本信息
 docFileUrl|String|资料文件地址
 createUserId|Long|创建用户
 createTime|Date|创建时间
 updateUserId|Long|更新用户
 updateTime|Date|更新时间
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":1498,
"productId":70,
"docName":"40e03x",
"versionNumber":"3o3km7",
"versionInfo":"cytts5",
"docFileUrl":"jf0cg4",
"createUserId":3465,
"createTime":"2023-02-22",
"updateUserId":9383,
"updateTime":"2023-02-22"
}
}
```
### 保存更新产品资料表
**请求URL:** product/document/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新产品资料表：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
docName|String|是|资料名称
versionNumber|String|否|版本号
versionInfo|String|否|版本信息
docFileUrl|String|否|资料文件地址
**请求样例:**
```
{
"productId":7395,
"docName":"oilitn",
"versionNumber":"vk7ua4",
"versionInfo":"89f7cz",
"docFileUrl":"bpp5s8",
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  productId|Long|产品id
  docName|String|资料名称
  versionNumber|String|版本号
  versionInfo|String|版本信息
  docFileUrl|String|资料文件地址
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除产品资料表
**请求URL:** product/document/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除产品资料表
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/product/document/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 用户行为分析
### 客户端埋点
**请求URL:** zwfw/page/bury/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存页面事件记录
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|否|产品id
productName|String|否|产品名称
pageCode|String|否|页面编码（页面路由）
pageName|String|否|页面名称
sceneDepth|Integer|否|场景维度
depthValue|Integer|否|本次访问深度
eventInfo|object|否|页面事件信息
 businessCode|String|否|业务场景编码
 businessName|String|否|业务场景名称
 eventCode|String|否|事件编码
 eventName|String|否|事件名称
 takeTime|Integer|否|事件耗时（单位毫秒）
 coordinate|String|否|事件坐标(x,y)
routeInfo|object|否|页面路由信息
 sourceCode|String|否|开始页面编码（路由）
 sourceName|String|否|开始页面名称
 targetCode|String|否|目标页面编码（路由）
 targetName|String|否|目标页面名称
**请求样例:**
```
{
"productId": 7146,
"productName": "5x2mfa",
"pageCode": "gy92kw",
"pageName": "yxjkem",
"sceneDepth": 1,
"depthValue": 1,
"eventInfo": {
"businessCode": "hq6abb",
"businessName": "8996vc",
"eventCode": "u9xo59",
"eventName": "ku7l71",
"takeTime": 12345,
"coordinate": "12,13"
},
"routeInfo": {
"sourceCode": "6mq7ry",
"sourceName": "fxb3mk",
"targetCode": "fzrr3u",
"targetName": "fzrr3u"
}
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 productId|Long|产品id
 productName|String|产品名称
 pageCode|String|页面编码（页面路由）
 pageName|String|页面名称
 sceneDepth|Integer|场景维度
 depthValue|Integer|本次访问深度
 eventInfo|object|页面事件信息
  businessCode|String|业务场景编码
  businessName|String|业务场景名称
  eventCode|String|事件编码
  eventName|String|事件名称
  takeTime|Integer|事件耗时（单位毫秒）
  coordinate|String|事件坐标(x,y)
 routeInfo|object|页面路由信息
  sourceCode|String|开始页面编码（路由）
  sourceName|String|开始页面名称
  targetCode|String|目标页面编码（路由）
  targetName|String|目标页面名称
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 保存页面截图
**请求URL:** zwfw/page/bury/screen/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新产品页面配置：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
deviceNum|String|否|设备编码
productId|Long|否|产品id
productName|String|否|产品名称
pageCode|String|否|页面编码（页面路由）
pageName|String|否|页面名称
screenUrl|String|否|页面截图地址
**请求样例:**
```
{
"deviceNum":"fblh4k",
"productId":427,
"productName":"oo1k4e",
"pageCode":"5fzoqc",
"pageName":"r8smsl",
"screenUrl":"feq3hw",
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号，主键，自增长
  deviceNum|String|设备编码
  productId|Long|产品id
  productName|String|产品名称
  pageCode|String|页面编码（页面路由）
  pageName|String|页面名称
  screenUrl|String|页面截图地址
  createUserId|Long|创建用户
  createTime|Date|创建时间
  updateUserId|Long|更新用户
  updateTime|Date|更新时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 事件分析
**请求URL:** zwfw/act/analyse/pageEventCensus
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询事件分析
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-10",
"dateTimeEnd":"2023-05-11"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 data|array|数组对象
  eventCode|String|设备编码
  eventName|String|产品id
  dayAvg|int|事件日均数量
  takeTimeAvg|float|事件平均耗时（单位秒）
**响应消息样例:**
```
{
"data": {
"data": [
{
"eventCode": "Click",
"eventName": "点击",
"dayAvg": "47",
"takeTimeAvg": "0.96"
}
]
},
"code": 1,
"msg": "查询事件分析结果成功"
}
```
### 产品热力图
**请求URL:** zwfw/act/analyse/productHotCensus
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询产品热力图
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
pageCode|String|是|页面编码
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-10",
"dateTimeEnd":"2023-05-11",
"pageCode":"/"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 data|array|数组对象
  businessCode|String|业务编码
  businessName|String|业务名称
  coordinate|String|坐标信息
  x|float|页面x坐标
  y|float|页面y坐标
  value|int|事件点击次数
  proportion|String|事件占比
 clickSum|int|总点击次数
 screenUrl|String|页面截图保存地址
**响应消息样例:**
```
{
"data": {
"data": [
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "966,286",
"value": 4,
"x": 966.0,
"y": 286.0,
"proportion": "16.67%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "1844,558",
"value": 3,
"x": 1844.0,
"y": 558.0,
"proportion": "12.50%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "1861,906",
"value": 3,
"x": 1861.0,
"y": 906.0,
"proportion": "12.50%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "1073,242",
"value": 3,
"x": 1073.0,
"y": 242.0,
"proportion": "12.50%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "932,13",
"value": 2,
"x": 932.0,
"y": 13.0,
"proportion": "8.33%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "1882,900",
"value": 2,
"x": 1882.0,
"y": 900.0,
"proportion": "8.33%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "986,13",
"value": 2,
"x": 986.0,
"y": 13.0,
"proportion": "8.33%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "152,1812",
"value": 2,
"x": 152.0,
"y": 1812.0,
"proportion": "8.33%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "180,1820",
"value": 2,
"x": 180.0,
"y": 1820.0,
"proportion": "8.33%"
},
{
"businessCode": "/",
"businessName": "首页",
"coordinate": "899,337",
"value": 1,
"x": 899.0,
"y": 337.0,
"proportion": "4.17%"
}
],
"clickSum": 24,
"screenUrl": "/file/uploadfile/1681357141107.png"
},
"code": 1,
"msg": "查询产品热力图成功"
}
```
### 页面访问分析
**请求URL:** zwfw/act/analyse/accessAnalyse
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询页面访问分析
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-10",
"dateTimeEnd":"2023-05-11"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 accessTrend|array|页面访问趋势图
  accessDay|String|日期
  accessCount|int|访问次数
 pageAccessTop|array|页面访问次数TOP10
  pageCode|String|页面编码
  pageName|String|页面名称
  accessCount|int|访问次数
 accessSum|int|页面累计访问次数
 dayAccessAvg|float|日均访问次数
 depthAvg|float|人均访问深度
 singleDepth|float|次均访问深度
**响应消息样例:**
```
{
"data": {
"dayAccessAvg": 234.0,
"accessTrend": [
{
"accessDay": "04-12",
"accessCount": 245
},
{
"accessDay": "04-13",
"accessCount": 251
},
{
"accessDay": "04-14",
"accessCount": 206
}
],
"pageAccessTop": [
{
"pageCode": "/",
"pageName": "首页",
"accessCount": 371
},
{
"pageCode": "/floor",
"pageName": "中心导航",
"accessCount": 165
},
{
"pageCode": "/business/test001",
"pageName": "办理业务",
"accessCount": 60
},
{
"pageCode": "/business/166",
"pageName": "办理业务",
"accessCount": 24
},
{
"pageCode": "/makeTakeNum",
"pageName": "预约取号",
"accessCount": 23
},
{
"pageCode": "/Layout",
"pageName": "应用集市",
"accessCount": 22
},
{
"pageCode": "/signInWay",
"pageName": "签到方式",
"accessCount": 13
},
{
"pageCode": "/business/148",
"pageName": "办理业务",
"accessCount": 8
},
{
"pageCode": "/signInWay?matterId=34464&businessid=169&phone=1&idcardtake=1&face=0",
"pageName": "签到方式",
"accessCount": 5
},
{
"pageCode": "/signInWay?businessid=149&phone=1&idcardtake=1&face=0",
"pageName": "签到方式",
"accessCount": 4
}
],
"depthAvg": 2.08,
"accessSum": 702,
"singleDepth": 2.08
},
"code": 1,
"msg": "查询页面访问分析成功"
}
```
### 页面路径访问分析
**请求URL:** zwfw/act/analyse/wayAccessAnalyse
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询页面路径访问分析
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-10",
"dateTimeEnd":"2023-05-11"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 data|array|页面
  code|String|页面code
  name|String|页面name
 links|array|页面路径
  source|String|开始页面
  sourceName|String|开始页面名称
  target|String|目标页面
  targetName|String|目标页面名称
  value|int|访问次数
**响应消息样例:**
```
{
"data": {
"data": [
{
"code": "/",
"name": "首页"
},
{
"code": "/floor",
"name": "中心导航"
},
{
"code": "/Layout",
"name": "应用集市"
},
{
"code": "/business/test001",
"name": "办理业务"
},
{
"code": "/business/148",
"name": "办理业务"
},
{
"code": "/makeTakeNum",
"name": "预约取号"
},
{
"code": "/makeList?phone=13730664362",
"name": "预约列表"
},
{
"code": "/signInWay?businessid=149&phone=1&idcardtake=1&face=0",
"name": "签到方式"
},
{
"code": "/print?state=error",
"name": "打印"
},
{
"code": "/business/166",
"name": "办理业务"
},
{
"code": "/bizMatters?businessid=170&phone=1&idcardtake=1&face=0",
"name": "业务事项"
},
{
"code": "/bizMatters",
"name": "业务事项"
},
{
"code": "/signInWay",
"name": "签到方式"
},
{
"code": "/print",
"name": "打印"
}
],
"links": [
{
"source": "/",
"sourceName": "首页",
"target": "/",
"targetName": "首页",
"value": 143
},
{
"source": "/",
"sourceName": "首页",
"target": "/business/test001",
"targetName": "办理业务",
"value": 38
},
{
"source": "/",
"sourceName": "首页",
"target": "/floor",
"targetName": "中心导航",
"value": 142
},
{
"source": "/",
"sourceName": "首页",
"target": "/Layout",
"targetName": "应用集市",
"value": 16
},
{
"source": "/",
"sourceName": "首页",
"target": "/makeTakeNum",
"targetName": "预约取号",
"value": 8
},
{
"source": "/",
"sourceName": "首页",
"target": "/print",
"targetName": "打印",
"value": 1
},
{
"source": "/bizMatters",
"sourceName": "业务事项",
"target": "/",
"targetName": "首页",
"value": 2
},
{
"source": "/bizMatters",
"sourceName": "业务事项",
"target": "/signInWay",
"targetName": "签到方式",
"value": 8
},
{
"source": "/bizMatters?businessid=170&phone=1&idcardtake=1&face=0",
"sourceName": "业务事项",
"target": "/",
"targetName": "首页",
"value": 1
},
{
"source": "/business/148",
"sourceName": "办理业务",
"target": "/",
"targetName": "首页",
"value": 2
},
{
"source": "/business/148",
"sourceName": "办理业务",
"target": "/signInWay",
"targetName": "签到方式",
"value": 2
},
{
"source": "/business/148",
"sourceName": "办理业务",
"target": "/signInWay?businessid=149&phone=1&idcardtake=1&face=0",
"targetName": "签到方式",
"value": 1
},
{
"source": "/business/166",
"sourceName": "办理业务",
"target": "/",
"targetName": "首页",
"value": 3
},
{
"source": "/business/166",
"sourceName": "办理业务",
"target": "/bizMatters",
"targetName": "业务事项",
"value": 9
},
{
"source": "/business/166",
"sourceName": "办理业务",
"target": "/bizMatters?businessid=170&phone=1&idcardtake=1&face=0",
"targetName": "业务事项",
"value": 1
},
{
"source": "/business/test001",
"sourceName": "办理业务",
"target": "/",
"targetName": "首页",
"value": 17
},
{
"source": "/business/test001",
"sourceName": "办理业务",
"target": "/bizMatters",
"targetName": "业务事项",
"value": 1
},
{
"source": "/business/test001",
"sourceName": "办理业务",
"target": "/business/148",
"targetName": "办理业务",
"value": 5
},
{
"source": "/business/test001",
"sourceName": "办理业务",
"target": "/business/166",
"targetName": "办理业务",
"value": 13
},
{
"source": "/business/test001",
"sourceName": "办理业务",
"target": "/signInWay",
"targetName": "签到方式",
"value": 2
},
{
"source": "/floor",
"sourceName": "中心导航",
"target": "/",
"targetName": "首页",
"value": 130
},
{
"source": "/Layout",
"sourceName": "应用集市",
"target": "/",
"targetName": "首页",
"value": 16
},
{
"source": "/makeList?phone=13730664362",
"sourceName": "预约列表",
"target": "/",
"targetName": "首页",
"value": 1
},
{
"source": "/makeList?phone=13730664362",
"sourceName": "预约列表",
"target": "/makeTakeNum",
"targetName": "预约取号",
"value": 1
},
{
"source": "/makeTakeNum",
"sourceName": "预约取号",
"target": "/",
"targetName": "首页",
"value": 7
},
{
"source": "/makeTakeNum",
"sourceName": "预约取号",
"target": "/makeList?phone=13730664362",
"targetName": "预约列表",
"value": 2
},
{
"source": "/print",
"sourceName": "打印",
"target": "/",
"targetName": "首页",
"value": 3
},
{
"source": "/print?state=error",
"sourceName": "打印",
"target": "/",
"targetName": "首页",
"value": 1
},
{
"source": "/signInWay",
"sourceName": "签到方式",
"target": "/",
"targetName": "首页",
"value": 9
},
{
"source": "/signInWay",
"sourceName": "签到方式",
"target": "/print",
"targetName": "打印",
"value": 3
},
{
"source": "/signInWay?businessid=149&phone=1&idcardtake=1&face=0",
"sourceName": "签到方式",
"target": "/print?state=error",
"targetName": "打印",
"value": 1
}
]
},
"code": 1,
"msg": "查询页面路径访问分析成功"
}
```
### 页面使用习惯分析
**请求URL:** zwfw/act/analyse/usageCensus
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询页面使用习惯分析
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
businessCode|String|否|业务功能code，多个code使用","隔开
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-10",
"dateTimeEnd":"2023-05-11",
"businessCode":"非必填，业务功能code，多个code使用逗号隔开"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|array|数据对象
 businessCode|String|业务功能code
 businessName|String|业务功能name
 accessCount|int|访问次数
 proportion|String|占比
 propValue|String|占比值
**响应消息样例:**
```
{
"data": [
{
"businessCode": "/",
"businessName": "首页",
"accessCount": 2,
"proportion": "50.00%",
"propValue": 0.5
},
{
"businessCode": "/floor",
"businessName": "中心导航",
"accessCount": 1,
"proportion": "25.00%",
"propValue": 0.25
},
{
"businessCode": "/Layout",
"businessName": "中心导航",
"accessCount": 1,
"proportion": "25.00%",
"propValue": 0.25
}
],
"code": 1,
"msg": "查询页面使用习惯分析成功"
}
```
### 页面信息流分析
**请求URL:** zwfw/act/analyse/informationFlow
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询页面信息流分析
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
productId|Long|是|产品id
dateTimeStart|String|是|开始时间
dateTimeStart|String|是|结束时间
particleType|int|是|时间颗粒度 1:10分钟，2:30分钟，3:1小时
isRatio|int|是|是否开启日对比1是0否
**请求样例:**
```
{
"productId":1,
"dateTimeStart":"2023-04-15",
"dateTimeEnd":"2023-04-15",
"particleType":1,
"isRatio":1
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|array|数据对象
 productId|long|产品id
 dateStr|String|分组时间
 productName|String|产品名称
 firstCode|String|一级场景code
 firstName|String|一级场景name
 secondCode|String|二级场景code
 secondName|String|二级场景name
 thirdCode|String|三级场景code
 thirdName|String|三级场景name
 fourthCode|String|四级场景code
 fourthName|String|四级场景name
 accessCount|int|访问次数，打开次数
 pageDepth|int|访问页面数
 accessRatio|int|访问次数增量
 depthRatio|int|访问页面数增量
**响应消息样例:**
```
{
"data": [
{
"deleted": 0,
"accessCount": 1,
"dateStr": "2023-04-15 21:00:00",
"timeStr": "21:00:00",
"accessRatio": 0.0,
"depthRatio": 0.0,
"productId": 1,
"productName": "导视机",
"firstCode": "/",
"firstName": "首页",
"secondCode": "/floor",
"secondName": "中心导航",
"thirdCode": "--",
"thirdName": "--",
"fourthCode": "--",
"fourthName": "--",
"pageDepth": 2
},
{
"deleted": 0,
"accessCount": 2,
"dateStr": "2023-04-15 21:10:00",
"timeStr": "21:10:00",
"accessRatio": -0.33,
"depthRatio": 0.0,
"productId": 1,
"productName": "导视机",
"firstCode": "/",
"firstName": "首页",
"secondCode": "/floor",
"secondName": "中心导航",
"thirdCode": "--",
"thirdName": "--",
"fourthCode": "--",
"fourthName": "--",
"pageDepth": 2
},
{
"deleted": 0,
"accessCount": 2,
"dateStr": "2023-04-15 21:20:00",
"timeStr": "21:20:00",
"accessRatio": -0.33,
"depthRatio": 0.0,
"productId": 1,
"productName": "导视机",
"firstCode": "/",
"firstName": "首页",
"secondCode": "/floor",
"secondName": "中心导航",
"thirdCode": "--",
"thirdName": "--",
"fourthCode": "--",
"fourthName": "--",
"pageDepth": 2
},
{
"deleted": 0,
"accessCount": 2,
"dateStr": "2023-04-15 21:30:00",
"timeStr": "21:30:00",
"accessRatio": -0.33,
"depthRatio": 0.0,
"productId": 1,
"productName": "导视机",
"firstCode": "/",
"firstName": "首页",
"secondCode": "/floor",
"secondName": "中心导航",
"thirdCode": "--",
"thirdName": "--",
"fourthCode": "--",
"fourthName": "--",
"pageDepth": 2
}
],
"code": 1,
"msg": "查询信息流分析成功"
}
```
## 字典附录
### userType
字典参数key|字典参数值|其它
:---|:---|:---
0|系统用户|-
1|普通用户|-
2|工作人员|-
### status
字典参数key|字典参数值|其它
:---|:---|:---
0|停用|-
1|正常|-
2|冻结|-
3|销户|-
4|离职|-
### roleType
字典参数key|字典参数值|其它
:---|:---|:---
0|系统内置角色|-
1|默认系统角色|-
2|普通角色|-
### roleType
字典参数key|字典参数值|其它
:---|:---|:---
0|停用|-
1|启用|-
### linkType
字典参数key|字典参数值|其它
:---|:---|:---
0|普通|-
1|弹出|-
2|脚本|-
### visible
字典参数key|字典参数值|其它
:---|:---|:---
0|隐藏|-
1|显示|-
### menuType
字典参数key|字典参数值|其它
:---|:---|:---
0|目录|-
1|菜单|-
2|按钮|-
### status
字典参数key|字典参数值|其它
:---|:---|:---
0|禁用|-
1|启用|-
### authType
字典参数key|字典参数值|其它
:---|:---|:---
0|无限制|-
1|无需登录查看|-
2|需要登录查看|-
3|需要角色权限查看|-
### fileType
字典参数key|字典参数值|其它
:---|:---|:---
1|excel|-
2|img|-
3|zip|-
4|pdf|-
### validStatus
字典参数key|字典参数值|其它
:---|:---|:---
0|禁用|-
1|启用|-
### modStatus
字典参数key|字典参数值|其它
:---|:---|:---
0|隐藏|-
1|页面仅查看|-
2|页面可修改|-
3|页面可删除|-
4|页面可修改删除|-
### displayType
字典参数key|字典参数值|其它
:---|:---|:---
0|普通文本框|-
1|多行文本框|-
2|开关|-
3|块输入框|-
### status
字典参数key|字典参数值|其它
:---|:---|:---
1|执行中|-
### excuteStrategy
字典参数key|字典参数值|其它
:---|:---|:---
1|按日|-
2|按周|-
3|按月|-
4|按间隔时间|-
### interimExcuteStatus
字典参数key|字典参数值|其它
:---|:---|:---
0|未启用|-
1|立即执行并保留|-
2|立即执行并删除|-
### operType
字典参数key|字典参数值|其它
:---|:---|:---
0|新增|-
1|修改|-
2|删除|-