sx/map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新样式

Browse Source
This commit is contained in:
谷成伟 2024-06-18 09:06:19 +08:00
parent 5da0d84f32
commit d76fbc980c
1 changed files with 185 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

370
docs/api/api_list.md
View File

@ -2,10 +2,10 @@
请求报文，Header中需要添加参数 请求报文，Header中需要添加参数
| 参数名称 | 说明 | | | 参数名称 | 说明 | |
| -------- | -------- | ---- | | -------- | -------- | --- |
| Token | 令牌 | | | Token | 令牌 | |
| V | 加密向量 | | | V | 加密向量 | |
@ -23,14 +23,14 @@
使用用户名和密码登录系统，POST请求 使用用户名和密码登录系统，POST请求
api/auth/invoke > /api/auth/invoke
入参示例 入参示例
``` ```json
{ {
"userName":"xx", "userName":"xx",
"password":"xxx" "password":"xxx"
} }
``` ```
@ -68,14 +68,14 @@ api/auth/invoke
注销令牌退出登录，POST请求 注销令牌退出登录，POST请求
api/auth/revoke > /api/auth/revoke
入参示例 入参示例
``` ```json
{ {
"userName":"xx", "userName":"xx",
"token":"xxx" "token":"xxx"
} }
``` ```
@ -397,11 +397,11 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------------------------------------------- | | :------- | :------: | :---: | :------------------------------------------------- |
| userName | String | Yes | 模糊查询职员名称，当职员名称为空时查询所有职员信息 | | userName | String | Yes | 模糊查询职员名称，当职员名称为空时查询所有职员信息 |
| orgId | BIGINT | Yes | 所属机构ID | | orgId | BIGINT | Yes | 所属机构ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -597,11 +597,11 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :--------- | :------: | :--: | :----------- | | :--------- | :------: | :---: | :----------- |
| modelName | String | Yes | 模型名称 | | modelName | String | Yes | 模型名称 |
| objectType | INT | Yes | 设备类型编码 | | objectType | INT | Yes | 设备类型编码 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -756,11 +756,11 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------- | :------: | :--: | :----------- | | :------------- | :------: | :---: | :----------- |
| iotModelId | BIGINT | yes | 所属物模型ID | | iotModelId | BIGINT | yes | 所属物模型ID |
| attribute_name | String | yes | 属性名称 | | attribute_name | String | yes | 属性名称 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -928,10 +928,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------ | :------: | :--: | :----------- | | :------ | :------: | :---: | :----------- |
| modelId | String | no | 所属物模型ID | | modelId | String | no | 所属物模型ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1108,10 +1108,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :------- | | :----- | :------: | :---: | :------- |
| name | String | YES | 设备名称 | | name | String | YES | 设备名称 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1345,10 +1345,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :------: | :--: | :----------------------------- | | :------------ | :------: | :---: | :----------------------------- |
| authorityName | String | yes | 权限名称为空时查询所有系统角色 | | authorityName | String | yes | 权限名称为空时查询所有系统角色 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1396,11 +1396,11 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :------: | :--: | :------- | | :------------ | :------: | :---: | :------- |
| authorityCode | String | NO | 权限编码 | | authorityCode | String | NO | 权限编码 |
| authorityName | String | NO | 权限名称 | | authorityName | String | NO | 权限名称 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1429,10 +1429,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1501,10 +1501,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :----------------------------- | | :------- | :------: | :---: | :----------------------------- |
| roleName | String | YES | 系统角色为空时查询所有系统角色 | | roleName | String | YES | 系统角色为空时查询所有系统角色 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1549,10 +1549,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :--------- | | :----- | :------: | :---: | :--------- |
| id | BIGINT | NO | 系统角色id | | id | BIGINT | NO | 系统角色id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1584,13 +1584,13 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :----------: | :--: | :----------- | | :------------ | :----------: | :---: | :----------- |
| id | BIGINT | no | 系统角色id | | id | BIGINT | no | 系统角色id |
| roleCode | String | no | 角色编码 | | roleCode | String | no | 角色编码 |
| roleName | String | no | 角色名称 | | roleName | String | no | 角色名称 |
| authorityList | List<String> | yes | 角色的权限id | | authorityList | List<String> | yes | 角色的权限id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1619,10 +1619,10 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :--------- | | :----- | :------: | :---: | :--------- |
| id | BIGINT | NO | 系统角色id | | id | BIGINT | NO | 系统角色id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1664,13 +1664,13 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :----------: | :--: | :----------- | | :------------ | :----------: | :---: | :----------- |
| id | BIGINT | no | 系统角色id | | id | BIGINT | no | 系统角色id |
| roleCode | String | no | 角色编码 | | roleCode | String | no | 角色编码 |
| roleName | String | no | 角色名称 | | roleName | String | no | 角色名称 |
| authorityList | List<String> | yes | 角色的权限id | | authorityList | List<String> | yes | 角色的权限id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1701,12 +1701,12 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :----------: | :--: | :----------- | | :------------ | :----------: | :---: | :----------- |
| id | BIGINT | no | 系统角色id | | id | BIGINT | no | 系统角色id |
| roleName | String | no | 角色名称 | | roleName | String | no | 角色名称 |
| authorityList | List<String> | yes | 角色的权限id | | authorityList | List<String> | yes | 角色的权限id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1738,11 +1738,11 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----------- | :------: | :--: | :--------------------------------- | | :----------- | :------: | :---: | :--------------------------------- |
| menuName | String | yes | 系统菜单名称为空时查询所有系统角色 | | menuName | String | yes | 系统菜单名称为空时查询所有系统角色 |
| parentMenuId | BIGINT | yes | 上级菜单ID | | parentMenuId | BIGINT | yes | 上级菜单ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1843,10 +1843,10 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :----- | | :----- | :------: | :---: | :----- |
| id | String | no | 菜单id | | id | String | no | 菜单id |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1949,11 +1949,11 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :---------- | :------: | :--: | :--------- | | :---------- | :------: | :---: | :--------- |
| linkId | BIGINT | no | 对应链路ID | | linkId | BIGINT | no | 对应链路ID |
| equipmentId | BIGINT | no | 对应设备ID | | equipmentId | BIGINT | no | 对应设备ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -1978,15 +1978,15 @@ api/user/addSysRole
} }
``` ```
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----------------- | :------: | :--: | :----------- | | :----------------- | :------: | :---: | :----------- |
| id | BIGINT | no | 主键 | | id | BIGINT | no | 主键 |
| linkId | BIGINT | no | 对应链路ID | | linkId | BIGINT | no | 对应链路ID |
| equipmentId | BIGINT | no | 对应设备ID | | equipmentId | BIGINT | no | 对应设备ID |
| equipmentAttribute | String | no | 备属性 | | equipmentAttribute | String | no | 备属性 |
| equipmentService | String | no | 对应设备服务 | | equipmentService | String | no | 对应设备服务 |
| porder | INT | no | 测点序号 | | porder | INT | no | 测点序号 |
| params | TEXT | no | 参数 | | params | TEXT | no | 参数 |
### 链路映射新增 ### 链路映射新增
@ -2012,15 +2012,15 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----------------- | :------: | :--: | :----------- | | :----------------- | :------: | :---: | :----------- |
| linkId | BIGINT | no | 对应链路ID | | linkId | BIGINT | no | 对应链路ID |
| equipmentId | BIGINT | no | 对应设备ID | | equipmentId | BIGINT | no | 对应设备ID |
| equipmentAttribute | String | no | 备属性 | | equipmentAttribute | String | no | 备属性 |
| equipmentService | String | no | 对应设备服务 | | equipmentService | String | no | 对应设备服务 |
| porder | INT | no | 测点序号 | | porder | INT | no | 测点序号 |
| params | TEXT | no | 参数 | | params | TEXT | no | 参数 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2056,15 +2056,15 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----------------- | :------: | :--: | :----------- | | :----------------- | :------: | :---: | :----------- |
| linkId | BIGINT | NO | 对应链路ID | | linkId | BIGINT | NO | 对应链路ID |
| equipmentId | BIGINT | NO | 对应设备ID | | equipmentId | BIGINT | NO | 对应设备ID |
| equipmentAttribute | String | NO | 备属性 | | equipmentAttribute | String | NO | 备属性 |
| equipmentService | String | NO | 对应设备服务 | | equipmentService | String | NO | 对应设备服务 |
| porder | INT | NO | 测点序号 | | porder | INT | NO | 测点序号 |
| params | TEXT | NO | 参数 | | params | TEXT | NO | 参数 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2095,10 +2095,10 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2130,11 +2130,11 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| linkName | STRING | NO | 链路名称 | | linkName | STRING | NO | 链路名称 |
| nodeId | BIGINT | NO | 所属系统节点ID | | nodeId | BIGINT | NO | 所属系统节点ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2157,13 +2157,13 @@ api/user/addSysRole
} }
``` ```
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| id | VARCHAR | NO | 链路主键 | | id | VARCHAR | NO | 链路主键 |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
| params | TEXT | NO | 协议参数 | | params | TEXT | NO | 协议参数 |
| nodeId | BIGINT | NO | 所属系统节点ID | | nodeId | BIGINT | NO | 所属系统节点ID |
### 通讯链路新增 ### 通讯链路新增
@ -2186,13 +2186,13 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
| params | TEXT | NO | 协议参数 | | params | TEXT | NO | 协议参数 |
| nodeId | BIGINT | NO | 所属系统节点ID | | nodeId | BIGINT | NO | 所属系统节点ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2226,14 +2226,14 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| id | VARCHAR | NO | 链路主键 | | id | VARCHAR | NO | 链路主键 |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
| params | TEXT | NO | 协议参数 | | params | TEXT | NO | 协议参数 |
| nodeId | BIGINT | NO | 所属系统节点ID | | nodeId | BIGINT | NO | 所属系统节点ID |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2264,10 +2264,10 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2300,12 +2300,12 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------- | | :------- | :------: | :---: | :------- |
| nodeName | STRING | YES | 节点名称 | | nodeName | STRING | YES | 节点名称 |
| nodeIp | STRING | YES | 节点IP | | nodeIp | STRING | YES | 节点IP |
| orgId | BIGINT | YES | 所属机构 | | orgId | BIGINT | YES | 所属机构 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2327,12 +2327,12 @@ api/user/addSysRole
} }
``` ```
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :--------- | | :------- | :------: | :---: | :--------- |
| id | BIGINT | no | 系统节点ID | | id | BIGINT | no | 系统节点ID |
| nodeName | STRING | no | 节点名称 | | nodeName | STRING | no | 节点名称 |
| nodeIp | STRING | no | 节点IP | | nodeIp | STRING | no | 节点IP |
| orgId | BIGINT | no | 所属机构 | | orgId | BIGINT | no | 所属机构 |
### 系统节点新增 ### 系统节点新增
@ -2353,12 +2353,12 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------- | | :------- | :------: | :---: | :------- |
| nodeName | STRING | NO | 节点名称 | | nodeName | STRING | NO | 节点名称 |
| nodeIp | STRING | NO | 节点IP | | nodeIp | STRING | NO | 节点IP |
| orgId | BIGINT | NO | 所属机构 | | orgId | BIGINT | NO | 所属机构 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2391,13 +2391,13 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :--------- | | :------- | :------: | :---: | :--------- |
| id | BIGINT | NO | 系统节点ID | | id | BIGINT | NO | 系统节点ID |
| nodeName | STRING | NO | 节点名称 | | nodeName | STRING | NO | 节点名称 |
| nodeIp | STRING | NO | 节点IP | | nodeIp | STRING | NO | 节点IP |
| orgId | BIGINT | NO | 所属机构 | | orgId | BIGINT | NO | 所属机构 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例
@ -2428,10 +2428,10 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
调用成功返回示例 调用成功返回示例