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

72
docs/api/api_list.md
View File

@ -3,7 +3,7 @@
请求报文，Header中需要添加参数 请求报文，Header中需要添加参数
| 参数名称 | 说明 | | | 参数名称 | 说明 | |
| -------- | -------- | ---- | | -------- | -------- | --- |
| Token | 令牌 | | | Token | 令牌 | |
| V | 加密向量 | | | V | 加密向量 | |
@ -23,11 +23,11 @@
使用用户名和密码登录系统，POST请求 使用用户名和密码登录系统，POST请求
api/auth/invoke > /api/auth/invoke
入参示例 入参示例
``` ```json
{ {
"userName":"xx", "userName":"xx",
"password":"xxx" "password":"xxx"
@ -68,11 +68,11 @@ api/auth/invoke
注销令牌退出登录，POST请求 注销令牌退出登录，POST请求
api/auth/revoke > /api/auth/revoke
入参示例 入参示例
``` ```json
{ {
"userName":"xx", "userName":"xx",
"token":"xxx" "token":"xxx"
@ -398,7 +398,7 @@ 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 |
@ -598,7 +598,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :--------- | :------: | :--: | :----------- | | :--------- | :------: | :---: | :----------- |
| modelName | String | Yes | 模型名称 | | modelName | String | Yes | 模型名称 |
| objectType | INT | Yes | 设备类型编码 | | objectType | INT | Yes | 设备类型编码 |
| token | String | NO | token | | token | String | NO | token |
@ -757,7 +757,7 @@ 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 |
@ -929,7 +929,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------ | :------: | :--: | :----------- | | :------ | :------: | :---: | :----------- |
| modelId | String | no | 所属物模型ID | | modelId | String | no | 所属物模型ID |
| token | String | NO | token | | token | String | NO | token |
@ -1109,7 +1109,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :------- | | :----- | :------: | :---: | :------- |
| name | String | YES | 设备名称 | | name | String | YES | 设备名称 |
| token | String | NO | token | | token | String | NO | token |
@ -1346,7 +1346,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :------: | :--: | :----------------------------- | | :------------ | :------: | :---: | :----------------------------- |
| authorityName | String | yes | 权限名称为空时查询所有系统角色 | | authorityName | String | yes | 权限名称为空时查询所有系统角色 |
| token | String | NO | token | | token | String | NO | token |
@ -1397,7 +1397,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :------: | :--: | :------- | | :------------ | :------: | :---: | :------- |
| authorityCode | String | NO | 权限编码 | | authorityCode | String | NO | 权限编码 |
| authorityName | String | NO | 权限名称 | | authorityName | String | NO | 权限名称 |
| token | String | NO | token | | token | String | NO | token |
@ -1430,7 +1430,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
@ -1502,7 +1502,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :----------------------------- | | :------- | :------: | :---: | :----------------------------- |
| roleName | String | YES | 系统角色为空时查询所有系统角色 | | roleName | String | YES | 系统角色为空时查询所有系统角色 |
| token | String | NO | token | | token | String | NO | token |
@ -1550,7 +1550,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :--------- | | :----- | :------: | :---: | :--------- |
| id | BIGINT | NO | 系统角色id | | id | BIGINT | NO | 系统角色id |
| token | String | NO | token | | token | String | NO | token |
@ -1585,7 +1585,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :----------: | :--: | :----------- | | :------------ | :----------: | :---: | :----------- |
| id | BIGINT | no | 系统角色id | | id | BIGINT | no | 系统角色id |
| roleCode | String | no | 角色编码 | | roleCode | String | no | 角色编码 |
| roleName | String | no | 角色名称 | | roleName | String | no | 角色名称 |
@ -1620,7 +1620,7 @@ api/auth/password/change
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :--------- | | :----- | :------: | :---: | :--------- |
| id | BIGINT | NO | 系统角色id | | id | BIGINT | NO | 系统角色id |
| token | String | NO | token | | token | String | NO | token |
@ -1665,7 +1665,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------------ | :----------: | :--: | :----------- | | :------------ | :----------: | :---: | :----------- |
| id | BIGINT | no | 系统角色id | | id | BIGINT | no | 系统角色id |
| roleCode | String | no | 角色编码 | | roleCode | String | no | 角色编码 |
| roleName | String | no | 角色名称 | | roleName | String | no | 角色名称 |
@ -1702,7 +1702,7 @@ 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 |
@ -1739,7 +1739,7 @@ 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 |
@ -1844,7 +1844,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :----- | | :----- | :------: | :---: | :----- |
| id | String | no | 菜单id | | id | String | no | 菜单id |
| token | String | NO | token | | token | String | NO | token |
@ -1950,7 +1950,7 @@ 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 |
@ -1979,7 +1979,7 @@ 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 |
@ -2013,7 +2013,7 @@ 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 | 备属性 |
@ -2057,7 +2057,7 @@ 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 | 备属性 |
@ -2096,7 +2096,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
@ -2131,7 +2131,7 @@ 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 |
@ -2158,7 +2158,7 @@ api/user/addSysRole
``` ```
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| id | VARCHAR | NO | 链路主键 | | id | VARCHAR | NO | 链路主键 |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
@ -2187,7 +2187,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
| params | TEXT | NO | 协议参数 | | params | TEXT | NO | 协议参数 |
@ -2227,7 +2227,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------------- | | :------- | :------: | :---: | :------------- |
| id | VARCHAR | NO | 链路主键 | | id | VARCHAR | NO | 链路主键 |
| linkName | BIGINT | NO | 链路名称 | | linkName | BIGINT | NO | 链路名称 |
| protocol | INT | NO | 通讯协议 | | protocol | INT | NO | 通讯协议 |
@ -2265,7 +2265,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |
@ -2301,7 +2301,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------- | | :------- | :------: | :---: | :------- |
| nodeName | STRING | YES | 节点名称 | | nodeName | STRING | YES | 节点名称 |
| nodeIp | STRING | YES | 节点IP | | nodeIp | STRING | YES | 节点IP |
| orgId | BIGINT | YES | 所属机构 | | orgId | BIGINT | YES | 所属机构 |
@ -2328,7 +2328,7 @@ 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 |
@ -2354,7 +2354,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :------- | :------: | :--: | :------- | | :------- | :------: | :---: | :------- |
| nodeName | STRING | NO | 节点名称 | | nodeName | STRING | NO | 节点名称 |
| nodeIp | STRING | NO | 节点IP | | nodeIp | STRING | NO | 节点IP |
| orgId | BIGINT | NO | 所属机构 | | orgId | BIGINT | NO | 所属机构 |
@ -2392,7 +2392,7 @@ 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 |
@ -2429,7 +2429,7 @@ api/user/addSysRole
入参描述 入参描述
| 参数名 | 参数类型 | 可选 | 描述 | | 参数名 | 参数类型 | 可选 | 描述 |
| :----- | :------: | :--: | :---- | | :----- | :------: | :---: | :---- |
| id | BIGINT | NO | 主键 | | id | BIGINT | NO | 主键 |
| token | String | NO | token | | token | String | NO | token |