| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
v2023-06-10 20:04:09 | 2023-06-10 20:04:09 | auto | @Administrator | Created by smart-doc |
1. 在线低代码表单设计
1.1. 获取字典类型列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取字典类型列表
Request-example:
curl -X GET -i http://127.0.0.1/lcd/online/dictTypeResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─name | string | 返回字典名称 | - |
└─type | string | 字典类型 | - |
Response-example:
{
"code": 582,
"message": "success",
"data": [
{
"name": "浩轩.孙",
"type": "qiseq1"
}
]
}1.2. 生成后端代码
Type: POST
Content-Type: application/json; charset=utf-8
Description: 生成后端代码
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
menuId | int64 | 父菜单的id | false | - |
outDir | string | 输出目录 | false | - |
tables | array | 要生成的表名列表 | false | - |
importMenu | boolean | 是否导入菜单 | false | - |
fileOverride | boolean | 文件存在是否覆盖 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/online/java --data '{
"menuId": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"outDir": "5x4cpk",
"tables": [
"tdalv3"
],
"importMenu": true,
"fileOverride": true
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 293,
"message": "success",
"data": true
}1.3. 生成前端代码
Type: POST
Content-Type: application/json; charset=utf-8
Description: 生成前端代码
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
menuId | int64 | 父菜单的id | false | - |
outDir | string | 输出目录 | false | - |
tables | array | 要生成的表名列表 | false | - |
importMenu | boolean | 是否导入菜单 | false | - |
fileOverride | boolean | 文件存在是否覆盖 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/online/vue --data '{
"menuId": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"outDir": "42eb41",
"tables": [
"e087cp"
],
"importMenu": true,
"fileOverride": true
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
- | int8 | Return int8. | - |
Response-example:
{
"code": 771,
"message": "success",
"data": [
"14",
"92"
]
}1.4. 生成表
Type: POST
Content-Type: application/json; charset=utf-8
Description: 生成表
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
menuId | int64 | 父菜单的id | false | - |
outDir | string | 输出目录 | false | - |
tables | array | 要生成的表名列表 | false | - |
importMenu | boolean | 是否导入菜单 | false | - |
fileOverride | boolean | 文件存在是否覆盖 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/online/tables --data '{
"menuId": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"outDir": "a7aa54",
"tables": [
"whe4f5"
],
"importMenu": true,
"fileOverride": true
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 687,
"message": "success",
"data": {
"mapKey1": 538,
"mapKey2": 528
}
}1.5. 预览生成的源代码
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 预览生成的源代码
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
tableName | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/lcd/online/review?tableName=浩轩.孙Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─entity | string | No comments found. | - |
└─controller | string | No comments found. | - |
└─mapperXml | string | No comments found. | - |
└─service | string | No comments found. | - |
└─serviceImpl | string | No comments found. | - |
└─html | string | No comments found. | - |
└─mapper | string | No comments found. | - |
└─dto | string | No comments found. | - |
└─menuSql | string | No comments found. | - |
Response-example:
{
"code": 316,
"message": "success",
"data": {
"entity": "7gbe7u",
"controller": "99tsal",
"mapperXml": "i4466w",
"service": "lesynr",
"serviceImpl": "s9f4xm",
"html": "75e5oj",
"mapper": "fyiop4",
"dto": "138yqp",
"menuSql": "q1td02"
}
}3.
3.1.
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Request-example:
curl -X GET -i http://127.0.0.1/lcd/Response-example:
string4. <p>低代码功能设计管理</p>
4.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 功能名称 | false | - |
└─tableName | string | 表明 | false | - |
└─comment | string | 表说明 | false | - |
└─ivzone | object | ivzone组件库 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─edit | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─search | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─formTable | object | 表组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─global | object | 全局组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─container | object | 容器组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─sqlScript | string | sql脚本 | false | - |
└─tableExists | boolean | 是否表已经创建 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | No comments found. | false | - |
└─existsDesc | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 功能名称 | false | - |
└─tableName | string | 表明 | false | - |
└─comment | string | 表说明 | false | - |
└─ivzone | object | ivzone组件库 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─edit | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─search | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─formTable | object | 表组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─global | object | 全局组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─container | object | 容器组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
└─sqlScript | string | sql脚本 | false | - |
└─tableExists | boolean | 是否表已经创建 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | No comments found. | false | - |
└─existsDesc | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 功能名称 | false | - |
tableName | string | 表明 | false | - |
comment | string | 表说明 | false | - |
ivzone | object | ivzone组件库 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
edit | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
search | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
formTable | object | 表组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
global | object | 全局组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
container | object | 容器组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
sqlScript | string | sql脚本 | false | - |
tableExists | boolean | 是否表已经创建 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | No comments found. | false | - |
existsDesc | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/lcd/design/view?records[0].updateTime=2023-06-10&edit.object=true&ivzone.array=true&orders[0].global.array=true&size=841&search.missingNode=true&records[0].global.object=true&orders[0].edit.containerNode=true&container._nodeFactory._cfgBigDecimalExact=true&ivzone.object=true&records[0].container._nodeFactory._cfgBigDecimalExact=true&global.valueNode=true&orders[0].formTable.object=true&records[0].global.valueNode=true&isSearchCount=true&createTime=2023-06-10&records[0].search.array=true&orders[0].global.containerNode=true&orders[0].edit.array=true&tableName=浩轩.孙&records[0].edit.valueNode=true¤t=381&orders[0].ivzone.object=true&orders[0].edit.object=true&orders[0].search.object=true&orders[0].container.containerNode=true&orders[0].container._nodeFactory._cfgBigDecimalExact=true&formTable.valueNode=true&hitCount=true&records[0].edit.object=true&orders[0].ivzone._nodeFactory._cfgBigDecimalExact=true&records[0].name=浩轩.孙&orders[0].updateTime=2023-06-10&records[0].ivzone.array=true&records[0].search.object=true&global.containerNode=true&formTable.object=true&records[0].search.missingNode=true&records[0].edit._nodeFactory._cfgBigDecimalExact=true&orders[0].formTable.valueNode=true&formTable.missingNode=true&comment=pip6w6&orders[0].edit.missingNode=true&records[0].container.containerNode=true&orders[0].edit.valueNode=true&records[0].container.valueNode=true&records[0].formTable.valueNode=true&container.object=true&ivzone._nodeFactory._cfgBigDecimalExact=true&id=172&name=浩轩.孙&edit.valueNode=true&records[0].container.object=true&formTable.array=true&global._nodeFactory._cfgBigDecimalExact=true&container.missingNode=true&tableExists=true&countId=197&orders[0].ivzone.array=true&search.containerNode=true&orders[0].sqlScript=ef0eae&updateTime=2023-06-10&records[0].ivzone.missingNode=true&records[0].formTable._nodeFactory._cfgBigDecimalExact=true&ivzone.valueNode=true&sqlScript=eoyrnh&edit.array=true&records[0].ivzone._nodeFactory._cfgBigDecimalExact=true&records[0].container.array=true&searchCount=true&edit.missingNode=true&orders[0].tableName=浩轩.孙&records[0].formTable.containerNode=true&records[0].tableExists=true&records[0].existsDesc=k4atn9&orders[0].container.missingNode=true&orders[0].search._nodeFactory._cfgBigDecimalExact=true&orders[0].tableExists=true&orders[0].search.valueNode=true&orders[0].formTable.containerNode=true&orders[0].ivzone.missingNode=true&records[0].formTable.missingNode=true&orders[0].global.missingNode=true&maxLimit=91&global.array=true&records[0].ivzone.containerNode=true&orders[0].ivzone.containerNode=true&global.missingNode=true&orders[0].name=浩轩.孙&records[0].edit.containerNode=true&records[0].global.missingNode=true&orders[0].existsDesc=rsxxyb&total=101&orders[0].container.array=true&ivzone.missingNode=true&orders[0].edit._nodeFactory._cfgBigDecimalExact=true&records[0].global.containerNode=true&records[0].ivzone.valueNode=true&records[0].comment=0f674c&orders[0].id=522&orders[0].ivzone.valueNode=true&global.object=true&records[0].createTime=2023-06-10&records[0].ivzone.object=true&orders[0].search.containerNode=true&records[0].tableName=浩轩.孙&records[0].search.containerNode=true&orders[0].formTable.missingNode=true&orders[0].container.object=true&orders[0].global.object=true&orders[0].search.array=true&records[0].search.valueNode=true&pages=662&orders[0].comment=g8erpj&records[0].edit.array=true&records[0].id=166&records[0].container.missingNode=true&orders[0].global.valueNode=true&orders[0].global._nodeFactory._cfgBigDecimalExact=true&orders[0].search.missingNode=true&optimizeCountSql=true&formTable._nodeFactory._cfgBigDecimalExact=true&orders[0].formTable.array=true&orders[0].createTime=2023-06-10&records[0].edit.missingNode=true&search.array=true&formTable.containerNode=true&existsDesc=jrqbxe&orders[0].container.valueNode=true&edit.containerNode=true&records[0].search._nodeFactory._cfgBigDecimalExact=true&records[0].global._nodeFactory._cfgBigDecimalExact=true&search._nodeFactory._cfgBigDecimalExact=true&records[0].sqlScript=22oou1&search.valueNode=true&search.object=true&edit._nodeFactory._cfgBigDecimalExact=true&orders[0].formTable._nodeFactory._cfgBigDecimalExact=true&container.valueNode=true&ivzone.containerNode=true&container.array=true&records[0].formTable.array=true&records[0].global.array=true&container.containerNode=true&records[0].formTable.object=trueResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 功能名称 | - |
└─tableName | string | 表明 | - |
└─comment | string | 表说明 | - |
└─ivzone | object | ivzone组件库 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─edit | object | 编辑组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─search | object | 编辑组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─formTable | object | 表组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─global | object | 全局组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─container | object | 容器组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─sqlScript | string | sql脚本 | - |
└─tableExists | boolean | 是否表已经创建 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | No comments found. | - |
└─existsDesc | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 134,
"message": "success",
"data": {
"size": 690,
"total": 717,
"pages": 58,
"current": 711,
"records": [
{
"id": 339,
"section": [
{
}
],
"name": "浩轩.孙",
"tableName": "浩轩.孙",
"comment": "t4m07r",
"ivzone": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"edit": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"search": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"formTable": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"global": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"container": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"sqlScript": "cfcmmq",
"tableExists": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"existsDesc": "ypnz58"
}
],
"searchCount": true,
"hitCount": true
}
}4.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/lcd/design/edit?id=397Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 功能名称 | - |
└─tableName | string | 表明 | - |
└─comment | string | 表说明 | - |
└─ivzone | object | ivzone组件库 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─edit | object | 编辑组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─search | object | 编辑组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─formTable | object | 表组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─global | object | 全局组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─container | object | 容器组件配置 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─sqlScript | string | sql脚本 | - |
└─tableExists | boolean | 是否表已经创建 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | No comments found. | - |
└─existsDesc | string | No comments found. | - |
Response-example:
{
"code": 893,
"message": "success",
"data": {
"id": 772,
"section": [
{
}
],
"name": "浩轩.孙",
"tableName": "浩轩.孙",
"comment": "mrlrhe",
"ivzone": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"edit": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"search": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"formTable": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"global": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"container": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"sqlScript": "hs5tos",
"tableExists": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"existsDesc": "hmtnqp"
}
}4.3. 修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 功能名称 | false | - |
tableName | string | 表明 | false | - |
comment | string | 表说明 | false | - |
ivzone | object | ivzone组件库 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
edit | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
search | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
formTable | object | 表组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
global | object | 全局组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
container | object | 容器组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
sqlScript | string | sql脚本 | false | - |
tableExists | boolean | 是否表已经创建 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | No comments found. | false | - |
existsDesc | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/design/edit --data '{
"id": 357,
"section": [
{
}
],
"name": "浩轩.孙",
"tableName": "浩轩.孙",
"comment": "9itlkt",
"ivzone": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"edit": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"search": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"formTable": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"global": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"container": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"sqlScript": "vhpsp4",
"tableExists": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"existsDesc": "cc8x45"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 913,
"message": "success",
"data": true
}4.4. 新增记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 功能名称 | false | - |
tableName | string | 表明 | false | - |
comment | string | 表说明 | false | - |
ivzone | object | ivzone组件库 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
edit | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
search | object | 编辑组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
formTable | object | 表组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
global | object | 全局组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
container | object | 容器组件配置 | false | - |
└─array | boolean | No comments found. | false | - |
└─object | boolean | No comments found. | false | - |
└─valueNode | boolean | No comments found. | false | - |
└─containerNode | boolean | No comments found. | false | - |
└─missingNode | boolean | No comments found. | false | - |
└─_nodeFactory | object | No comments found. | false | - |
└─_cfgBigDecimalExact | boolean | No comments found. | false | - |
sqlScript | string | sql脚本 | false | - |
tableExists | boolean | 是否表已经创建 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | No comments found. | false | - |
existsDesc | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/design/add --data '{
"id": 701,
"section": [
{
}
],
"name": "浩轩.孙",
"tableName": "浩轩.孙",
"comment": "hxarq4",
"ivzone": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"edit": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"search": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"formTable": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"global": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"container": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
}
},
"sqlScript": "k6vre6",
"tableExists": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"existsDesc": "r09lqv"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 170,
"message": "success",
"data": 433
}4.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/lcd/design/del --data '[
295,
280
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 318,
"message": "success",
"data": true
}4.6. 外键列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 外键列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 不包含的表 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/lcd/design/foreign?id=345Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─type | string | 字段类型 | - |
└─disabled | boolean | No comments found. | - |
└─isLeaf | boolean | No comments found. | - |
└─target | object | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─children | array | No comments found. | - |
Response-example:
{
"code": 314,
"message": "success",
"data": [
{
"label": "ymmmkb",
"value": "vfmz14",
"type": "nvipwt",
"disabled": true,
"isLeaf": true,
"target": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true
},
"children": [
{
"$ref": ".."
}
]
}
]
}4.7. 外键列
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 外键列
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
tableName | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/lcd/design/columns?tableName=浩轩.孙Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─type | string | 字段类型 | - |
└─disabled | boolean | No comments found. | - |
└─isLeaf | boolean | No comments found. | - |
└─target | object | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─children | array | No comments found. | - |
Response-example:
{
"code": 712,
"message": "success",
"data": [
{
"label": "l8ey2z",
"value": "vu38z3",
"type": "tf3b3k",
"disabled": true,
"isLeaf": true,
"target": {
"array": true,
"object": true,
"valueNode": true,
"containerNode": true,
"missingNode": true
},
"children": [
{
"$ref": ".."
}
]
}
]
}5. 校验码功能
5.1. 获取验证码
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取验证码
Request-example:
curl -X GET -i http://127.0.0.1/valid/captchaResponse-example:
Doesn't return a value.6. 后台用户管理中心
6.1. 菜单栏
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 菜单栏
Request-example:
curl -X GET -i http://127.0.0.1/core/center/menusResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 715,
"message": "success",
"data": [
{
"id": 456,
"section": [
{
}
],
"pid": 306,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "znh92i",
"icon": "34gi87",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 76,
"status": "enabled",
"perms": "oeseyd",
"remark": "ysr780",
"log": true,
"logDesc": "8z0gwz",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}6.2. 上传用户头像
Type: POST
Content-Type: multipart/form-data
Description: 上传用户头像
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
file | file | No comments found. | true | - |
Request-example:
curl -X POST -H 'Content-Type: multipart/form-data' -i http://127.0.0.1/core/center/avatarResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 398,
"message": "success",
"data": "5o32zz"
}6.3. 获取用户详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取用户详情
Request-example:
curl -X GET -i http://127.0.0.1/core/center/detailResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─sex | string | 性别 | - |
└─orgId | int64 | 所属部门 | - |
└─name | string | 用户昵称 | - |
string | 邮箱 | - | |
└─phone | string | 手机号 | - |
└─avatar | string | 用户头像 | - |
└─remark | string | 备注 | - |
└─account | string | 用户账号 | - |
└─loginIp | string | 登录ip | - |
└─loginDate | string | 登录时间 | - |
└─status | enum | 用户状态(enabled, disabled) | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─deptName | string | 所属部门 | - |
└─roleNames | string | 角色名称列表 | - |
└─roleIds | array | 角色列表 | - |
Response-example:
{
"code": 136,
"message": "success",
"data": {
"id": 236,
"section": [
{
}
],
"sex": "lbw8m4",
"orgId": 930,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "9fw3ck",
"remark": "cbrphy",
"account": "c8cy2l",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deptName": "浩轩.孙",
"roleNames": "7iz6u9",
"roleIds": [
341
]
}
}6.4. 修改用户
Type: POST
Content-Type: application/json; charset=utf-8
Description: 修改用户
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/center/editUser --data '{
"id": 160,
"section": [
{
}
],
"sex": "vo4xfj",
"orgId": 907,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "iqem5l",
"remark": "lbw3qt",
"account": "fj9ume",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 616,
"message": "success",
"data": true
}6.5. 修改用户密码
Type: POST
Content-Type: application/json; charset=utf-8
Description: 修改用户密码
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 用户唯一标识 | false | - |
oldPwd | string | 旧密码 | false | - |
password | string | 新密码 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/center/pwd --data '{
"id": 55,
"oldPwd": "rnzgi5",
"password": "zxfje7"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 531,
"message": "success",
"data": true
}7. 后台用户管理功能
7.1. 查询用户管理列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询用户管理列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/admin/view?orgId=137&email=靖琪.朱@hotmail.com&createTime=2023-06-10¤t=70&avatar=sygn7n&account=j4dkpn&password=9eok71&maxLimit=720&name=浩轩.孙&optimizeCountSql=true&hitCount=true&loginIp=100.147.100.159&countId=197&status=enabled&id=999&phone=17298637952&remark=uj6i02&updateTime=2023-06-10&total=697&loginDate=2023-06-10&isSearchCount=true&pages=760&size=952&searchCount=true&sex=x4ze7rResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 752,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}7.2. 新增用户
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增用户
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
deptName | string | 所属部门 | false | - |
roleNames | string | 角色名称列表 | false | - |
roleIds | array | 角色列表 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/admin/add --data '{
"id": 260,
"section": [
{
}
],
"sex": "mlkxdr",
"orgId": 910,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "ucy6v1",
"remark": "9w7d8k",
"account": "7rqc7s",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deptName": "浩轩.孙",
"roleNames": "is5hc7",
"roleIds": [
657
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 4,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}7.3. 获取用户详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取用户详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/admin/edit?id=363Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─sex | string | 性别 | - |
└─orgId | int64 | 所属部门 | - |
└─name | string | 用户昵称 | - |
string | 邮箱 | - | |
└─phone | string | 手机号 | - |
└─avatar | string | 用户头像 | - |
└─remark | string | 备注 | - |
└─account | string | 用户账号 | - |
└─loginIp | string | 登录ip | - |
└─loginDate | string | 登录时间 | - |
└─status | enum | 用户状态(enabled, disabled) | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─deptName | string | 所属部门 | - |
└─roleNames | string | 角色名称列表 | - |
└─roleIds | array | 角色列表 | - |
Response-example:
{
"code": 973,
"message": "success",
"data": {
"id": 176,
"section": [
{
}
],
"sex": "l3lryl",
"orgId": 264,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "p56am6",
"remark": "yjxj28",
"account": "z9jul5",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deptName": "浩轩.孙",
"roleNames": "v3udhl",
"roleIds": [
848
]
}
}7.4. 修改用户
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改用户
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
deptName | string | 所属部门 | false | - |
roleNames | string | 角色名称列表 | false | - |
roleIds | array | 角色列表 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/admin/edit --data '{
"id": 561,
"section": [
{
}
],
"sex": "bd2kk2",
"orgId": 721,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "sucdih",
"remark": "f1l0aa",
"account": "wmgskk",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deptName": "浩轩.孙",
"roleNames": "gqopl8",
"roleIds": [
914
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 783,
"message": "success",
"data": true
}7.5. 删除用户
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除用户
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/admin/del --data '[
217,
593
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 232,
"message": "success",
"data": true
}7.6. 导入用户
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 导入用户
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
file | file | No comments found. | true | - |
Request-example:
curl -X POST -H 'Content-Type: multipart/form-data' -i http://127.0.0.1/core/admin/importResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 109,
"message": "success",
"data": "uvaqn2"
}7.7. 导出用户
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 导出用户
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─sex | string | 性别 | false | - |
└─orgId | int64 | 所属部门 | false | - |
└─name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
└─phone | string | 手机号 | false | - |
└─avatar | string | 用户头像 | false | - |
└─remark | string | 备注 | false | - |
└─account | string | 用户账号 | false | - |
└─loginIp | string | 登录ip | false | - |
└─loginDate | string | 登录时间 | false | - |
└─status | enum | 用户状态(enabled, disabled) | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─sex | string | 性别 | false | - |
└─orgId | int64 | 所属部门 | false | - |
└─name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
└─phone | string | 手机号 | false | - |
└─avatar | string | 用户头像 | false | - |
└─remark | string | 备注 | false | - |
└─account | string | 用户账号 | false | - |
└─loginIp | string | 登录ip | false | - |
└─loginDate | string | 登录时间 | false | - |
└─status | enum | 用户状态(enabled, disabled) | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/admin/export?hitCount=true&orgId=425&records[0].remark=htgg7m&orders[0].updateTime=2023-06-10&id=853&records[0].email=靖琪.朱@hotmail.com&isSearchCount=true&records[0].account=guob30&updateTime=2023-06-10&orders[0].loginIp=100.147.100.159&orders[0].id=620&createTime=2023-06-10&records[0].name=浩轩.孙&records[0].loginIp=100.147.100.159&orders[0].password=qfhjkn&avatar=bthgyw&orders[0].sex=o7e86x&pages=68&records[0].id=190&records[0].updateTime=2023-06-10&orders[0].status=enabled&password=zwq9xc&size=332&records[0].phone=17298637952&records[0].avatar=ph1c7e&records[0].status=enabled&remark=fj454i&phone=17298637952&records[0].orgId=238&records[0].sex=iyjh4l&orders[0].phone=17298637952&email=靖琪.朱@hotmail.com&orders[0].orgId=875&countId=197&loginDate=2023-06-10&sex=i8ohre&total=991&orders[0].createTime=2023-06-10&account=y7l72n&searchCount=true&orders[0].email=靖琪.朱@hotmail.com&orders[0].account=lygpit&orders[0].avatar=9t4l00&name=浩轩.孙&records[0].loginDate=2023-06-10&records[0].createTime=2023-06-10&orders[0].remark=ggomuv&orders[0].loginDate=2023-06-10&status=enabled&orders[0].name=浩轩.孙&optimizeCountSql=true&maxLimit=181¤t=802&loginIp=100.147.100.159&records[0].password=jxvln6Response-example:
Doesn't return a value.7.8.
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description:
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sex | string | 性别 | false | - |
orgId | int64 | 所属部门 | false | - |
name | string | 用户昵称 | false | - |
string | 邮箱 | false | - | |
phone | string | 手机号 | false | - |
avatar | string | 用户头像 | false | - |
remark | string | 备注 | false | - |
account | string | 用户账号 | false | - |
loginIp | string | 登录ip | false | - |
loginDate | string | 登录时间 | false | - |
status | enum | 用户状态(enabled, disabled) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/admin/modUserInfo --data '{
"id": 20,
"section": [
{
}
],
"sex": "9bi3sw",
"orgId": 280,
"name": "浩轩.孙",
"email": "靖琪.朱@hotmail.com",
"phone": "17298637952",
"avatar": "yscnts",
"remark": "tdfuoq",
"account": "b2kwty",
"loginIp": "100.147.100.159",
"loginDate": "2023-06-10",
"status": "enabled",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 741,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}7.9. 设置用户密码
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 设置用户密码
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 用户唯一标识 | false | - |
oldPwd | string | 旧密码 | false | - |
password | string | 新密码 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/admin/pwd --data '{
"id": 178,
"oldPwd": "iqprkw",
"password": "nxsbgq"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 875,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}8. 系统配置管理
8.1. 查询配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询配置列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | No comments found. | false | - |
label | string | No comments found. | false | - |
value | string | No comments found. | false | - |
remark | string | No comments found. | false | - |
type | enum | null(See: create time: 2019/12/4) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/config/view?updateTime=2023-06-10&isSearchCount=true&name=浩轩.孙&countId=197&maxLimit=83&id=130&total=301¤t=664&type=def&size=186&searchCount=true&optimizeCountSql=true&value=gclg8z&hitCount=true&label=u03jm2&remark=3xfyp0&createTime=2023-06-10&pages=925Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | null(See: create time: 2019/12/4) | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 15,
"message": "success",
"data": {
"size": 124,
"total": 20,
"pages": 716,
"current": 576,
"records": [
{
"id": 928,
"section": [
{
}
],
"name": "浩轩.孙",
"label": "zfdwxf",
"value": "z4v4ua",
"remark": "8q4syf",
"type": "def",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}8.2. 查询配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询配置列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | No comments found. | false | - |
label | string | No comments found. | false | - |
value | string | No comments found. | false | - |
remark | string | No comments found. | false | - |
type | enum | null(See: create time: 2019/12/4) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/config/list?remark=uqcfcs&id=919&type=def&createTime=2023-06-10&name=浩轩.孙&updateTime=2023-06-10&label=x8hfjo&value=nmca1tResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | null(See: create time: 2019/12/4) | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 510,
"message": "success",
"data": [
{
"id": 49,
"section": [
{
}
],
"name": "浩轩.孙",
"label": "ljv95s",
"value": "lq3q50",
"remark": "a4aifs",
"type": "def",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}8.3. 新增配置
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增配置
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | No comments found. | false | - |
label | string | No comments found. | false | - |
value | string | No comments found. | false | - |
remark | string | No comments found. | false | - |
type | enum | null(See: create time: 2019/12/4) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/config/add --data '{
"id": 777,
"section": [
{
}
],
"name": "浩轩.孙",
"label": "iu670r",
"value": "g9n1q4",
"remark": "6wtl47",
"type": "def",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 764,
"message": "success",
"data": true
}8.4. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/config/edit?id=59Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | null(See: create time: 2019/12/4) | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 331,
"message": "success",
"data": {
"id": 779,
"section": [
{
}
],
"name": "浩轩.孙",
"label": "qs899n",
"value": "5clzt6",
"remark": "ez9b7i",
"type": "def",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}8.5. 修改配置
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改配置
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | No comments found. | false | - |
label | string | No comments found. | false | - |
value | string | No comments found. | false | - |
remark | string | No comments found. | false | - |
type | enum | null(See: create time: 2019/12/4) | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/config/edit --data '{
"id": 762,
"section": [
{
}
],
"name": "浩轩.孙",
"label": "x7usf3",
"value": "5va1gm",
"remark": "vcofcj",
"type": "def",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 773,
"message": "success",
"data": true
}8.6. 删除记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/config/del --data '[
988,
561
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 670,
"message": "success",
"data": true
}9. 系统功能统计
9.1. 当天在线人数和在前在线人数
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 当天在线人数和在前在线人数
Request-example:
curl -X GET -i http://127.0.0.1/core/statistics/onlineResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─currentOnline | int64 | 当前在线人数 | - |
└─todayAccess | int64 | 当天访问人数 | - |
Response-example:
{
"code": 250,
"message": "success",
"data": {
"currentOnline": 587,
"todayAccess": 596
}
}9.2. 近一个月在线用户统计
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 近一个月在线用户统计
Request-example:
curl -X GET -i http://127.0.0.1/core/statistics/inRecentMonthResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 936,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}10. 字典数据管理
10.1. 获取字典数据列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取字典数据列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sort | int32 | 排序 | false | - |
label | string | 字典标签 | false | - |
value | string | 字典标签值 | false | - |
type | string | 类型 | false | - |
status | enum | 字典状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
izDefault | boolean | No comments found. | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictData/view?value=gpo5hz&label=7tkaaa&type=ie1ux8&sort=772&status=enabled&createTime=2023-06-10&id=997&remark=khvv3j&izDefault=true&updateTime=2023-06-10Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 513,
"message": "success",
"data": [
{
"id": 705,
"section": [
{
}
],
"sort": 138,
"label": "wnwqaf",
"value": "jr3875",
"type": "nj8yqx",
"status": "enabled",
"remark": "hqfcxn",
"izDefault": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}10.2. 获取指定类型的字典数据
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取指定类型的字典数据
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
type | string | 字典类型 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictData/listByType?type=o38expResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 845,
"message": "success",
"data": [
{
"id": 407,
"section": [
{
}
],
"sort": 960,
"label": "j3icxr",
"value": "9xo01w",
"type": "xqy1yy",
"status": "enabled",
"remark": "n43ham",
"izDefault": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}10.3. 新增一条字典数据记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增一条字典数据记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sort | int32 | 排序 | false | - |
label | string | 字典标签 | false | - |
value | string | 字典标签值 | false | - |
type | string | 类型 | false | - |
status | enum | 字典状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
izDefault | boolean | No comments found. | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictData/add --data '{
"id": 270,
"section": [
{
}
],
"sort": 230,
"label": "gqr4xq",
"value": "9rg6gs",
"type": "bn7ycr",
"status": "enabled",
"remark": "aye2kw",
"izDefault": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 22,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}10.4. 删除字典数据
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除字典数据
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictData/del --data '[
746,
520
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 107,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}10.5. 获取字典数据详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取字典数据详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictData/edit?id=999Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 946,
"message": "success",
"data": {
"id": 703,
"section": [
{
}
],
"sort": 332,
"label": "i0thf7",
"value": "8tz89s",
"type": "ngmkdy",
"status": "enabled",
"remark": "zvgsw6",
"izDefault": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}10.6. 修改字典数据记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改字典数据记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
sort | int32 | 排序 | false | - |
label | string | 字典标签 | false | - |
value | string | 字典标签值 | false | - |
type | string | 类型 | false | - |
status | enum | 字典状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
izDefault | boolean | No comments found. | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictData/edit --data '{
"id": 870,
"section": [
{
}
],
"sort": 531,
"label": "huc3vv",
"value": "v50onw",
"type": "ye0tm5",
"status": "enabled",
"remark": "rqiik1",
"izDefault": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 701,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}11. 字典类型管理
11.1. 查询字典列表(分页)
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询字典列表(分页)
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 类型名称 | false | - |
type | string | 字典类型 | false | - |
status | enum | 类型状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictType/view?remark=5fxkm0&updateTime=2023-06-10&searchCount=true&isSearchCount=true&countId=197&maxLimit=504&type=3okkcm&createTime=2023-06-10&optimizeCountSql=true¤t=389&size=797&status=enabled&total=289&name=浩轩.孙&hitCount=true&pages=331&id=388Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 类型名称 | - |
└─type | string | 字典类型 | - |
└─status | enum | 类型状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
└─orders | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 类型名称 | - |
└─type | string | 字典类型 | - |
└─status | enum | 类型状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─optimizeCountSql | boolean | No comments found. | - |
└─isSearchCount | boolean | No comments found. | - |
└─countId | string | No comments found. | - |
└─maxLimit | int64 | No comments found. | - |
Response-example:
{
"code": 345,
"message": "success",
"data": {
"size": 430,
"total": 416,
"pages": 151,
"current": 561,
"records": [
{
"id": 744,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "ae8unr",
"status": "enabled",
"remark": "wu7dt4",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true,
"orders": [
{
"id": 797,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "76mxz9",
"status": "enabled",
"remark": "bb5qyl",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"optimizeCountSql": true,
"isSearchCount": true,
"countId": "197",
"maxLimit": 219
}
}11.2. 获取所有字典类型记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取所有字典类型记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 类型名称 | false | - |
type | string | 字典类型 | false | - |
status | enum | 类型状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictType/list?type=1v2v07&status=enabled&createTime=2023-06-10&updateTime=2023-06-10&name=浩轩.孙&id=609&remark=xl27mlResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 类型名称 | - |
└─type | string | 字典类型 | - |
└─status | enum | 类型状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 925,
"message": "success",
"data": [
{
"id": 612,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "chhaib",
"status": "enabled",
"remark": "qpryez",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}11.3. 新增字典记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增字典记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 类型名称 | false | - |
type | string | 字典类型 | false | - |
status | enum | 类型状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictType/add --data '{
"id": 161,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "1vduxz",
"status": "enabled",
"remark": "pqlu6w",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 99,
"message": "success",
"data": true
}11.4. 获取字典记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取字典记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/dictType/edit?id=302Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 类型名称 | - |
└─type | string | 字典类型 | - |
└─status | enum | 类型状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 592,
"message": "success",
"data": {
"id": 800,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "hv6sbd",
"status": "enabled",
"remark": "kb42qz",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}11.5. 修改字典记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改字典记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 类型名称 | false | - |
type | string | 字典类型 | false | - |
status | enum | 类型状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictType/edit --data '{
"id": 619,
"section": [
{
}
],
"name": "浩轩.孙",
"type": "qodt57",
"status": "enabled",
"remark": "ktd4lj",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 626,
"message": "success",
"data": true
}11.6. 删除字典
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除字典
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/dictType/del --data '[
598,
183
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 68,
"message": "success",
"data": true
}12. 用户管理中心接口
12.1. 系统登录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 系统登录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
host | string | No comments found. | false | - |
credentials | object | No comments found. | false | - |
principal | object | No comments found. | false | - |
rememberMe | boolean | No comments found. | false | - |
username | string | No comments found. | false | - |
password | array | No comments found. | false | - |
captcha | string | 验证码 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/login --data '{
"host": "y6dd0c",
"credentials": {
"waring": "You may have used non-display generics."
},
"principal": {
"waring": "You may have used non-display generics."
},
"rememberMe": true,
"username": "浩轩.孙",
"password": [
j
],
"captcha": "3a4tq8"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 757,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}12.2. 系统注销
Type: POST
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 系统注销
Request-example:
curl -X POST -i http://127.0.0.1/core/logoutResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 751,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}13. 系统菜单管理
13.1. 获取菜单列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取菜单列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
collect | boolean | 是否采集日志 | false | - |
desc | string | 日志说明 | false | - |
icon | string | 图标 | false | - |
type | enum | 菜单类型 | false | - |
url | string | 菜单地址 | false | - |
name | string | 菜单名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 是否显示(See: jdk：1.8) | false | - |
perms | string | 权限列表 | false | - |
remark | string | 备注 | false | - |
log | boolean | 是否记录日志 | false | - |
logDesc | string | 日志信息 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/menu/view?type=A&remark=91csh4&desc=47luxv&icon=cgspba&name=浩轩.孙&id=349&sort=820&url=www.xn---xn--yrv-wb8rme.org&status=enabled&createTime=2023-06-10&perms=d3crk6&log=true&pid=410&logDesc=zqnqpw&updateTime=2023-06-10&collect=trueResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 126,
"message": "success",
"data": [
{
"id": 377,
"section": [
{
}
],
"pid": 775,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "yu53ot",
"icon": "f80nkn",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 807,
"status": "enabled",
"perms": "5f0idi",
"remark": "03jk04",
"log": true,
"logDesc": "cnbxua",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}13.2.
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Request-example:
curl -X GET -i http://127.0.0.1/core/menu/barsResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 960,
"message": "success",
"data": [
{
"id": 908,
"section": [
{
}
],
"pid": 680,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "jxixxx",
"icon": "70g20e",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 398,
"status": "enabled",
"perms": "calt34",
"remark": "7em3bn",
"log": true,
"logDesc": "oqgqv6",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}13.3. 获取类型是目录和视图的菜单列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取类型是目录和视图的菜单列表
Request-example:
curl -X GET -i http://127.0.0.1/core/menu/parentResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 232,
"message": "success",
"data": [
{
"id": 440,
"section": [
{
}
],
"pid": 521,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "95yx0w",
"icon": "ml5u69",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 517,
"status": "enabled",
"perms": "23b7tv",
"remark": "rqlki1",
"log": true,
"logDesc": "xk8wls",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}13.4. 新增菜单
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增菜单
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
collect | boolean | 是否采集日志 | false | - |
desc | string | 日志说明 | false | - |
icon | string | 图标 | false | - |
type | enum | 菜单类型 | false | - |
url | string | 菜单地址 | false | - |
name | string | 菜单名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 是否显示(See: jdk：1.8) | false | - |
perms | string | 权限列表 | false | - |
remark | string | 备注 | false | - |
log | boolean | 是否记录日志 | false | - |
logDesc | string | 日志信息 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/menu/add --data '{
"id": 984,
"section": [
{
}
],
"pid": 609,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "x4vl5q",
"icon": "tb7s35",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 874,
"status": "enabled",
"perms": "ctmbg5",
"remark": "2tpptc",
"log": true,
"logDesc": "czzl2n",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 673,
"message": "success",
"data": true
}13.5. 删除菜单
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除菜单
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/menu/del --data '[
705,
844
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 333,
"message": "success",
"data": true
}13.6. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/menu/edit?id=559Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 542,
"message": "success",
"data": {
"id": 656,
"section": [
{
}
],
"pid": 891,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "cvei39",
"icon": "eciybf",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 614,
"status": "enabled",
"perms": "6nzlfi",
"remark": "wlq85z",
"log": true,
"logDesc": "ta2i9s",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}13.7. 编辑菜单
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 编辑菜单
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
collect | boolean | 是否采集日志 | false | - |
desc | string | 日志说明 | false | - |
icon | string | 图标 | false | - |
type | enum | 菜单类型 | false | - |
url | string | 菜单地址 | false | - |
name | string | 菜单名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 是否显示(See: jdk：1.8) | false | - |
perms | string | 权限列表 | false | - |
remark | string | 备注 | false | - |
log | boolean | 是否记录日志 | false | - |
logDesc | string | 日志信息 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/menu/edit --data '{
"id": 573,
"section": [
{
}
],
"pid": 608,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "z8561t",
"icon": "d7fcu7",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 341,
"status": "enabled",
"perms": "bxais1",
"remark": "fon8fn",
"log": true,
"logDesc": "8mq4bb",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 504,
"message": "success",
"data": true
}14. 在线用户管理
14.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─account | string | No comments found. | false | - |
└─action | string | No comments found. | false | - |
└─sessionId | string | 会话编号 | false | - |
└─timeout | int64 | No comments found. | false | - |
└─startTimestamp | string | No comments found. | false | - |
└─lastAccessTime | string | No comments found. | false | - |
└─browse | string | 登录时使用的浏览器 | false | - |
└─expireTime | int64 | 超时时长, 从访问到离开的时间， 单位分钟 | false | - |
└─location | string | 访问的本地位置 | false | - |
└─accessIp | string | 访问ip | false | - |
└─loginTime | string | 登录时间 | false | - |
└─os | string | 使用的操作系统 | false | - |
└─type | enum | 应用类型 | false | - |
└─status | enum | 用户状态(Online. 在线, Offline. 离线)(See: create time: 2020/6/20) | false | - |
└─userNick | string | 用户昵称 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─account | string | No comments found. | false | - |
└─action | string | No comments found. | false | - |
└─sessionId | string | 会话编号 | false | - |
└─timeout | int64 | No comments found. | false | - |
└─startTimestamp | string | No comments found. | false | - |
└─lastAccessTime | string | No comments found. | false | - |
└─browse | string | 登录时使用的浏览器 | false | - |
└─expireTime | int64 | 超时时长, 从访问到离开的时间， 单位分钟 | false | - |
└─location | string | 访问的本地位置 | false | - |
└─accessIp | string | 访问ip | false | - |
└─loginTime | string | 登录时间 | false | - |
└─os | string | 使用的操作系统 | false | - |
└─type | enum | 应用类型 | false | - |
└─status | enum | 用户状态(Online. 在线, Offline. 离线)(See: create time: 2020/6/20) | false | - |
└─userNick | string | 用户昵称 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
account | string | No comments found. | false | - |
action | string | No comments found. | false | - |
sessionId | string | 会话编号 | false | - |
timeout | int64 | No comments found. | false | - |
startTimestamp | string | No comments found. | false | - |
lastAccessTime | string | No comments found. | false | - |
browse | string | 登录时使用的浏览器 | false | - |
expireTime | int64 | 超时时长, 从访问到离开的时间， 单位分钟 | false | - |
location | string | 访问的本地位置 | false | - |
accessIp | string | 访问ip | false | - |
loginTime | string | 登录时间 | false | - |
os | string | 使用的操作系统 | false | - |
type | enum | 应用类型 | false | - |
status | enum | 用户状态(Online. 在线, Offline. 离线)(See: create time: 2020/6/20) | false | - |
userNick | string | 用户昵称 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/online/view?loginTime=2023-06-10&records[0].browse=cckyn4&pages=265&records[0].accessIp=100.147.100.159&browse=qfpm7l&records[0].createTime=2023-06-10&records[0].updateTime=2023-06-10&orders[0].os=6kff1q&timeout=363&orders[0].account=afw4tl&orders[0].type=COMPUTER&records[0].loginTime=2023-06-10&records[0].sessionId=197&records[0].expireTime=1686398650479&records[0].id=308&records[0].userNick=e3433a&updateTime=2023-06-10&id=610&expireTime=1686398650479&orders[0].createTime=2023-06-10&records[0].location=ili3lh&size=654&accessIp=100.147.100.159&orders[0].browse=kal3ql&optimizeCountSql=true&userNick=nsi9in&records[0].timeout=804&orders[0].startTimestamp=2023-06-10&records[0].os=ynk1pm&total=393&createTime=2023-06-10&orders[0].location=ugmpnf&lastAccessTime=2023-06-10&records[0].status=Online&isSearchCount=true&maxLimit=458&records[0].type=COMPUTER&countId=197&sessionId=197&orders[0].expireTime=1686398650479&startTimestamp=2023-06-10¤t=187&records[0].startTimestamp=2023-06-10&orders[0].updateTime=2023-06-10&hitCount=true&action=klzdx5&orders[0].sessionId=197&status=Online&location=hvsser&orders[0].action=aax9ta&orders[0].timeout=526&orders[0].loginTime=2023-06-10&records[0].action=zcvwcy&orders[0].status=Online&records[0].account=xxukr8&searchCount=true&orders[0].lastAccessTime=2023-06-10&orders[0].accessIp=100.147.100.159&account=ebwsn8&os=z2vjeo&type=COMPUTER&orders[0].userNick=74ek9s&records[0].lastAccessTime=2023-06-10&orders[0].id=169Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─account | string | No comments found. | - |
└─action | string | No comments found. | - |
└─sessionId | string | 会话编号 | - |
└─timeout | int64 | No comments found. | - |
└─startTimestamp | string | No comments found. | - |
└─lastAccessTime | string | No comments found. | - |
└─browse | string | 登录时使用的浏览器 | - |
└─expireTime | int64 | 超时时长, 从访问到离开的时间， 单位分钟 | - |
└─location | string | 访问的本地位置 | - |
└─accessIp | string | 访问ip | - |
└─loginTime | string | 登录时间 | - |
└─os | string | 使用的操作系统 | - |
└─type | enum | 应用类型 | - |
└─status | enum | 用户状态(Online. 在线, Offline. 离线)(See: create time: 2020/6/20) | - |
└─userNick | string | 用户昵称 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 958,
"message": "success",
"data": {
"size": 679,
"total": 33,
"pages": 258,
"current": 420,
"records": [
{
"id": 572,
"section": [
{
}
],
"account": "fghngk",
"action": "7v9nge",
"sessionId": "197",
"timeout": 480,
"startTimestamp": "2023-06-10",
"lastAccessTime": "2023-06-10",
"browse": "t3ys3r",
"expireTime": 1686398650479,
"location": "wj0vq0",
"accessIp": "100.147.100.159",
"loginTime": "2023-06-10",
"os": "1jlqsh",
"type": "COMPUTER",
"status": "Online",
"userNick": "hl2lta",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}14.2. 删除在线记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除在线记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/online/del --data '[
898,
815
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 606,
"message": "success",
"data": true
}14.3. 剔除用户下线
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 剔除用户下线
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
account | string | No comments found. | false | - |
action | string | No comments found. | false | - |
sessionId | string | 会话编号 | false | - |
timeout | int64 | No comments found. | false | - |
startTimestamp | string | No comments found. | false | - |
lastAccessTime | string | No comments found. | false | - |
browse | string | 登录时使用的浏览器 | false | - |
expireTime | int64 | 超时时长, 从访问到离开的时间， 单位分钟 | false | - |
location | string | 访问的本地位置 | false | - |
accessIp | string | 访问ip | false | - |
loginTime | string | 登录时间 | false | - |
os | string | 使用的操作系统 | false | - |
type | enum | 应用类型 | false | - |
status | enum | 用户状态(Online. 在线, Offline. 离线)(See: create time: 2020/6/20) | false | - |
userNick | string | 用户昵称 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/online/offline --data '{
"id": 208,
"section": [
{
}
],
"account": "a299mn",
"action": "6x0ib2",
"sessionId": "197",
"timeout": 178,
"startTimestamp": "2023-06-10",
"lastAccessTime": "2023-06-10",
"browse": "esofo1",
"expireTime": 1686398650479,
"location": "87r8en",
"accessIp": "100.147.100.159",
"loginTime": "2023-06-10",
"os": "785w72",
"type": "COMPUTER",
"status": "Online",
"userNick": "dqmi23",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 705,
"message": "success",
"data": true
}15. 日志管理功能
15.1. 获取日志记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取日志记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 请求ip | false | - |
url | string | 请求地址 | false | - |
msn | string | 所属模块 | false | - |
type | string | 功能类型 | false | - |
userId | int64 | 访问用户 | false | - |
millis | int64 | 使用时间 | false | - |
userName | string | 用户名 | false | - |
status | boolean | 状态 | false | - |
errMsg | string | 错误消息 | false | - |
title | string | 功能 | false | - |
createTime | string | 执行时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/log/view?optimizeCountSql=true&errMsg=aonobs&maxLimit=45&ip=100.147.100.159&status=true&type=6yg1gk&millis=499&hitCount=true&title=o7yqbv&userName=浩轩.孙&searchCount=true&createTime=2023-06-10&isSearchCount=true&countId=197¤t=673&total=431&userId=411&url=www.xn---xn--yrv-wb8rme.org&size=625&pages=761&id=847&msn=xk91z8Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 661,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}15.2. 删除日志记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除日志记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/log/del --data '[
476,
598
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 798,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}16. 组织部门管理
16.1. 获取部门列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取部门列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
name | string | 部门名称 | false | - |
sort | int32 | 排序 | false | - |
phone | string | 部门负责人电话 | false | - |
leader | string | 部门负责人 | false | - |
level | int32 | 部门等级 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/org/view?updateTime=2023-06-10&sort=697&name=浩轩.孙&leader=pg7fbf&level=927&pid=354&id=458&createTime=2023-06-10&phone=17298637952Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 185,
"message": "success",
"data": [
{
"id": 999,
"section": [
{
}
],
"pid": 315,
"children": [
{
"object": "any object"
}
],
"name": "浩轩.孙",
"sort": 500,
"phone": "17298637952",
"leader": "exis54",
"path": "xtri32",
"level": 175,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}16.2.
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Request-example:
curl -X GET -i http://127.0.0.1/core/org/parentResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 882,
"message": "success",
"data": [
{
"id": 599,
"section": [
{
}
],
"pid": 655,
"children": [
{
"object": "any object"
}
],
"name": "浩轩.孙",
"sort": 739,
"phone": "17298637952",
"leader": "d3rw4r",
"path": "wew6s4",
"level": 747,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}16.3. 新增部门
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增部门
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
name | string | 部门名称 | false | - |
sort | int32 | 排序 | false | - |
phone | string | 部门负责人电话 | false | - |
leader | string | 部门负责人 | false | - |
level | int32 | 部门等级 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/org/add --data '{
"id": 240,
"section": [
{
}
],
"pid": 140,
"children": [
{
"object": "any object"
}
],
"name": "浩轩.孙",
"sort": 838,
"phone": "17298637952",
"leader": "ndp454",
"level": 864,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 317,
"message": "success",
"data": true
}16.4. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int32 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/org/edit?id=648Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 462,
"message": "success",
"data": {
"id": 131,
"section": [
{
}
],
"pid": 194,
"children": [
{
"object": "any object"
}
],
"name": "浩轩.孙",
"sort": 281,
"phone": "17298637952",
"leader": "pdgpmn",
"path": "6guumb",
"level": 932,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}16.5. 修改部门
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改部门
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
name | string | 部门名称 | false | - |
sort | int32 | 排序 | false | - |
phone | string | 部门负责人电话 | false | - |
leader | string | 部门负责人 | false | - |
level | int32 | 部门等级 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/org/edit --data '{
"id": 376,
"section": [
{
}
],
"pid": 998,
"children": [
{
"object": "any object"
}
],
"name": "浩轩.孙",
"sort": 95,
"phone": "17298637952",
"leader": "hp9d24",
"level": 983,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 658,
"message": "success",
"data": true
}16.6. 删除部门
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除部门
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/org/del --data '[
631,
689
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 902,
"message": "success",
"data": true
}17. 区域管理
17.1. 获取区域列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取区域列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
code | string | 行政区码 | false | - |
name | string | 行政区域名称 | false | - |
firstLetter | string | 首字母 | false | - |
pid | int64 | 父级id | false | - |
level | int32 | 等级(第一级为0) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/region/view?pid=719&level=500&id=373&name=浩轩.孙&firstLetter=3fcvum&code=63387Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─code | string | 行政区码 | - |
└─name | string | 行政区域名称 | - |
└─firstLetter | string | 首字母 | - |
└─pid | int64 | 父级id | - |
└─level | int32 | 等级(第一级为0) | - |
Response-example:
{
"code": 647,
"message": "success",
"data": [
{
"id": 639,
"section": [
{
}
],
"code": "63387",
"name": "浩轩.孙",
"firstLetter": "8rt918",
"pid": 915,
"level": 233
}
]
}17.2. 获取指定记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取指定记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/region/getById?id=671Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─code | string | 行政区码 | - |
└─name | string | 行政区域名称 | - |
└─firstLetter | string | 首字母 | - |
└─pid | int64 | 父级id | - |
└─level | int32 | 等级(第一级为0) | - |
Response-example:
{
"code": 740,
"message": "success",
"data": {
"id": 400,
"section": [
{
}
],
"code": "63387",
"name": "浩轩.孙",
"firstLetter": "ferqwh",
"pid": 579,
"level": 175
}
}18. 角色管理
18.1. 角色列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 角色列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 角色名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/role/view?countId=197&updateTime=2023-06-10&hitCount=true&total=201&searchCount=true&id=925&isSearchCount=true&size=559&sort=978&optimizeCountSql=true&name=浩轩.孙&remark=hlhva0&createTime=2023-06-10¤t=466&maxLimit=14&status=enabled&pages=117Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 73,
"message": "success",
"data": {
"size": 2,
"total": 142,
"pages": 285,
"current": 931,
"records": [
{
"id": 200,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 145,
"status": "enabled",
"remark": "n9yivl",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}18.2. 获取所有角色列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取所有角色列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 角色名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/role/list?sort=193&updateTime=2023-06-10&id=135&remark=q9k2ih&name=浩轩.孙&status=enabled&createTime=2023-06-10Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 834,
"message": "success",
"data": [
{
"id": 554,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 178,
"status": "enabled",
"remark": "b6sczf",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}18.3. 所有功能菜单
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 所有功能菜单
Request-example:
curl -X GET -i http://127.0.0.1/core/role/allMenusResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─collect | boolean | 是否采集日志 | - |
└─desc | string | 日志说明 | - |
└─icon | string | 图标 | - |
└─type | enum | 菜单类型 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 是否显示(See: jdk：1.8) | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─log | boolean | 是否记录日志 | - |
└─logDesc | string | 日志信息 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 697,
"message": "success",
"data": [
{
"id": 346,
"section": [
{
}
],
"pid": 357,
"children": [
{
"object": "any object"
}
],
"collect": true,
"desc": "pxcpxk",
"icon": "7m6suo",
"type": "A",
"url": "www.xn---xn--yrv-wb8rme.org",
"name": "浩轩.孙",
"sort": 378,
"status": "enabled",
"perms": "5e8c4f",
"remark": "pinut6",
"log": true,
"logDesc": "gk3pdy",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
]
}18.4. 新增角色记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增角色记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 角色名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
menuIds | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/role/add --data '{
"id": 356,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 589,
"status": "enabled",
"remark": "zytr4n",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"menuIds": [
922
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 748,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}18.5. 获取详情记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取详情记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/role/edit?id=231Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态(See: jdk：1.8) | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 237,
"message": "success",
"data": {
"id": 424,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 254,
"status": "enabled",
"remark": "gkujhl",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}18.6. 保存编辑记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 保存编辑记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 角色名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/role/edit --data '{
"id": 536,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 19,
"status": "enabled",
"remark": "twhb5h",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 37,
"message": "success",
"data": true
}18.7. 返回此角色拥有的权限列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 返回此角色拥有的权限列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/core/role/func?id=404Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─menuIds | array | No comments found. | - |
Response-example:
{
"code": 588,
"message": "success",
"data": {
"id": 36,
"menuIds": [
235
]
}
}18.8. 修改角色权限
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改角色权限
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 角色名称 | false | - |
sort | int32 | 排序 | false | - |
status | enum | 状态(See: jdk：1.8) | false | - |
remark | string | 备注 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
menuIds | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/role/perm --data '{
"id": 227,
"section": [
{
}
],
"name": "浩轩.孙",
"sort": 868,
"status": "enabled",
"remark": "009ttk",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"menuIds": [
602
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 283,
"message": "success",
"data": true
}18.9. 删除记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
list | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/core/role/del --data '[
772,
233
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 932,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}19. 通用的文件上传
19.1. 文件上传todo url
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 文件上传 todo url
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
file | file | No comments found. | true | - |
subPath | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: multipart/form-data' -i http://127.0.0.1/common/upload/ --data 'subPath=63gufi'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 957,
"message": "success",
"data": "zhbntn"
}19.2. 文件批量上传
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 文件批量上传
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
file | file | No comments found.(array of file) | true | - |
subPath | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: multipart/form-data' -i http://127.0.0.1/common/upload/batch --data 'subPath=bv7kfj'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
Response-example:
{
"code": 275,
"message": "success",
"data": [
"f8nffh",
"3y19na"
]
}19.3. 上传用户头像
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 上传用户头像
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
avatar | file | No comments found. | true | - |
Request-example:
curl -X POST -H 'Content-Type: multipart/form-data' -i http://127.0.0.1/common/upload/avatarResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 759,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}20. 采集数据管理
20.1. 获取采集数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取采集数据
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
cid | int64 | 任务执行标识 | false | - |
uid | int64 | 设备uid | false | - |
signalId | int64 | 信号id | false | - |
fieldType | int32 | 值类型 | false | - |
collectTaskId | int64 | 采集任务标识 | false | - |
address | string | 采集地址 | false | - |
value | string | 采集值 | false | - |
status | boolean | 采集状态 | false | - |
reason | string | 采集状态说明 | false | - |
collectTime | string | 采集时间 | false | - |
createTime | string | 创建时间 | false | - |
deviceTypeId | int64 | 设备类型 | false | - |
modelId | int64 | 设备型号 | false | - |
deviceSn | string | 设备编号 | false | - |
deviceName | string | 设备名称 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectData/view?collectTaskId=252&fieldType=409&deviceTypeId=302&signalId=838&value=8qdd1p&maxLimit=607&deviceSn=lv6tkm&reason=p3y7a2&cid=70&countId=197&optimizeCountSql=true&deviceName=浩轩.孙&id=725&size=338&address=高街4888号， 咸阳， 陕 053436&collectTime=2023-06-10¤t=83&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&createTime=2023-06-10&searchCount=true&status=true&modelId=709&pages=104&isSearchCount=true&total=304&hitCount=trueResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─cid | int64 | 任务执行标识 | - |
└─uid | int64 | 设备uid | - |
└─signalId | int64 | 信号id | - |
└─fieldType | int32 | 值类型 | - |
└─collectTaskId | int64 | 采集任务标识 | - |
└─address | string | 采集地址 | - |
└─value | string | 采集值 | - |
└─status | boolean | 采集状态 | - |
└─reason | string | 采集状态说明 | - |
└─collectTime | string | 采集时间 | - |
└─createTime | string | 创建时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 设备型号 | - |
└─deviceSn | string | 设备编号 | - |
└─deviceName | string | 设备名称 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
└─orders | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─cid | int64 | 任务执行标识 | - |
└─uid | int64 | 设备uid | - |
└─signalId | int64 | 信号id | - |
└─fieldType | int32 | 值类型 | - |
└─collectTaskId | int64 | 采集任务标识 | - |
└─address | string | 采集地址 | - |
└─value | string | 采集值 | - |
└─status | boolean | 采集状态 | - |
└─reason | string | 采集状态说明 | - |
└─collectTime | string | 采集时间 | - |
└─createTime | string | 创建时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 设备型号 | - |
└─deviceSn | string | 设备编号 | - |
└─deviceName | string | 设备名称 | - |
└─optimizeCountSql | boolean | No comments found. | - |
└─isSearchCount | boolean | No comments found. | - |
└─countId | string | No comments found. | - |
└─maxLimit | int64 | No comments found. | - |
Response-example:
{
"code": 762,
"message": "success",
"data": {
"size": 726,
"total": 667,
"pages": 122,
"current": 368,
"records": [
{
"id": 21,
"section": [
{
}
],
"cid": 343,
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"signalId": 137,
"fieldType": 667,
"collectTaskId": 288,
"address": "高街4888号， 咸阳， 陕 053436",
"value": "a1g7oh",
"status": true,
"reason": "dj4ger",
"collectTime": "2023-06-10",
"createTime": "2023-06-10",
"deviceTypeId": 805,
"modelId": 950,
"deviceSn": "31ln38",
"deviceName": "浩轩.孙"
}
],
"searchCount": true,
"hitCount": true,
"orders": [
{
"id": 615,
"section": [
{
}
],
"cid": 185,
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"signalId": 585,
"fieldType": 339,
"collectTaskId": 55,
"address": "高街4888号， 咸阳， 陕 053436",
"value": "toik4s",
"status": true,
"reason": "t40z7f",
"collectTime": "2023-06-10",
"createTime": "2023-06-10",
"deviceTypeId": 339,
"modelId": 185,
"deviceSn": "kijivt",
"deviceName": "浩轩.孙"
}
],
"optimizeCountSql": true,
"isSearchCount": true,
"countId": "197",
"maxLimit": 764
}
}20.2. 新增或者更新记录
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 新增或者更新记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectData/edit?id=759Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─cid | int64 | 任务执行标识 | - |
└─uid | int64 | 设备uid | - |
└─signalId | int64 | 信号id | - |
└─fieldType | int32 | 值类型 | - |
└─collectTaskId | int64 | 采集任务标识 | - |
└─address | string | 采集地址 | - |
└─value | string | 采集值 | - |
└─status | boolean | 采集状态 | - |
└─reason | string | 采集状态说明 | - |
└─collectTime | string | 采集时间 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"code": 19,
"message": "success",
"data": {
"id": 388,
"section": [
{
}
],
"cid": 976,
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"signalId": 738,
"fieldType": 6,
"collectTaskId": 671,
"address": "高街4888号， 咸阳， 陕 053436",
"value": "iwqaex",
"status": true,
"reason": "v7nm0d",
"collectTime": "2023-06-10",
"createTime": "2023-06-10"
}
}20.3. 删除指定记录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectData/del --data '[
162,
660
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 658,
"message": "success",
"data": true
}21. 采集详情管理
21.1. 获取采集详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取采集详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
uid | int64 | 设备uid | false | - |
extend | string | 扩展字段 | false | - |
storeUid | int64 | 存储设备uid | false | - |
collectAction | string | 采集动作 | false | - |
storeAction | string | 存储动作 | false | - |
childSn | string | 子设备 | false | - |
collectTaskId | int64 | 采集任务id | false | - |
pointGroupId | int64 | 点位组 | false | - |
createTime | string | 创建时间 | false | - |
childName | string | 子设备名称 | false | - |
pointGroupName | string | 点位组名称 | false | - |
collectTaskName | string | 任务名称 | false | - |
deviceTypeId | int64 | 设备类型 | false | - |
modelId | int64 | 型号 | false | - |
deviceName | string | 设备名称 | false | - |
deviceSn | string | 设备编号 | false | - |
device | object | 采集设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
store | object | 存储设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
signals | array | 组点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectDetail/details?storeUid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&collectTaskName=浩轩.孙&store.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&modelId=252&device.id=915&maxLimit=310&store.id=202&device.userId=398&store.status=online&signals[0].num=113&device.deviceTypeId=687&store.extend=3lezzw&signals[0].message=success&pages=229&device.alias=PLC&signals[0].address=高街4888号， 咸阳， 陕 053436&device.updateTime=2023-06-10&store.address=高街4888号， 咸阳， 陕 053436&device.name=浩轩.孙&signals[0].encode=63387&total=792&id=13&signals[0].typeId=431&collectTaskId=934&store.modelName=浩轩.孙&device.extend=u4nazk&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&store.deviceSn=1o1onz&storeAction=uible3&countId=197&deviceName=浩轩.孙&store.port=189&store.ip=100.147.100.159&extend=00lmx0¤t=686&store.updateTime=2023-06-10&device.modelName=浩轩.孙&store.password=9uuy16&store.deviceTypeId=700&device.port=654&store.createTime=2023-06-10&isSearchCount=true&store.name=浩轩.孙&signals[0].id=505&pointGroupName=浩轩.孙&hitCount=true&searchCount=true&device.status=online&optimizeCountSql=true&store.deviceTypeName=浩轩.孙&collectAction=xsplhd&signals[0].name=浩轩.孙&device.lon=fydm1r&device.deviceSn=17yd8l&store.lon=0pkkph&signals[0].type=78&device.createTime=2023-06-10&store.model=331&signals[0].fieldName=浩轩.孙&device.model=687&device.address=高街4888号， 咸阳， 陕 053436&store.switchTime=2023-06-10&device.lat=uu8kzi&childName=浩轩.孙&deviceSn=n3umqr&device.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&createTime=2023-06-10&device.ip=100.147.100.159&signals[0].modelId=184&store.alias=PLC&store.userId=783&device.password=99okm7&size=494&signals[0].fieldType=921&device.switchTime=2023-06-10&deviceTypeId=469&pointGroupId=747&childSn=mk6ppk&signals[0].createTime=2023-06-10&device.account=pk4fts&store.lat=gcbuep&device.deviceTypeName=浩轩.孙&store.account=0u407uResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─uid | int64 | 设备uid | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─collectAction | string | 采集动作 | - |
└─storeAction | string | 存储动作 | - |
└─childSn | string | 子设备 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─childName | string | 子设备名称 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 型号 | - |
└─deviceName | string | 设备名称 | - |
└─deviceSn | string | 设备编号 | - |
└─device | object | 采集设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─store | object | 存储设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─signals | array | 组点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
└─orders | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─uid | int64 | 设备uid | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─collectAction | string | 采集动作 | - |
└─storeAction | string | 存储动作 | - |
└─childSn | string | 子设备 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─childName | string | 子设备名称 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 型号 | - |
└─deviceName | string | 设备名称 | - |
└─deviceSn | string | 设备编号 | - |
└─device | object | 采集设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─store | object | 存储设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─signals | array | 组点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
└─optimizeCountSql | boolean | No comments found. | - |
└─isSearchCount | boolean | No comments found. | - |
└─countId | string | No comments found. | - |
└─maxLimit | int64 | No comments found. | - |
Response-example:
{
"code": 282,
"message": "success",
"data": {
"size": 541,
"total": 822,
"pages": 302,
"current": 22,
"records": [
{
"id": 687,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "qqy05e",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "5j5ett",
"storeAction": "8sg3k9",
"childSn": "h79jot",
"collectTaskId": 441,
"pointGroupId": 209,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 492,
"modelId": 684,
"deviceName": "浩轩.孙",
"deviceSn": "xn7cej",
"device": {
"id": 652,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 967,
"userId": 415,
"extend": "k674zo",
"model": 442,
"lon": "d4ckaq",
"lat": "hwj2fc",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "ulgafg",
"password": "gpq7av",
"status": "online",
"deviceSn": "7qq2ku",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 90,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 688,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 404,
"userId": 349,
"extend": "nd2gyd",
"model": 52,
"lon": "zf8p44",
"lat": "a77jfm",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "oe0z63",
"password": "jdt5f9",
"status": "online",
"deviceSn": "bmy3nx",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 112,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 218,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 534,
"type": 126,
"num": 725,
"message": "success",
"encode": "63387",
"modelId": 611,
"fieldName": "浩轩.孙",
"fieldType": 898,
"createTime": "2023-06-10"
}
]
}
],
"searchCount": true,
"hitCount": true,
"orders": [
{
"id": 485,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "svwzu2",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "1eqdxg",
"storeAction": "ankv60",
"childSn": "3s5pmb",
"collectTaskId": 977,
"pointGroupId": 869,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 556,
"modelId": 195,
"deviceName": "浩轩.孙",
"deviceSn": "zhqlyh",
"device": {
"id": 797,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 158,
"userId": 897,
"extend": "hcmql0",
"model": 372,
"lon": "41yici",
"lat": "edwyiu",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "76mm7n",
"password": "69dct6",
"status": "online",
"deviceSn": "18li47",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 923,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 809,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 569,
"userId": 714,
"extend": "sylrmu",
"model": 44,
"lon": "sezo1u",
"lat": "8wjfd5",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "k06oed",
"password": "prkdvl",
"status": "online",
"deviceSn": "fdq1r2",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 280,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 33,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 874,
"type": 381,
"num": 932,
"message": "success",
"encode": "63387",
"modelId": 746,
"fieldName": "浩轩.孙",
"fieldType": 134,
"createTime": "2023-06-10"
}
]
}
],
"optimizeCountSql": true,
"isSearchCount": true,
"countId": "197",
"maxLimit": 413
}
}21.2. 新增或者更新记录
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 新增或者更新记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectDetail/edit?id=290Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─uid | int64 | 设备uid | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─collectAction | string | 采集动作 | - |
└─storeAction | string | 存储动作 | - |
└─childSn | string | 子设备 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─childName | string | 子设备名称 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 型号 | - |
└─deviceName | string | 设备名称 | - |
└─deviceSn | string | 设备编号 | - |
└─device | object | 采集设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─store | object | 存储设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─signals | array | 组点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 36,
"message": "success",
"data": {
"id": 342,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "ehox5i",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "ih6moo",
"storeAction": "hwixiz",
"childSn": "wslb3i",
"collectTaskId": 715,
"pointGroupId": 736,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 570,
"modelId": 677,
"deviceName": "浩轩.孙",
"deviceSn": "bevjsc",
"device": {
"id": 638,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 383,
"userId": 116,
"extend": "p18kur",
"model": 515,
"lon": "wl8smg",
"lat": "6tji32",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "vkglxn",
"password": "4uaf27",
"status": "online",
"deviceSn": "6qi2zv",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 472,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 431,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 96,
"userId": 891,
"extend": "cq8ztp",
"model": 816,
"lon": "xu6dae",
"lat": "zhh8rx",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "rarlrk",
"password": "uk2kk5",
"status": "online",
"deviceSn": "mvj0ts",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 955,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 451,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 40,
"type": 586,
"num": 328,
"message": "success",
"encode": "63387",
"modelId": 444,
"fieldName": "浩轩.孙",
"fieldType": 537,
"createTime": "2023-06-10"
}
]
}
}21.3. 新增或者更新记录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
uid | int64 | 设备uid | false | - |
extend | string | 扩展字段 | false | - |
storeUid | int64 | 存储设备uid | false | - |
collectAction | string | 采集动作 | false | - |
storeAction | string | 存储动作 | false | - |
childSn | string | 子设备 | false | - |
collectTaskId | int64 | 采集任务id | false | - |
pointGroupId | int64 | 点位组 | false | - |
createTime | string | 创建时间 | false | - |
childName | string | 子设备名称 | false | - |
pointGroupName | string | 点位组名称 | false | - |
collectTaskName | string | 任务名称 | false | - |
deviceTypeId | int64 | 设备类型 | false | - |
modelId | int64 | 型号 | false | - |
deviceName | string | 设备名称 | false | - |
deviceSn | string | 设备编号 | false | - |
device | object | 采集设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
store | object | 存储设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
signals | array | 组点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectDetail/saveOrUpdate --data '{
"id": 469,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "2t22iw",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "hajjn5",
"storeAction": "fs372q",
"childSn": "75euvm",
"collectTaskId": 920,
"pointGroupId": 113,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 921,
"modelId": 260,
"deviceName": "浩轩.孙",
"deviceSn": "mishkp",
"device": {
"id": 204,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 246,
"userId": 647,
"extend": "htkhzi",
"model": 423,
"lon": "l3iddx",
"lat": "imoeit",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "srsh59",
"password": "8pegbx",
"status": "online",
"deviceSn": "6dkqak",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 89,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 794,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 66,
"userId": 66,
"extend": "58flpz",
"model": 653,
"lon": "syardt",
"lat": "6o3jzw",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "qkhf67",
"password": "bjtyrj",
"status": "online",
"deviceSn": "pgvrjm",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 48,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 104,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 550,
"type": 842,
"num": 642,
"message": "success",
"encode": "63387",
"modelId": 779,
"fieldName": "浩轩.孙",
"fieldType": 148,
"createTime": "2023-06-10"
}
]
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 285,
"message": "success",
"data": true
}21.4. 删除指定记录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectDetail/del --data '[
686,
194
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 298,
"message": "success",
"data": true
}22. <p>数据采集任务管理</p>
22.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 任务名称 | true | - |
└─cron | string | 任务调度 | true | - |
└─status | string | 任务状态 | false | - |
└─remark | string | 采集任务说明 | false | - |
└─reason | string | 任务失败的原因 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─details | array | 点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─uid | int64 | 设备uid | false | - |
└─extend | string | 扩展字段 | false | - |
└─storeUid | int64 | 存储设备uid | false | - |
└─collectAction | string | 采集动作 | false | - |
└─storeAction | string | 存储动作 | false | - |
└─childSn | string | 子设备 | false | - |
└─collectTaskId | int64 | 采集任务id | false | - |
└─pointGroupId | int64 | 点位组 | false | - |
└─createTime | string | 创建时间 | false | - |
└─childName | string | 子设备名称 | false | - |
└─pointGroupName | string | 点位组名称 | false | - |
└─collectTaskName | string | 任务名称 | false | - |
└─deviceTypeId | int64 | 设备类型 | false | - |
└─modelId | int64 | 型号 | false | - |
└─deviceName | string | 设备名称 | false | - |
└─deviceSn | string | 设备编号 | false | - |
└─device | object | 采集设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─store | object | 存储设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─signals | array | 组点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 任务名称 | true | - |
└─cron | string | 任务调度 | true | - |
└─status | string | 任务状态 | false | - |
└─remark | string | 采集任务说明 | false | - |
└─reason | string | 任务失败的原因 | false | - |
└─createTime | string | 创建时间 | false | - |
└─updateTime | string | 更新时间 | false | - |
└─details | array | 点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─uid | int64 | 设备uid | false | - |
└─extend | string | 扩展字段 | false | - |
└─storeUid | int64 | 存储设备uid | false | - |
└─collectAction | string | 采集动作 | false | - |
└─storeAction | string | 存储动作 | false | - |
└─childSn | string | 子设备 | false | - |
└─collectTaskId | int64 | 采集任务id | false | - |
└─pointGroupId | int64 | 点位组 | false | - |
└─createTime | string | 创建时间 | false | - |
└─childName | string | 子设备名称 | false | - |
└─pointGroupName | string | 点位组名称 | false | - |
└─collectTaskName | string | 任务名称 | false | - |
└─deviceTypeId | int64 | 设备类型 | false | - |
└─modelId | int64 | 型号 | false | - |
└─deviceName | string | 设备名称 | false | - |
└─deviceSn | string | 设备编号 | false | - |
└─device | object | 采集设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─store | object | 存储设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─signals | array | 组点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 任务名称 | true | - |
cron | string | 任务调度 | true | - |
status | string | 任务状态 | false | - |
remark | string | 采集任务说明 | false | - |
reason | string | 任务失败的原因 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
details | array | 点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─uid | int64 | 设备uid | false | - |
└─extend | string | 扩展字段 | false | - |
└─storeUid | int64 | 存储设备uid | false | - |
└─collectAction | string | 采集动作 | false | - |
└─storeAction | string | 存储动作 | false | - |
└─childSn | string | 子设备 | false | - |
└─collectTaskId | int64 | 采集任务id | false | - |
└─pointGroupId | int64 | 点位组 | false | - |
└─createTime | string | 创建时间 | false | - |
└─childName | string | 子设备名称 | false | - |
└─pointGroupName | string | 点位组名称 | false | - |
└─collectTaskName | string | 任务名称 | false | - |
└─deviceTypeId | int64 | 设备类型 | false | - |
└─modelId | int64 | 型号 | false | - |
└─deviceName | string | 设备名称 | false | - |
└─deviceSn | string | 设备编号 | false | - |
└─device | object | 采集设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─store | object | 存储设备 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
└─modelName | string | 型号名称 | false | - |
└─deviceTypeName | string | 设备类型名称 | false | - |
└─alias | enum | 设备别名(See: 设备类型别名) | false | - |
└─signals | array | 组点位列表 | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectTask/view?orders[0].details[0].collectAction=mx3siw&records[0].updateTime=2023-06-10&records[0].details[0].collectTaskName=浩轩.孙&records[0].details[0].store.account=ppye5a&records[0].details[0].signals[0].fieldType=132&details[0].signals[0].id=493&details[0].device.createTime=2023-06-10&details[0].signals[0].fieldName=浩轩.孙&records[0].details[0].store.deviceTypeId=460&orders[0].details[0].device.id=903&countId=197&orders[0].details[0].store.name=浩轩.孙&records[0].name=浩轩.孙&details[0].modelId=366&details[0].device.userId=874&orders[0].details[0].device.switchTime=2023-06-10&details[0].store.status=online&details[0].store.id=502&records[0].details[0].store.port=372&records[0].details[0].store.deviceSn=y8m4kz&details[0].device.model=355&records[0].createTime=2023-06-10&details[0].device.deviceTypeName=浩轩.孙&orders[0].details[0].store.createTime=2023-06-10&details[0].device.ip=100.147.100.159&records[0].details[0].deviceTypeId=189&records[0].details[0].device.id=591&records[0].details[0].store.userId=520&details[0].signals[0].type=880&records[0].details[0].signals[0].encode=63387&orders[0].details[0].store.ip=100.147.100.159&records[0].details[0].deviceName=浩轩.孙&records[0].details[0].store.switchTime=2023-06-10&isSearchCount=true&records[0].details[0].collectAction=3hq6vp&records[0].details[0].deviceSn=ybzc4i&details[0].store.model=139&details[0].device.updateTime=2023-06-10&records[0].details[0].signals[0].address=高街4888号， 咸阳， 陕 053436&records[0].details[0].store.lat=7yghue&details[0].collectTaskId=694&maxLimit=845&records[0].details[0].device.password=xw3062&orders[0].details[0].storeAction=ur1014&orders[0].details[0].device.lon=vvzsj1&orders[0].details[0].modelId=326&orders[0].details[0].collectTaskId=114&records[0].details[0].device.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].device.address=高街4888号， 咸阳， 陕 053436&details[0].store.updateTime=2023-06-10&records[0].details[0].store.address=高街4888号， 咸阳， 陕 053436&id=139&details[0].store.deviceSn=k9b8ut&optimizeCountSql=true&records[0].status=a650uh&details[0].storeAction=09cc9h&records[0].details[0].store.id=245&records[0].details[0].store.createTime=2023-06-10&orders[0].details[0].device.deviceTypeId=762&details[0].signals[0].typeId=205&records[0].details[0].device.account=er3tr8&total=335&details[0].extend=btytoo&orders[0].details[0].store.updateTime=2023-06-10&details[0].store.deviceTypeId=406&records[0].details[0].id=473&details[0].deviceSn=asetae&details[0].childSn=acmxfl&details[0].signals[0].name=浩轩.孙&details[0].store.switchTime=2023-06-10&details[0].store.alias=PLC&orders[0].details[0].device.model=143&records[0].details[0].device.alias=PLC&records[0].details[0].signals[0].createTime=2023-06-10&details[0].createTime=2023-06-10&records[0].details[0].signals[0].name=浩轩.孙&details[0].device.alias=PLC&details[0].signals[0].message=success&records[0].id=844&records[0].details[0].storeAction=8rk134&orders[0].details[0].device.deviceSn=m08iw9&details[0].device.name=浩轩.孙&orders[0].details[0].store.lon=fmn0sp&details[0].device.modelName=浩轩.孙&records[0].details[0].signals[0].id=598&records[0].reason=mz1353&records[0].details[0].device.deviceSn=xk75su&records[0].details[0].pointGroupId=761&size=698&orders[0].details[0].store.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&details[0].signals[0].fieldType=104&orders[0].details[0].signals[0].typeId=271&details[0].deviceTypeId=105&details[0].store.password=lfo2pp&orders[0].details[0].deviceSn=pnlfz1&records[0].details[0].store.status=online&records[0].details[0].store.ip=100.147.100.159&status=s2q9jb&details[0].signals[0].encode=63387&orders[0].details[0].childSn=v5phbn&orders[0].remark=boxkwy&details[0].device.switchTime=2023-06-10&orders[0].details[0].storeUid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&details[0].store.userId=981&createTime=2023-06-10&records[0].details[0].signals[0].num=170&orders[0].details[0].device.ip=100.147.100.159&orders[0].details[0].device.userId=254&details[0].storeUid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&details[0].signals[0].modelId=910&details[0].store.ip=100.147.100.159&orders[0].details[0].extend=nbablq&records[0].details[0].store.updateTime=2023-06-10&details[0].pointGroupId=564&records[0].details[0].store.deviceTypeName=浩轩.孙&details[0].pointGroupName=浩轩.孙&records[0].details[0].extend=2jctxq&records[0].details[0].device.extend=zvu4se&orders[0].details[0].device.lat=c6zun5&orders[0].details[0].signals[0].encode=63387&records[0].details[0].device.status=online&details[0].store.port=102&orders[0].cron=rvaoix&orders[0].id=568&hitCount=true&details[0].id=594&records[0].details[0].store.modelName=浩轩.孙&details[0].signals[0].address=高街4888号， 咸阳， 陕 053436&orders[0].details[0].device.updateTime=2023-06-10&orders[0].details[0].store.alias=PLC&orders[0].details[0].store.port=414&name=浩轩.孙&details[0].collectTaskName=浩轩.孙&details[0].signals[0].num=310&records[0].details[0].signals[0].message=success&orders[0].details[0].id=814&orders[0].details[0].device.createTime=2023-06-10&orders[0].details[0].signals[0].modelId=653&orders[0].details[0].signals[0].createTime=2023-06-10&details[0].device.address=高街4888号， 咸阳， 陕 053436&orders[0].details[0].device.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&details[0].device.status=online&records[0].details[0].device.switchTime=2023-06-10&orders[0].details[0].signals[0].num=862&details[0].device.account=i8uanz&orders[0].details[0].store.lat=7a32wr&records[0].details[0].store.lon=jk5ymz&orders[0].details[0].device.account=ur9t02&records[0].details[0].device.updateTime=2023-06-10&details[0].store.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].device.status=online&details[0].device.id=349&orders[0].details[0].signals[0].id=299&orders[0].details[0].collectTaskName=浩轩.孙&details[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].store.status=online&records[0].details[0].device.lat=gsd7lk&orders[0].details[0].deviceName=浩轩.孙&orders[0].createTime=2023-06-10&details[0].device.lon=dr3500&orders[0].details[0].store.password=ea4wxz&orders[0].details[0].store.userId=161&searchCount=true&details[0].childName=浩轩.孙&records[0].details[0].device.createTime=2023-06-10&orders[0].details[0].signals[0].name=浩轩.孙&details[0].store.modelName=浩轩.孙&records[0].details[0].device.modelName=浩轩.孙&details[0].store.deviceTypeName=浩轩.孙&orders[0].details[0].device.deviceTypeName=浩轩.孙&records[0].details[0].device.address=高街4888号， 咸阳， 陕 053436&orders[0].details[0].device.alias=PLC&records[0].details[0].childSn=hwi4ft&records[0].details[0].collectTaskId=511&details[0].store.address=高街4888号， 咸阳， 陕 053436&records[0].details[0].store.alias=PLC&records[0].details[0].signals[0].typeId=832&records[0].details[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].store.modelName=浩轩.孙&records[0].details[0].device.lon=pemphk&orders[0].status=f116m9&details[0].collectAction=rtq4rb&orders[0].details[0].device.port=646&records[0].details[0].store.model=460&orders[0].details[0].store.deviceTypeId=351&details[0].signals[0].createTime=2023-06-10&records[0].details[0].modelId=546&records[0].details[0].store.extend=l95lq9&orders[0].details[0].store.address=高街4888号， 咸阳， 陕 053436&orders[0].details[0].pointGroupName=浩轩.孙&remark=iyb969&orders[0].details[0].store.id=542¤t=135&orders[0].details[0].store.deviceSn=zoy93a&records[0].details[0].device.ip=100.147.100.159&records[0].details[0].device.model=894&orders[0].details[0].store.extend=ds52da&orders[0].details[0].signals[0].fieldType=335&records[0].details[0].store.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].signals[0].address=高街4888号， 咸阳， 陕 053436&cron=e6a5ey&details[0].device.extend=yq2rxq&records[0].details[0].pointGroupName=浩轩.孙&records[0].details[0].childName=浩轩.孙&records[0].details[0].store.name=浩轩.孙&orders[0].details[0].device.modelName=浩轩.孙&details[0].device.deviceTypeId=651&records[0].details[0].signals[0].type=574&records[0].details[0].device.name=浩轩.孙&orders[0].details[0].device.name=浩轩.孙&records[0].details[0].signals[0].fieldName=浩轩.孙&records[0].details[0].device.userId=382&orders[0].name=浩轩.孙&orders[0].updateTime=2023-06-10&orders[0].details[0].device.password=yngi2q&reason=53tptk&records[0].details[0].store.password=459v6s&orders[0].details[0].signals[0].type=249&updateTime=2023-06-10&details[0].device.password=r8qks7&details[0].device.deviceSn=hhwq3d&orders[0].details[0].pointGroupId=801&records[0].cron=smg6pi&orders[0].details[0].store.model=569&records[0].details[0].device.port=174&orders[0].details[0].store.deviceTypeName=浩轩.孙&details[0].deviceName=浩轩.孙&details[0].store.name=浩轩.孙&records[0].details[0].device.deviceTypeName=浩轩.孙&orders[0].details[0].store.account=xw9dr3&details[0].device.lat=2w6gba&details[0].store.account=09ujcz&orders[0].reason=0875he&orders[0].details[0].store.switchTime=2023-06-10&details[0].device.uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&details[0].store.lat=n59wwa&records[0].details[0].storeUid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].details[0].deviceTypeId=830&orders[0].details[0].signals[0].message=success&orders[0].details[0].device.extend=ghpcp9&pages=860&records[0].remark=13cf6h&orders[0].details[0].signals[0].fieldName=浩轩.孙&records[0].details[0].createTime=2023-06-10&records[0].details[0].device.deviceTypeId=510&records[0].details[0].signals[0].modelId=383&orders[0].details[0].createTime=2023-06-10&details[0].device.port=38&details[0].store.extend=w2tjdb&details[0].store.lon=buyrfw&details[0].store.createTime=2023-06-10&orders[0].details[0].childName=浩轩.孙Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 任务名称 | - |
└─cron | string | 任务调度 | - |
└─status | string | 任务状态 | - |
└─remark | string | 采集任务说明 | - |
└─reason | string | 任务失败的原因 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─details | array | 点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─uid | int64 | 设备uid | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─collectAction | string | 采集动作 | - |
└─storeAction | string | 存储动作 | - |
└─childSn | string | 子设备 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─childName | string | 子设备名称 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 型号 | - |
└─deviceName | string | 设备名称 | - |
└─deviceSn | string | 设备编号 | - |
└─device | object | 采集设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─store | object | 存储设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─signals | array | 组点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 546,
"message": "success",
"data": {
"size": 729,
"total": 160,
"pages": 464,
"current": 158,
"records": [
{
"id": 792,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "meq2a7",
"status": "z6ppfe",
"remark": "8e03zs",
"reason": "j29u9u",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"details": [
{
"id": 330,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "7jn7jb",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "xvaq5q",
"storeAction": "7eqtyl",
"childSn": "thadj7",
"collectTaskId": 65,
"pointGroupId": 329,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 161,
"modelId": 183,
"deviceName": "浩轩.孙",
"deviceSn": "g7h455",
"device": {
"id": 516,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 675,
"userId": 701,
"extend": "e6hwe5",
"model": 238,
"lon": "zq9uy8",
"lat": "wwgmi3",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "pozsj6",
"password": "h0j23q",
"status": "online",
"deviceSn": "rwlr8i",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 814,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 924,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 13,
"userId": 701,
"extend": "vl879d",
"model": 392,
"lon": "pe9wc4",
"lat": "y6cpbn",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "hsk1hi",
"password": "ly6kd4",
"status": "online",
"deviceSn": "j7utfj",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 626,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 244,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 340,
"type": 478,
"num": 491,
"message": "success",
"encode": "63387",
"modelId": 676,
"fieldName": "浩轩.孙",
"fieldType": 635,
"createTime": "2023-06-10"
}
]
}
]
}
],
"searchCount": true,
"hitCount": true
}
}22.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectTask/edit?id=526Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 任务名称 | - |
└─cron | string | 任务调度 | - |
└─status | string | 任务状态 | - |
└─remark | string | 采集任务说明 | - |
└─reason | string | 任务失败的原因 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─details | array | 点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─uid | int64 | 设备uid | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─collectAction | string | 采集动作 | - |
└─storeAction | string | 存储动作 | - |
└─childSn | string | 子设备 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─childName | string | 子设备名称 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelId | int64 | 型号 | - |
└─deviceName | string | 设备名称 | - |
└─deviceSn | string | 设备编号 | - |
└─device | object | 采集设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─store | object | 存储设备 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─signals | array | 组点位列表 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 728,
"message": "success",
"data": {
"id": 267,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "pclt2h",
"status": "r0sack",
"remark": "uf80kp",
"reason": "0fi6s7",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"details": [
{
"id": 514,
"section": [
{
}
],
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"extend": "7m0x56",
"storeUid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"collectAction": "u4l9h6",
"storeAction": "shxvcj",
"childSn": "fk5ks6",
"collectTaskId": 838,
"pointGroupId": 580,
"createTime": "2023-06-10",
"childName": "浩轩.孙",
"pointGroupName": "浩轩.孙",
"collectTaskName": "浩轩.孙",
"deviceTypeId": 722,
"modelId": 674,
"deviceName": "浩轩.孙",
"deviceSn": "q6978k",
"device": {
"id": 592,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 456,
"userId": 153,
"extend": "zbibzc",
"model": 258,
"lon": "i5inb8",
"lat": "2x4f99",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "p09j6h",
"password": "7vlyp2",
"status": "online",
"deviceSn": "ap3bk6",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 479,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"store": {
"id": 412,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 120,
"userId": 5,
"extend": "ddi1nn",
"model": 535,
"lon": "exosay",
"lat": "0jgvlp",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "56vrtu",
"password": "663jyg",
"status": "online",
"deviceSn": "k7wvsr",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 703,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
},
"signals": [
{
"id": 656,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 869,
"type": 476,
"num": 162,
"message": "success",
"encode": "63387",
"modelId": 851,
"fieldName": "浩轩.孙",
"fieldType": 581,
"createTime": "2023-06-10"
}
]
}
]
}
}22.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 任务名称 | true | - |
cron | string | 任务调度 | true | - |
status | string | 任务状态 | false | - |
remark | string | 采集任务说明 | false | - |
reason | string | 任务失败的原因 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectTask/saveOrUpdate --data '{
"id": 950,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "8mxk4i",
"status": "sludpo",
"remark": "07bawf",
"reason": "sehh7n",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 417,
"message": "success",
"data": true
}22.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectTask/del --data '[
910,
173
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 525,
"message": "success",
"data": true
}22.5. 切换采集状态
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 切换采集状态
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 任务名称 | true | - |
cron | string | 任务调度 | true | - |
status | string | 任务状态 | false | - |
remark | string | 采集任务说明 | false | - |
reason | string | 任务失败的原因 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/collectTask/status --data '{
"id": 886,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "rzodsa",
"status": "6xcrpn",
"remark": "lazydx",
"reason": "54eqo4",
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 159,
"message": "success",
"data": true
}22.6. 采集动作
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 采集动作
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectTask/collectActionsResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
Response-example:
{
"code": 36,
"message": "success",
"data": [
{
"label": "kuhjrm",
"value": "qmcp4q"
}
]
}22.7. 存储动作
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 存储动作
Request-example:
curl -X GET -i http://127.0.0.1/iot/collectTask/storeActionsResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
Response-example:
{
"code": 464,
"message": "success",
"data": [
{
"label": "rmfnxr",
"value": "uo3c6e"
}
]
}23. <p>子设备管理</p>
23.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 子设备名称 | false | - |
└─uid | int64 | 设备uid | false | - |
└─childSn | string | 子设备编号 | false | - |
└─protocolType | string | 协议类型 | false | - |
└─remark | string | 备注 | false | - |
└─createTime | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 子设备名称 | false | - |
└─uid | int64 | 设备uid | false | - |
└─childSn | string | 子设备编号 | false | - |
└─protocolType | string | 协议类型 | false | - |
└─remark | string | 备注 | false | - |
└─createTime | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 子设备名称 | false | - |
uid | int64 | 设备uid | false | - |
childSn | string | 子设备编号 | false | - |
protocolType | string | 协议类型 | false | - |
remark | string | 备注 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceChild/view?orders[0].createTime=2023-06-10&name=浩轩.孙¤t=854&size=710&maxLimit=11&orders[0].protocolType=9gn8gf&pages=997&orders[0].remark=2gtqjb&id=529&searchCount=true&orders[0].childSn=0pf4t0&protocolType=nmpfqg&createTime=2023-06-10&countId=197&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&total=882&hitCount=true&isSearchCount=true&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].id=470&records[0].name=浩轩.孙&records[0].createTime=2023-06-10&orders[0].id=8&optimizeCountSql=true&records[0].remark=k74156&orders[0].name=浩轩.孙&childSn=8aiw54&records[0].protocolType=55r3x4&remark=rnz6ef&records[0].childSn=28qcssResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 431,
"message": "success",
"data": {
"size": 611,
"total": 717,
"pages": 354,
"current": 723,
"records": [
{
"id": 67,
"section": [
{
}
],
"name": "浩轩.孙",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"childSn": "yeiyni",
"protocolType": "tiwic7",
"remark": "lpehjz",
"createTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}23.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceChild/edit?id=309Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 297,
"message": "success",
"data": {
"id": 305,
"section": [
{
}
],
"name": "浩轩.孙",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"childSn": "cpio3b",
"protocolType": "4gfg6a",
"remark": "otxauu",
"createTime": "2023-06-10"
}
}23.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 子设备名称 | false | - |
uid | int64 | 设备uid | false | - |
childSn | string | 子设备编号 | false | - |
protocolType | string | 协议类型 | false | - |
remark | string | 备注 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceChild/saveOrUpdate --data '{
"id": 786,
"section": [
{
}
],
"name": "浩轩.孙",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"childSn": "gojrkh",
"protocolType": "5r7qen",
"remark": "vrvxo9",
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 543,
"message": "success",
"data": true
}23.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceChild/del --data '[
356,
249
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 312,
"message": "success",
"data": true
}23.5. 或者指定设备下的子设备列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 或者指定设备下的子设备列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
uid | int64 | 设备uid | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceChild/listByUid?uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 942,
"message": "success",
"data": [
{
"id": 73,
"section": [
{
}
],
"name": "浩轩.孙",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"childSn": "ah5eu8",
"protocolType": "w7bet0",
"remark": "1uy2fw",
"createTime": "2023-06-10"
}
]
}24. <p>设备管理</p>
24.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
modelName | string | 型号名称 | false | - |
deviceTypeName | string | 设备类型名称 | false | - |
alias | enum | 设备别名(See: 设备类型别名) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/device/view?extend=gjgwnk&orders[0].password=qrjn93&orders[0].name=浩轩.孙&records[0].model=997&records[0].password=qpndwq&records[0].deviceTypeId=816¤t=460&switchTime=2023-06-10&pages=307&deviceTypeId=507&orders[0].switchTime=2023-06-10&orders[0].status=online&records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].deviceSn=vq4aqh&records[0].ip=100.147.100.159&records[0].switchTime=2023-06-10&model=948&orders[0].model=311&records[0].lon=pn754b&deviceSn=1etyoa&name=浩轩.孙&orders[0].userId=758&orders[0].createTime=2023-06-10&orders[0].updateTime=2023-06-10&port=250&lon=kwph7f&orders[0].ip=100.147.100.159&isSearchCount=true&orders[0].address=高街4888号， 咸阳， 陕 053436&id=131&lat=vzsuar&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].name=浩轩.孙&records[0].createTime=2023-06-10&records[0].address=高街4888号， 咸阳， 陕 053436&records[0].account=999p7l&password=nbbvrz&userId=990&records[0].userId=26&searchCount=true&updateTime=2023-06-10&orders[0].lat=pnit1p&account=8wspbk&address=高街4888号， 咸阳， 陕 053436&size=214&orders[0].lon=65n43m&records[0].lat=cygf3o&deviceTypeName=浩轩.孙&records[0].port=475&orders[0].deviceTypeId=600&hitCount=true&total=29&records[0].id=542&optimizeCountSql=true&orders[0].port=781&records[0].status=online&status=online&orders[0].id=580&orders[0].account=eidqjz&records[0].deviceSn=v0ggi0&createTime=2023-06-10&records[0].updateTime=2023-06-10&maxLimit=294&alias=PLC&modelName=浩轩.孙&orders[0].extend=zjq6jy&countId=197&ip=100.147.100.159&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].extend=z883pcResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 757,
"message": "success",
"data": {
"size": 722,
"total": 245,
"pages": 686,
"current": 112,
"records": [
{
"id": 678,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 194,
"userId": 633,
"extend": "9dlwlj",
"model": 245,
"lon": "vippc0",
"lat": "44o2pw",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "4hqqnh",
"password": "8a9dju",
"status": "online",
"deviceSn": "pdqe2x",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 279,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
}
],
"searchCount": true,
"hitCount": true
}
}24.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/device/edit?id=338Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 942,
"message": "success",
"data": {
"id": 49,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 255,
"userId": 504,
"extend": "hnawkh",
"model": 734,
"lon": "icwu2z",
"lat": "q80k3t",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "7896fl",
"password": "9gsz1n",
"status": "online",
"deviceSn": "c1cygh",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 280
}
}24.3. 修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/device/edit --data '{
"id": 334,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 242,
"userId": 846,
"extend": "21p7n3",
"model": 842,
"lon": "3aq1d6",
"lat": "1avyq0",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "wsugvd",
"password": "2u8gv7",
"status": "online",
"deviceSn": "b4sbm0",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 816
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 23,
"message": "success",
"data": true
}24.4. 新增记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/device/add --data '{
"id": 391,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 880,
"userId": 466,
"extend": "cwmaba",
"model": 325,
"lon": "yre1s7",
"lat": "mpm3tc",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "hrrzwk",
"password": "eohvua",
"status": "online",
"deviceSn": "e0f7lc",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 872
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 885,
"message": "success",
"data": true
}24.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/device/del --data '[
548,
583
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 767,
"message": "success",
"data": true
}24.6. 获取指定型号下面的设备列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取指定型号下面的设备列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
modelId | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/device/listByModel?modelId=496Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 800,
"message": "success",
"data": [
{
"id": 635,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 431,
"userId": 416,
"extend": "xt5rj5",
"model": 90,
"lon": "6ryx9q",
"lat": "54v5fi",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "q2b06w",
"password": "t5z343",
"status": "online",
"deviceSn": "yh8ryc",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 782
}
]
}25. 调试
25.1.
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/debug/tcp?hitCount=true&maxLimit=444&optimizeCountSql=true&pages=591&countId=197&size=495&total=18&searchCount=true&isSearchCount=true¤t=911Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 975,
"message": "success",
"data": {
"size": 976,
"total": 600,
"pages": 243,
"current": 617,
"records": [
{
"id": 395,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 892,
"userId": 993,
"extend": "w1bil7",
"model": 349,
"lon": "cvjpsl",
"lat": "46703o",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "1rftnd",
"password": "f0oq5m",
"status": "online",
"deviceSn": "gn2kpu",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 981
}
],
"searchCount": true,
"hitCount": true
}
}25.2. 订阅
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 订阅
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
topic | string | No comments found. | false | - |
qoS | enum | AT_MOST_ONCE | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/debug/mqtt/subscribe?qoS=AT_MOST_ONCE&topic=dfut4wResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 364,
"message": "success",
"data": true
}26. <p>dtu设备管理</p>
26.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
modelName | string | 型号名称 | false | - |
deviceTypeName | string | 设备类型名称 | false | - |
alias | enum | 设备别名(See: 设备类型别名) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/dtu/view?uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&deviceTypeId=958&orders[0].createTime=2023-06-10&orders[0].ip=100.147.100.159&optimizeCountSql=true&name=浩轩.孙&status=online&model=853&lon=0009in&account=5k4lu4&hitCount=true&userId=415&records[0].id=281&lat=bbusm9&records[0].extend=aozcat&records[0].model=891&address=高街4888号， 咸阳， 陕 053436¤t=657&records[0].userId=47&records[0].lon=4ewir5&orders[0].model=669&records[0].lat=9v51ie&orders[0].name=浩轩.孙&orders[0].deviceTypeId=962&deviceTypeName=浩轩.孙&orders[0].deviceSn=t2tlvr&countId=197&createTime=2023-06-10&orders[0].address=高街4888号， 咸阳， 陕 053436&records[0].address=高街4888号， 咸阳， 陕 053436&deviceSn=3dtr0o&orders[0].switchTime=2023-06-10&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].lat=olw9e2&records[0].updateTime=2023-06-10&orders[0].password=rwch53&maxLimit=122&records[0].switchTime=2023-06-10&orders[0].port=772&modelName=浩轩.孙&alias=PLC&updateTime=2023-06-10&records[0].name=浩轩.孙&size=151&records[0].deviceSn=0aiqrx&records[0].createTime=2023-06-10&records[0].password=ww3d80&ip=100.147.100.159&password=a3ydn3&pages=183&searchCount=true&extend=dhtcij&switchTime=2023-06-10&orders[0].extend=4kbola&records[0].account=zzzxez&orders[0].account=xcwopn&port=619&records[0].deviceTypeId=289&records[0].port=316&orders[0].userId=955&orders[0].id=998&orders[0].status=online&records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].lon=ervnwv&orders[0].updateTime=2023-06-10&records[0].ip=100.147.100.159&total=459&isSearchCount=true&records[0].status=online&id=418Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 900,
"message": "success",
"data": {
"size": 241,
"total": 39,
"pages": 447,
"current": 571,
"records": [
{
"id": 624,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 783,
"userId": 287,
"extend": "ssyny3",
"model": 422,
"lon": "kei5ep",
"lat": "krw1ht",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "1vyrf7",
"password": "cih63g",
"status": "online",
"deviceSn": "5hw80b",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 11,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
}
],
"searchCount": true,
"hitCount": true
}
}26.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/dtu/edit?id=649Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 46,
"message": "success",
"data": {
"id": 465,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 483,
"userId": 132,
"extend": "4ka3pe",
"model": 542,
"lon": "yfl5w6",
"lat": "jr1tme",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "dxiz1f",
"password": "lm7ilu",
"status": "online",
"deviceSn": "7k0eub",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 369
}
}26.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/dtu/saveOrUpdate --data '{
"id": 912,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 25,
"userId": 157,
"extend": "c8hxih",
"model": 24,
"lon": "pxhcvb",
"lat": "9vczlw",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "odhk4o",
"password": "xysr2o",
"status": "online",
"deviceSn": "abxbbp",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 821
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 267,
"message": "success",
"data": true
}26.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/dtu/del --data '[
637,
836
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 172,
"message": "success",
"data": true
}27. <p>modbus设备管理</p>
27.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
modelName | string | 型号名称 | false | - |
deviceTypeName | string | 设备类型名称 | false | - |
alias | enum | 设备别名(See: 设备类型别名) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/modbus/view?address=高街4888号， 咸阳， 陕 053436&extend=xgxslg&name=浩轩.孙&pages=678&orders[0].deviceSn=3h7tov&orders[0].deviceTypeId=499&records[0].updateTime=2023-06-10&records[0].lon=ypiolv&records[0].account=e03foq&orders[0].model=719&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&userId=242&id=101&orders[0].id=441&alias=PLC&orders[0].updateTime=2023-06-10&maxLimit=178&orders[0].userId=201&orders[0].createTime=2023-06-10&password=tkvgrq&records[0].ip=100.147.100.159&records[0].status=online&records[0].lat=a1bqsi&records[0].password=ovn8ow&lat=5j6b0x¤t=466&records[0].deviceTypeId=341&orders[0].lon=qtx7n7&records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].userId=73&records[0].switchTime=2023-06-10&orders[0].password=49k2rq&orders[0].status=online&ip=100.147.100.159&deviceSn=f5orhv&deviceTypeName=浩轩.孙&records[0].port=888&orders[0].ip=100.147.100.159&switchTime=2023-06-10&orders[0].lat=yt5zsc&hitCount=true&optimizeCountSql=true&records[0].model=193&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&modelName=浩轩.孙&records[0].extend=8s4vga&orders[0].switchTime=2023-06-10&size=63&records[0].deviceSn=h33jqg&port=542&records[0].name=浩轩.孙&records[0].createTime=2023-06-10&searchCount=true&orders[0].account=og1rnr&orders[0].name=浩轩.孙&orders[0].extend=jixhrl&status=online&orders[0].port=597&total=736&records[0].id=134&records[0].address=高街4888号， 咸阳， 陕 053436&orders[0].address=高街4888号， 咸阳， 陕 053436&model=912&account=0o2xjj&isSearchCount=true&countId=197&updateTime=2023-06-10&deviceTypeId=426&lon=yt80yk&createTime=2023-06-10Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 586,
"message": "success",
"data": {
"size": 367,
"total": 114,
"pages": 864,
"current": 22,
"records": [
{
"id": 948,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 678,
"userId": 198,
"extend": "3iy0ax",
"model": 565,
"lon": "kyady4",
"lat": "q9eyez",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "uzjr1d",
"password": "9qfg54",
"status": "online",
"deviceSn": "twhgw4",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 572,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
}
],
"searchCount": true,
"hitCount": true
}
}27.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/modbus/edit?id=166Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 277,
"message": "success",
"data": {
"id": 214,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 501,
"userId": 458,
"extend": "uckf5g",
"model": 606,
"lon": "b8ya65",
"lat": "qoljdj",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "wdr2mr",
"password": "w8yqjn",
"status": "online",
"deviceSn": "qontsq",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 284
}
}27.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/modbus/saveOrUpdate --data '{
"id": 484,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 149,
"userId": 244,
"extend": "pvl4c6",
"model": 751,
"lon": "6uiaq9",
"lat": "m3v6su",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "0l0tkf",
"password": "rz3qj1",
"status": "online",
"deviceSn": "i6o76l",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 732
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 167,
"message": "success",
"data": true
}27.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/modbus/del --data '[
564,
261
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 592,
"message": "success",
"data": true
}27.5. 设备连接
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 设备连接
Path-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
status | enum | online | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/modbus/connect/online --data '{
"id": 425,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 533,
"userId": 253,
"extend": "kfbwf6",
"model": 338,
"lon": "ht29or",
"lat": "q67dqf",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "q7ly9t",
"password": "s803jc",
"status": "online",
"deviceSn": "uk5hf2",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 703
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 897,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}28. <p>设备型号管理</p>
28.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─typeId | int32 | 设备类型 | false | - |
└─typeName | string | 设备类型名称 | false | - |
└─model | string | 型号 | false | - |
└─remark | string | 型号说明 | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─typeId | int32 | 设备类型 | false | - |
└─typeName | string | 设备类型名称 | false | - |
└─model | string | 型号 | false | - |
└─remark | string | 型号说明 | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
typeId | int32 | 设备类型 | false | - |
typeName | string | 设备类型名称 | false | - |
model | string | 型号 | false | - |
remark | string | 型号说明 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceModel/view?orders[0].typeName=浩轩.孙&model=lupv08&pages=395&searchCount=true&orders[0].typeId=145&countId=197&maxLimit=946&remark=rdexhg&hitCount=true&records[0].remark=8o8wm1&isSearchCount=true&typeName=浩轩.孙&records[0].model=ljegjp&optimizeCountSql=true¤t=875&records[0].id=800&size=571&orders[0].id=986&orders[0].model=ez3kyu&records[0].typeName=浩轩.孙&orders[0].remark=utql0f&typeId=525&total=408&id=801&records[0].typeId=867Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─typeId | int32 | 设备类型 | - |
└─typeName | string | 设备类型名称 | - |
└─model | string | 型号 | - |
└─remark | string | 型号说明 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 652,
"message": "success",
"data": {
"size": 238,
"total": 156,
"pages": 121,
"current": 697,
"records": [
{
"id": 634,
"section": [
{
}
],
"typeId": 256,
"typeName": "浩轩.孙",
"model": "8cod2c",
"remark": "xffy2i"
}
],
"searchCount": true,
"hitCount": true
}
}28.2. 通过设备类型获取设备型号列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 通过设备类型获取设备型号列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
typeId | int32 | -1将获取所有 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceModel/listByType?typeId=250Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─typeId | int32 | 设备类型 | - |
└─typeName | string | 设备类型名称 | - |
└─model | string | 型号 | - |
└─remark | string | 型号说明 | - |
Response-example:
{
"code": 381,
"message": "success",
"data": [
{
"id": 636,
"section": [
{
}
],
"typeId": 111,
"typeName": "浩轩.孙",
"model": "nltqjl",
"remark": "dnecp1"
}
]
}28.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceModel/edit?id=595Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─typeId | int32 | 设备类型 | - |
└─typeName | string | 设备类型名称 | - |
└─model | string | 型号 | - |
└─remark | string | 型号说明 | - |
Response-example:
{
"code": 396,
"message": "success",
"data": {
"id": 265,
"section": [
{
}
],
"typeId": 909,
"typeName": "浩轩.孙",
"model": "w8sdpp",
"remark": "ckfdfx"
}
}28.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
typeId | int32 | 设备类型 | false | - |
typeName | string | 设备类型名称 | false | - |
model | string | 型号 | false | - |
remark | string | 型号说明 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceModel/saveOrUpdate --data '{
"id": 511,
"section": [
{
}
],
"typeId": 157,
"typeName": "浩轩.孙",
"model": "23094j",
"remark": "kbi6qy"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 112,
"message": "success",
"data": true
}28.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceModel/del --data '[
998,
353
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 976,
"message": "success",
"data": true
}29. mqtt管理
29.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
modelName | string | 型号名称 | false | - |
deviceTypeName | string | 设备类型名称 | false | - |
alias | enum | 设备别名(See: 设备类型别名) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/mqtt/view?port=802&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&records[0].ip=100.147.100.159&orders[0].userId=195&orders[0].deviceTypeId=394&orders[0].createTime=2023-06-10&records[0].deviceTypeId=913&orders[0].id=739&modelName=浩轩.孙&account=8gchjh&records[0].name=浩轩.孙&name=浩轩.孙&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&id=865&updateTime=2023-06-10&password=qgkt1e&pages=411&records[0].updateTime=2023-06-10&hitCount=true&lon=etr4kl&records[0].model=955&orders[0].account=fng3f0&records[0].id=7&orders[0].name=浩轩.孙&isSearchCount=true&deviceTypeId=373&records[0].extend=22uuff&size=846&records[0].address=高街4888号， 咸阳， 陕 053436¤t=639&orders[0].switchTime=2023-06-10&records[0].port=122&records[0].password=8e6hek&orders[0].ip=100.147.100.159&orders[0].updateTime=2023-06-10&status=online&switchTime=2023-06-10&maxLimit=987&records[0].status=online&orders[0].lat=oq1jxz&address=高街4888号， 咸阳， 陕 053436&records[0].lon=n9wotg&records[0].userId=427&records[0].deviceSn=9979v1&orders[0].model=497&orders[0].status=online&createTime=2023-06-10&orders[0].deviceSn=2bwlia&orders[0].port=888&countId=197&total=675&records[0].createTime=2023-06-10&userId=689&alias=PLC&records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].extend=vsc5la&records[0].switchTime=2023-06-10&extend=qnexay&model=751&ip=100.147.100.159&orders[0].lon=2p38d1&searchCount=true&optimizeCountSql=true&records[0].lat=uvtgor&orders[0].password=jl9waa&deviceSn=ooy62b&deviceTypeName=浩轩.孙&orders[0].address=高街4888号， 咸阳， 陕 053436&records[0].account=t5cm9j&lat=ue7d9dResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 905,
"message": "success",
"data": {
"size": 938,
"total": 906,
"pages": 363,
"current": 747,
"records": [
{
"id": 418,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 915,
"userId": 856,
"extend": "8yy8cw",
"model": 206,
"lon": "szuz70",
"lat": "9cr9ey",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "5spgj4",
"password": "hzlip9",
"status": "online",
"deviceSn": "2qwklv",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 822,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
}
],
"searchCount": true,
"hitCount": true
}
}29.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/mqtt/edit?id=860Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 988,
"message": "success",
"data": {
"id": 375,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 697,
"userId": 332,
"extend": "imyyxr",
"model": 390,
"lon": "fqd71a",
"lat": "030sjn",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "85dqfb",
"password": "9rnnfq",
"status": "online",
"deviceSn": "rq8qrt",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 682
}
}29.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/mqtt/saveOrUpdate --data '{
"id": 991,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 982,
"userId": 187,
"extend": "aqeob8",
"model": 14,
"lon": "v6mmls",
"lat": "fe4gau",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "vwjnju",
"password": "jn52fh",
"status": "online",
"deviceSn": "qbmxb2",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 375
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 281,
"message": "success",
"data": true
}29.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/mqtt/del --data '[
435,
928
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 187,
"message": "success",
"data": true
}29.5. 设备连接
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 设备连接
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
status | enum | online | false | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/mqtt/connect?status=online --data '{
"id": 144,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 493,
"userId": 874,
"extend": "btw91d",
"model": 305,
"lon": "hg3ss1",
"lat": "l4kwge",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "d9aaon",
"password": "h6fpwj",
"status": "online",
"deviceSn": "2ojkiq",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 645
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 596,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}30. <p>plc设备管理</p>
30.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─ip | string | 设备ip | false | - |
└─uid | int64 | 设备uid | false | - |
└─name | string | 设备名称 | true | - |
└─port | int32 | 设备端口 | false | - |
└─userId | int64 | 所属用户 | false | - |
└─extend | string | 拓展字段 | false | - |
└─model | int32 | 设备型号 | false | - |
└─lon | string | 经度 | false | - |
└─lat | string | 纬度 | false | - |
└─address | string | 地址 | false | - |
└─account | string | 设备账号 | false | - |
└─password | string | 设备密码 | false | - |
└─status | enum | 设备状态 | false | - |
└─deviceSn | string | 设备编号 | true | - |
└─switchTime | string | 状态切换时间 | false | - |
└─createTime | string | No comments found. | false | - |
└─updateTime | string | 更新时间 | false | - |
└─deviceTypeId | int64 | 设备类型 | true | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
modelName | string | 型号名称 | false | - |
deviceTypeName | string | 设备类型名称 | false | - |
alias | enum | 设备别名(See: 设备类型别名) | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/plc/view?records[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&model=874&orders[0].password=tfjb7r&records[0].model=350&userId=835&records[0].name=浩轩.孙&name=浩轩.孙&orders[0].deviceTypeId=337&ip=100.147.100.159&records[0].id=309&extend=p9bvcr&records[0].port=184&orders[0].port=790&records[0].account=8e23th&switchTime=2023-06-10&deviceTypeId=703&password=mugotx&deviceSn=1i6z4w&createTime=2023-06-10&pages=733&records[0].status=online&records[0].address=高街4888号， 咸阳， 陕 053436&orders[0].uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&orders[0].account=xatth1&orders[0].createTime=2023-06-10&id=309&deviceTypeName=浩轩.孙&countId=197&orders[0].id=301&lat=r48hk2&orders[0].model=746&records[0].extend=88gley&address=高街4888号， 咸阳， 陕 053436&port=383&size=162&status=online&account=nrylrk&uid=f0ed7b35-25f8-45f3-9041-056e797a9ee0&updateTime=2023-06-10&orders[0].ip=100.147.100.159&orders[0].extend=whj1g5&optimizeCountSql=true&records[0].lon=qtuada&records[0].createTime=2023-06-10&total=322&records[0].password=s2gij4&hitCount=true&records[0].switchTime=2023-06-10&records[0].deviceSn=uorz2o&orders[0].deviceSn=xoi8un&records[0].userId=69¤t=937&records[0].updateTime=2023-06-10&alias=PLC&orders[0].lon=suysg8&orders[0].updateTime=2023-06-10&lon=8jti60&searchCount=true&orders[0].address=高街4888号， 咸阳， 陕 053436&modelName=浩轩.孙&orders[0].switchTime=2023-06-10&records[0].lat=dgkovq&records[0].deviceTypeId=593&orders[0].status=online&records[0].ip=100.147.100.159&orders[0].lat=qzaq8z&orders[0].name=浩轩.孙&isSearchCount=true&maxLimit=61&orders[0].userId=440Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
└─modelName | string | 型号名称 | - |
└─deviceTypeName | string | 设备类型名称 | - |
└─alias | enum | 设备别名(See: 设备类型别名) | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 11,
"message": "success",
"data": {
"size": 22,
"total": 955,
"pages": 191,
"current": 562,
"records": [
{
"id": 44,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 697,
"userId": 540,
"extend": "jwjmcw",
"model": 75,
"lon": "1zro4w",
"lat": "eiq4wp",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "jsr026",
"password": "j5i8f7",
"status": "online",
"deviceSn": "mz33lx",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 160,
"modelName": "浩轩.孙",
"deviceTypeName": "浩轩.孙",
"alias": "PLC"
}
],
"searchCount": true,
"hitCount": true
}
}30.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/plc/edit?id=511Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─ip | string | 设备ip | - |
└─uid | int64 | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─userId | int64 | 所属用户 | - |
└─extend | string | 拓展字段 | - |
└─model | int32 | 设备型号 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | No comments found. | - |
└─updateTime | string | 更新时间 | - |
└─deviceTypeId | int64 | 设备类型 | - |
Response-example:
{
"code": 678,
"message": "success",
"data": {
"id": 275,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 36,
"userId": 734,
"extend": "pyqni9",
"model": 322,
"lon": "c3mv5k",
"lat": "2fz36v",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "i480z7",
"password": "lfct7l",
"status": "online",
"deviceSn": "9lc0ea",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 459
}
}30.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/plc/saveOrUpdate --data '{
"id": 238,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 429,
"userId": 501,
"extend": "zk6f1j",
"model": 255,
"lon": "wz8av7",
"lat": "gav7m0",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "gwasxb",
"password": "nt9v5i",
"status": "online",
"deviceSn": "y1x6y0",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 150
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 184,
"message": "success",
"data": true
}30.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/plc/del --data '[
10,
670
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 407,
"message": "success",
"data": true
}30.5. 设备连接
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 设备连接
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
status | enum | online | false | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
ip | string | 设备ip | false | - |
uid | int64 | 设备uid | false | - |
name | string | 设备名称 | true | - |
port | int32 | 设备端口 | false | - |
userId | int64 | 所属用户 | false | - |
extend | string | 拓展字段 | false | - |
model | int32 | 设备型号 | false | - |
lon | string | 经度 | false | - |
lat | string | 纬度 | false | - |
address | string | 地址 | false | - |
account | string | 设备账号 | false | - |
password | string | 设备密码 | false | - |
status | enum | 设备状态 | false | - |
deviceSn | string | 设备编号 | true | - |
switchTime | string | 状态切换时间 | false | - |
createTime | string | No comments found. | false | - |
updateTime | string | 更新时间 | false | - |
deviceTypeId | int64 | 设备类型 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/plc/connect?status=online --data '{
"id": 525,
"section": [
{
}
],
"ip": "100.147.100.159",
"uid": f0ed7b35-25f8-45f3-9041-056e797a9ee0,
"name": "浩轩.孙",
"port": 182,
"userId": 207,
"extend": "0wube3",
"model": 281,
"lon": "hxqwb3",
"lat": "6gdhzt",
"address": "高街4888号， 咸阳， 陕 053436",
"account": "30lnr2",
"password": "2wg118",
"status": "online",
"deviceSn": "h078bq",
"switchTime": "2023-06-10",
"createTime": "2023-06-10",
"updateTime": "2023-06-10",
"deviceTypeId": 591
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 800,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}31. <p>设备类型管理</p>
31.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
path | string | 路径 | false | - |
name | string | 类型名称 | false | - |
alias | string | 类型别名 | false | - |
remark | string | 类型说明 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceType/view?alias=1bwz4v&path=94a8gd&pid=217&name=浩轩.孙&remark=bpo74b&createTime=2023-06-10&id=185Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 425,
"message": "success",
"data": [
{
"id": 644,
"section": [
{
}
],
"pid": 216,
"children": [
{
"object": "any object"
}
],
"path": "7c8c46",
"name": "浩轩.孙",
"alias": "nj0cwl",
"remark": "lngmj8",
"createTime": "2023-06-10"
}
]
}31.2.
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description:
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
alias | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceType/tree?alias=o6n2ubResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 542,
"message": "success",
"data": [
{
"id": 86,
"section": [
{
}
],
"pid": 886,
"children": [
{
"object": "any object"
}
],
"path": "h0xju0",
"name": "浩轩.孙",
"alias": "h9ogi9",
"remark": "ururag",
"createTime": "2023-06-10"
}
]
}31.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceType/edit?id=951Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─children | array | 此节点的子节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 674,
"message": "success",
"data": {
"id": 185,
"section": [
{
}
],
"pid": 333,
"children": [
{
"object": "any object"
}
],
"path": "jox0ya",
"name": "浩轩.孙",
"alias": "e9gxoa",
"remark": "ifh936",
"createTime": "2023-06-10"
}
}31.4. 修改记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 修改记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
path | string | 路径 | false | - |
name | string | 类型名称 | false | - |
alias | string | 类型别名 | false | - |
remark | string | 类型说明 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceType/edit --data '{
"id": 646,
"section": [
{
}
],
"pid": 295,
"children": [
{
"object": "any object"
}
],
"path": "klavwe",
"name": "浩轩.孙",
"alias": "pyf7tm",
"remark": "8wsrx3",
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 377,
"message": "success",
"data": true
}31.5. 新增记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
pid | int64 | 当前树节点的父节点 | false | - |
children | array | 此节点的子节点 | false | - |
path | string | 路径 | false | - |
name | string | 类型名称 | false | - |
alias | string | 类型别名 | false | - |
remark | string | 类型说明 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceType/add --data '{
"id": 755,
"section": [
{
}
],
"pid": 503,
"children": [
{
"object": "any object"
}
],
"path": "9b628u",
"name": "浩轩.孙",
"alias": "p67j6a",
"remark": "a6mwjj",
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 650,
"message": "success",
"data": true
}31.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/deviceType/del --data '[
185,
595
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 65,
"message": "success",
"data": true
}31.7. 获取设备类型别名列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取设备类型别名列表
Request-example:
curl -X GET -i http://127.0.0.1/iot/deviceType/aliasResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 名称 | - |
└─value | string | 值 | - |
Response-example:
{
"code": 872,
"message": "success",
"data": [
{
"label": "fvmrsb",
"value": "f8ee2q"
}
]
}32. 系统功能统计
32.1. 当前设备总数和当前在线数
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 当前设备总数和当前在线数
Request-example:
curl -X GET -i http://127.0.0.1/iot/statistics/device/currentResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─today | int64 | 总设备数量 | - |
└─online | int64 | 在线数量 | - |
Response-example:
{
"code": 51,
"message": "success",
"data": {
"today": 418,
"online": 340
}
}33. <p>点位组管理</p>
33.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 组名称 | false | - |
└─typeId | int64 | 点位类型 | false | - |
└─typeName | string | 类型名称 | false | - |
└─modelName | string | 型号名称 | false | - |
└─modelId | int32 | 所属型号 | false | - |
└─signalIds | array | 点位信号列表 | false | - |
└─createTime | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 组名称 | false | - |
└─typeId | int64 | 点位类型 | false | - |
└─typeName | string | 类型名称 | false | - |
└─modelName | string | 型号名称 | false | - |
└─modelId | int32 | 所属型号 | false | - |
└─signalIds | array | 点位信号列表 | false | - |
└─createTime | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 组名称 | false | - |
typeId | int64 | 点位类型 | false | - |
typeName | string | 类型名称 | false | - |
modelName | string | 型号名称 | false | - |
modelId | int32 | 所属型号 | false | - |
signalIds | array | 点位信号列表 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/pointGroup/view?name=浩轩.孙&total=838&orders[0].name=浩轩.孙&records[0].modelName=浩轩.孙&typeName=浩轩.孙&records[0].createTime=2023-06-10&orders[0].id=778&searchCount=true&isSearchCount=true&orders[0].modelName=浩轩.孙&optimizeCountSql=true&orders[0].typeName=浩轩.孙&orders[0].typeId=256&pages=374&records[0].typeName=浩轩.孙&records[0].id=460&records[0].name=浩轩.孙&id=535&typeId=880&size=988&hitCount=true&countId=197&modelId=216&orders[0].createTime=2023-06-10&orders[0].modelId=964&modelName=浩轩.孙&maxLimit=61&records[0].typeId=464&createTime=2023-06-10¤t=619&records[0].modelId=700Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 组名称 | - |
└─typeId | int64 | 点位类型 | - |
└─typeName | string | 类型名称 | - |
└─modelName | string | 型号名称 | - |
└─modelId | int32 | 所属型号 | - |
└─signalIds | array | 点位信号列表 | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 584,
"message": "success",
"data": {
"size": 998,
"total": 219,
"pages": 557,
"current": 729,
"records": [
{
"id": 432,
"section": [
{
}
],
"name": "浩轩.孙",
"typeId": 172,
"typeName": "浩轩.孙",
"modelName": "浩轩.孙",
"modelId": 311,
"signalIds": [
"6we57s"
],
"createTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}33.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/pointGroup/edit?id=147Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 组名称 | - |
└─typeId | int64 | 点位类型 | - |
└─typeName | string | 类型名称 | - |
└─modelName | string | 型号名称 | - |
└─modelId | int32 | 所属型号 | - |
└─signalIds | array | 点位信号列表 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 88,
"message": "success",
"data": {
"id": 249,
"section": [
{
}
],
"name": "浩轩.孙",
"typeId": 996,
"typeName": "浩轩.孙",
"modelName": "浩轩.孙",
"modelId": 200,
"signalIds": [
"y33b9r"
],
"createTime": "2023-06-10"
}
}33.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 组名称 | false | - |
typeId | int64 | 点位类型 | false | - |
typeName | string | 类型名称 | false | - |
modelName | string | 型号名称 | false | - |
modelId | int32 | 所属型号 | false | - |
signalIds | array | 点位信号列表 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/pointGroup/saveOrUpdate --data '{
"id": 415,
"section": [
{
}
],
"name": "浩轩.孙",
"typeId": 90,
"typeName": "浩轩.孙",
"modelName": "浩轩.孙",
"modelId": 479,
"signalIds": [
"57m6p1"
],
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 109,
"message": "success",
"data": true
}33.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/pointGroup/del --data '[
492,
377
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 39,
"message": "success",
"data": true
}33.5. 获取指定型号下的点位组列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取指定型号下的点位组列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
modelId | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/pointGroup/listByModelId?modelId=780Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 组名称 | - |
└─typeId | int64 | 点位类型 | - |
└─typeName | string | 类型名称 | - |
└─modelName | string | 型号名称 | - |
└─modelId | int32 | 所属型号 | - |
└─signalIds | array | 点位信号列表 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 745,
"message": "success",
"data": [
{
"id": 50,
"section": [
{
}
],
"name": "浩轩.孙",
"typeId": 674,
"typeName": "浩轩.孙",
"modelName": "浩轩.孙",
"modelId": 194,
"signalIds": [
"qk06uv"
],
"createTime": "2023-06-10"
}
]
}34. <p>串口设备管理</p>
34.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 设备名称 | false | - |
└─com | string | 串口 | false | - |
└─baudRate | int32 | 波特率 | false | - |
└─dataBits | int32 | 数据位 | false | - |
└─parity | int32 | 校验位 | false | - |
└─stopBits | int32 | 停止位 | false | - |
└─status | enum | 状态 | false | - |
└─createTime | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 设备名称 | false | - |
└─com | string | 串口 | false | - |
└─baudRate | int32 | 波特率 | false | - |
└─dataBits | int32 | 数据位 | false | - |
└─parity | int32 | 校验位 | false | - |
└─stopBits | int32 | 停止位 | false | - |
└─status | enum | 状态 | false | - |
└─createTime | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 设备名称 | false | - |
com | string | 串口 | false | - |
baudRate | int32 | 波特率 | false | - |
dataBits | int32 | 数据位 | false | - |
parity | int32 | 校验位 | false | - |
stopBits | int32 | 停止位 | false | - |
status | enum | 状态 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/serial/view?baudRate=285&orders[0].name=浩轩.孙&orders[0].parity=748&id=556&com=u10dtl&parity=781&dataBits=80&isSearchCount=true&status=open&records[0].dataBits=987&optimizeCountSql=true&orders[0].createTime=2023-06-10&records[0].parity=69&records[0].status=open&stopBits=707&pages=802&total=432&size=162&records[0].com=zqcdvp¤t=794&hitCount=true&orders[0].stopBits=756&orders[0].baudRate=120&records[0].createTime=2023-06-10&createTime=2023-06-10&orders[0].com=ixdjdl&orders[0].id=260&records[0].name=浩轩.孙&records[0].baudRate=996&searchCount=true&maxLimit=52&orders[0].dataBits=240&name=浩轩.孙&records[0].id=222&orders[0].status=open&countId=197&records[0].stopBits=378Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 42,
"message": "success",
"data": {
"size": 129,
"total": 472,
"pages": 989,
"current": 535,
"records": [
{
"id": 539,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "bljuqo",
"baudRate": 352,
"dataBits": 997,
"parity": 57,
"stopBits": 927,
"status": "open",
"createTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}34.2. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 设备名称 | false | - |
com | string | 串口 | false | - |
baudRate | int32 | 波特率 | false | - |
dataBits | int32 | 数据位 | false | - |
parity | int32 | 校验位 | false | - |
stopBits | int32 | 停止位 | false | - |
status | enum | 状态 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/serial/list?parity=793&baudRate=908&createTime=2023-06-10&com=ame14k&status=open&name=浩轩.孙&stopBits=620&id=700&dataBits=265Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 287,
"message": "success",
"data": [
{
"id": 293,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "wh4s7d",
"baudRate": 419,
"dataBits": 159,
"parity": 240,
"stopBits": 581,
"status": "open",
"createTime": "2023-06-10"
}
]
}34.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/serial/edit?id=94Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 251,
"message": "success",
"data": {
"id": 379,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "b4xacb",
"baudRate": 578,
"dataBits": 838,
"parity": 960,
"stopBits": 470,
"status": "open",
"createTime": "2023-06-10"
}
}34.4. 获取记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
com | string | 串口 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/serial/getByCom?com=uau0g3Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 708,
"message": "success",
"data": {
"id": 828,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "0b03pj",
"baudRate": 985,
"dataBits": 611,
"parity": 825,
"stopBits": 161,
"status": "open",
"createTime": "2023-06-10"
}
}34.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 设备名称 | false | - |
com | string | 串口 | false | - |
baudRate | int32 | 波特率 | false | - |
dataBits | int32 | 数据位 | false | - |
parity | int32 | 校验位 | false | - |
stopBits | int32 | 停止位 | false | - |
status | enum | 状态 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/serial/saveOrUpdate --data '{
"id": 2,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "lsi8is",
"baudRate": 191,
"dataBits": 306,
"parity": 260,
"stopBits": 233,
"status": "open",
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 603,
"message": "success",
"data": true
}34.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/serial/del --data '[
347,
456
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 115,
"message": "success",
"data": true
}34.7. 可用的串口列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 可用的串口列表
Request-example:
curl -X GET -i http://127.0.0.1/iot/serial/availableResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
Response-example:
{
"code": 521,
"message": "success",
"data": [
{
"label": "jws2zx",
"value": "2fxwlv"
}
]
}34.8.
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description:
Path-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
status | enum | open | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 设备名称 | false | - |
com | string | 串口 | false | - |
baudRate | int32 | 波特率 | false | - |
dataBits | int32 | 数据位 | false | - |
parity | int32 | 校验位 | false | - |
stopBits | int32 | 停止位 | false | - |
status | enum | 状态 | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/serial/connect/open --data '{
"id": 308,
"section": [
{
}
],
"name": "浩轩.孙",
"com": "hd7kwa",
"baudRate": 198,
"dataBits": 292,
"parity": 177,
"stopBits": 245,
"status": "open",
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 864,
"message": "success",
"data": true
}35. <p>寄存器点位管理</p>
35.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 列表查询
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
└─id | int64 | No comments found. | false | - |
└─section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
└─name | string | 点位名称 | false | - |
└─address | string | 点位地址 | false | - |
└─typeId | int64 | 设备类型 | false | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
└─num | int32 | 读取的寄存器(点位)数量 | false | - |
└─message | string | 自定义报文 | false | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
└─modelId | int32 | 型号id | false | - |
└─fieldName | string | 点位字段名称 | false | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
└─createTime | string | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 点位名称 | false | - |
address | string | 点位地址 | false | - |
typeId | int64 | 设备类型 | false | - |
type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
num | int32 | 读取的寄存器(点位)数量 | false | - |
message | string | 自定义报文 | false | - |
encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
modelId | int32 | 型号id | false | - |
fieldName | string | 点位字段名称 | false | - |
fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/signal/view?records[0].encode=63387&countId=197&address=高街4888号， 咸阳， 陕 053436&hitCount=true&type=498&orders[0].fieldName=浩轩.孙&records[0].typeId=299&createTime=2023-06-10&orders[0].address=高街4888号， 咸阳， 陕 053436&message=success&orders[0].createTime=2023-06-10&records[0].num=461&records[0].modelId=463&fieldType=150&pages=849&records[0].id=249&num=269&modelId=169&records[0].name=浩轩.孙&orders[0].encode=63387&orders[0].num=5&encode=63387&typeId=598&orders[0].id=369&orders[0].name=浩轩.孙&isSearchCount=true&orders[0].modelId=272&id=218&records[0].fieldType=733&orders[0].typeId=80&orders[0].type=821&fieldName=浩轩.孙&searchCount=true&maxLimit=651&size=809&records[0].address=高街4888号， 咸阳， 陕 053436&optimizeCountSql=true&records[0].message=success&orders[0].fieldType=961&name=浩轩.孙&total=413&records[0].type=822&records[0].createTime=2023-06-10&orders[0].message=success¤t=119&records[0].fieldName=浩轩.孙Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 13,
"message": "success",
"data": {
"size": 937,
"total": 219,
"pages": 908,
"current": 918,
"records": [
{
"id": 69,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 571,
"type": 582,
"num": 29,
"message": "success",
"encode": "63387",
"modelId": 5,
"fieldName": "浩轩.孙",
"fieldType": 146,
"createTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true
}
}35.2. 获取指定型号下面的点位列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取指定型号下面的点位列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
modelId | int32 | 型号id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/signal/listByModel?modelId=431Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | string | No comments found. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 点位字段名称 | - |
Response-example:
{
"code": 489,
"message": "success",
"data": [
{
"id": "197",
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"fieldName": "浩轩.孙"
}
]
}35.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | 记录id | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/iot/signal/edit?id=602Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─typeId | int64 | 设备类型 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器(点位)数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─modelId | int32 | 型号id | - |
└─fieldName | string | 点位字段名称 | - |
└─fieldType | int32 | 字段类型(字典 iot_field_type) | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 993,
"message": "success",
"data": {
"id": 739,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 197,
"type": 565,
"num": 191,
"message": "success",
"encode": "63387",
"modelId": 417,
"fieldName": "浩轩.孙",
"fieldType": 461,
"createTime": "2023-06-10"
}
}35.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 点位名称 | false | - |
address | string | 点位地址 | false | - |
typeId | int64 | 设备类型 | false | - |
type | int32 | 信号类型(1. 点位 2. 自定义报文) | false | - |
num | int32 | 读取的寄存器(点位)数量 | false | - |
message | string | 自定义报文 | false | - |
encode | string | 报文编码(HEX, UTF8, ASCII) | false | - |
modelId | int32 | 型号id | false | - |
fieldName | string | 点位字段名称 | false | - |
fieldType | int32 | 字段类型(字典 iot_field_type) | false | - |
createTime | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/signal/saveOrUpdate --data '{
"id": 31,
"section": [
{
}
],
"name": "浩轩.孙",
"address": "高街4888号， 咸阳， 陕 053436",
"typeId": 94,
"type": 422,
"num": 678,
"message": "success",
"encode": "63387",
"modelId": 981,
"fieldName": "浩轩.孙",
"fieldType": 155,
"createTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 215,
"message": "success",
"data": true
}35.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json; charset=utf-8
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
idList | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/iot/signal/del --data '[
166,
308
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 984,
"message": "success",
"data": true
}36.
36.1. 获取定时任务列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取定时任务列表
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
size | int64 | No comments found. | false | - |
total | int64 | No comments found. | false | - |
pages | int64 | No comments found. | false | - |
current | int64 | No comments found. | false | - |
records | array | No comments found. | false | - |
searchCount | boolean | No comments found. | false | - |
orders | array | No comments found. | false | - |
countId | string | No comments found. | false | - |
maxLimit | int64 | No comments found. | false | - |
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 作业名称 | false | - |
cron | string | cron表达式 | false | - |
status | string | 作业状态 | false | - |
remark | string | 作业备注 | false | - |
method | string | 执行的方法: spring的bean名+method e.g: task.test | false | - |
params | string | 执行参数 | false | - |
jobName | string | 作业名称 | false | - |
concurrent | boolean | 是否并发 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/quartz/task/view?concurrent=true&createTime=2023-06-10&remark=kekakv&pages=262&hitCount=true&status=e4hmax&maxLimit=305&method=4kmwmt&size=621¤t=440&searchCount=true&id=129&optimizeCountSql=true&name=浩轩.孙&cron=gvf5n2¶ms=j9pn6o&jobName=浩轩.孙&updateTime=2023-06-10&total=384&isSearchCount=true&countId=197Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | No comments found. | - |
message | string | No comments found. | - |
data | object | No comments found. | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─pages | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 作业名称 | - |
└─cron | string | cron表达式 | - |
└─status | string | 作业状态 | - |
└─remark | string | 作业备注 | - |
└─method | string | 执行的方法: spring的bean名+method e.g: task.test | - |
└─params | string | 执行参数 | - |
└─jobName | string | 作业名称 | - |
└─concurrent | boolean | 是否并发 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─searchCount | boolean | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
└─orders | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 作业名称 | - |
└─cron | string | cron表达式 | - |
└─status | string | 作业状态 | - |
└─remark | string | 作业备注 | - |
└─method | string | 执行的方法: spring的bean名+method e.g: task.test | - |
└─params | string | 执行参数 | - |
└─jobName | string | 作业名称 | - |
└─concurrent | boolean | 是否并发 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─optimizeCountSql | boolean | No comments found. | - |
└─isSearchCount | boolean | No comments found. | - |
└─countId | string | No comments found. | - |
└─maxLimit | int64 | No comments found. | - |
Response-example:
{
"code": 800,
"message": "success",
"data": {
"size": 42,
"total": 172,
"pages": 738,
"current": 139,
"records": [
{
"id": 400,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "nzzg0c",
"status": "be2qmq",
"remark": "n96q1b",
"method": "kbgy2t",
"params": "rw4tw4",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"searchCount": true,
"hitCount": true,
"orders": [
{
"id": 818,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "wqpx9r",
"status": "hlmowm",
"remark": "z4v75q",
"method": "kc3zkj",
"params": "kb1fc1",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
],
"optimizeCountSql": true,
"isSearchCount": true,
"countId": "197",
"maxLimit": 547
}
}36.2. 获取定时任务详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取定时任务详情
Query-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
Request-example:
curl -X GET -i http://127.0.0.1/quartz/task/detail?id=314Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | No comments found. | - |
message | string | No comments found. | - |
data | object | No comments found. | - |
└─id | int64 | No comments found. | - |
└─section | array | No comments found. | - |
└─any object | object | any object. | - |
└─name | string | 作业名称 | - |
└─cron | string | cron表达式 | - |
└─status | string | 作业状态 | - |
└─remark | string | 作业备注 | - |
└─method | string | 执行的方法: spring的bean名+method e.g: task.test | - |
└─params | string | 执行参数 | - |
└─jobName | string | 作业名称 | - |
└─concurrent | boolean | 是否并发 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 616,
"message": "success",
"data": {
"id": 78,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "i7apj5",
"status": "227wrx",
"remark": "7ml9be",
"method": "os4goi",
"params": "swi2p2",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}
}36.3. 新增或者修改定时任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 新增或者修改定时任务
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 作业名称 | false | - |
cron | string | cron表达式 | false | - |
status | string | 作业状态 | false | - |
remark | string | 作业备注 | false | - |
method | string | 执行的方法: spring的bean名+method e.g: task.test | false | - |
params | string | 执行参数 | false | - |
jobName | string | 作业名称 | false | - |
concurrent | boolean | 是否并发 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/quartz/task/addOrUpdate --data '{
"id": 105,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "wrgq8g",
"status": "amgurb",
"remark": "5iqun9",
"method": "6v1r0f",
"params": "caitoi",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | No comments found. | - |
message | string | No comments found. | - |
data | object | No comments found. | - |
Response-example:
{
"code": 649,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}36.4. 删除定时任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 删除定时任务
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
ids | array | No comments found.,[array of int64] | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/quartz/task/del --data '[
69,
896
]'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | No comments found. | - |
message | string | No comments found. | - |
data | object | No comments found. | - |
Response-example:
{
"code": 748,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}36.5. 修改状态
Type: POST
Content-Type: application/json; charset=utf-8
Description: 修改状态
Path-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
status | string | 状态 | true | - |
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 作业名称 | false | - |
cron | string | cron表达式 | false | - |
status | string | 作业状态 | false | - |
remark | string | 作业备注 | false | - |
method | string | 执行的方法: spring的bean名+method e.g: task.test | false | - |
params | string | 执行参数 | false | - |
jobName | string | 作业名称 | false | - |
concurrent | boolean | 是否并发 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/quartz/task/status/mjt5wa --data '{
"id": 857,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "utvizi",
"status": "tn11y7",
"remark": "g52oi9",
"method": "rp2g5u",
"params": "zpte2s",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 902,
"message": "success",
"data": {
}
}36.6. 运行一次
Type: POST
Content-Type: application/json; charset=utf-8
Description: 运行一次
Body-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
id | int64 | No comments found. | false | - |
section | array | No comments found. | false | - |
└─any object | object | any object. | false | - |
name | string | 作业名称 | false | - |
cron | string | cron表达式 | false | - |
status | string | 作业状态 | false | - |
remark | string | 作业备注 | false | - |
method | string | 执行的方法: spring的bean名+method e.g: task.test | false | - |
params | string | 执行参数 | false | - |
jobName | string | 作业名称 | false | - |
concurrent | boolean | 是否并发 | false | - |
createTime | string | 创建时间 | false | - |
updateTime | string | 更新时间 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1/quartz/task/once --data '{
"id": 110,
"section": [
{
}
],
"name": "浩轩.孙",
"cron": "ixdjb0",
"status": "yfjxi2",
"remark": "zvbtvm",
"method": "gp6za2",
"params": "80sdu8",
"jobName": "浩轩.孙",
"concurrent": true,
"createTime": "2023-06-10",
"updateTime": "2023-06-10"
}'Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 669,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}36.7. 可执行方法列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 可执行方法列表
Request-example:
curl -X GET -i http://127.0.0.1/quartz/task/taskMethodsResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
- | object | Return object. | - |
Response-example:
{
"code": 593,
"message": "success",
"data": [
{
"mapKey1": "l6yl3n",
"mapKey2": "12mzar"
}
]
}