From fbdfca18d069df3628d037cec0e7bf273381af4f Mon Sep 17 00:00:00 2001 From: houwei Date: Thu, 27 Jun 2024 09:31:38 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9api=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/api_list.md | 1374 +----------------------------------------- 1 file changed, 29 insertions(+), 1345 deletions(-) diff --git a/docs/api/api_list.md b/docs/api/api_list.md index ca2615e2..0fc9fe2c 100644 --- a/docs/api/api_list.md +++ b/docs/api/api_list.md @@ -19,9 +19,9 @@ 加密采用AES/CBC/ZeroPadding加密方式，密钥长度为16位。，IV长度为16位（每次请求时随机生成）。 -# 1、登录模块API接口 +# 权限模块 -## API接口一览表 +# API接口一览表 | 接口分类 | 接口描述 | API接口 | 权限 | |:-----:| :------- |:--------------------------|-----------------| @@ -29,6 +29,22 @@ | 系统登录 | 1.2、系统登录 | /api/auth/login | | | 系统登录 | 1.3、退出登录 | /api/auth/logout | | | 系统登录 | 1.4、修改密码 | /api/auth/password/change | | +| 菜单管理 | 2.1、新增菜单 | /api/menus/add | | +| 菜单管理 | 2.2、查询菜单 | /api/menus/query | | +| 菜单管理 | 2.3、更新菜单 | /api/menus/update | | +| 菜单管理 | 2.4、删除菜单 | /api/menus/delete | | +| 公司机构 | 3.1、公司机构查询 | /api/org/query | | +| 公司机构 | 3.2、添加机构信息 | /api/org/add | | +| 公司机构 | 3.3、修改机构信息 | /api/org/update | | +| 公司机构 | 3.4、删除指定机构 | /api/org/delete | | +| 职员操作 | 4.1、职员查询 | /api/user/query | | +| 职员操作 | 4.2、职员创建 | /api/user/add | | +| 职员操作 | 4.3、职员修改 | /api/user/update | | +| 职员操作 | 4.4、职员删除 | /api/user/delete | | +| 系统角色 | 5.1、系统角色查询 | /api/user/getSysRole | | +| 系统角色 | 5.2、系统角色删除 | /api/user/deleteSysRole | | +| 系统角色 | 5.3、系统角色新增 | /api/user/addSysRole | | +| 系统角色 | 5.4、角色权限查询 | /api/user/getAuthorityById | | ## 1.1、验证码获取 > /api/auth/captchaImage @@ -162,14 +178,6 @@ # 2、菜单管理 -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :------: | :------------ |:------------------| ---- | -| 菜单管理 | 2.1、新增菜单 | /api/menus/add | | -| 菜单管理 | 2.2、查询菜单 | /api/menus/query | | -| 菜单管理 | 2.3、更新菜单 | /api/menus/update | | -| 菜单管理 | 2.4、删除菜单 | /api/menus/delete | | ## 2.1、新增菜单 @@ -282,7 +290,7 @@ /api/menus/update ``` - + 入参定义 ```json { @@ -443,19 +451,10 @@ !> 下面的文档有待确认 -# 3、公司机构模块API接口 +# 3、公司机构 组织机构模块提供的API包括机构查询、添加、修改等功能。 -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :------: | :----------- |:----------------|----| -| 公司机构 | 公司机构查询 | /api/org/query | | -| 公司机构 | 添加机构信息 | /api/org/add | | -| 公司机构 | 修改机构信息 | /api/org/update | | -| 公司机构 | 删除指定机构 | /api/org/delete | | - ## 公司机构查询 提供获取所有机构信息的功能，POST方式 @@ -733,19 +732,10 @@ } ``` -# 4、职员模块API接口 +# 4、职员用户 职员模块提供的API包括职员查询、添加、修改等功能。 -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :------: | :------- |:-----------------|----| -| 职员操作 | 职员查询 | /api/user/query | | -| 职员操作 | 职员创建 | /api/user/add | | -| 职员操作 | 职员修改 | /api/user/update | | -| 职员操作 | 职员删除 | /api/user/delete | | - ## 职员查询 提供对职员信息的基本查询功能,POST方式。 @@ -936,22 +926,9 @@ } ``` -# 权限管理模块API接口 +# 5、角色维护 -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :----------: | :----------- | :---------------------------- | ---- | -| 系统权限操作 | 系统权限查询 | /api/user/getSysAuthoritys | | -| 系统角色操作 | 系统角色查询 | /api/user/getSysRole | | -| 系统角色操作 | 系统角色删除 | /api/user/deleteSysRole | | -| 系统角色操作 | 系统角色新增 | /api/user/addSysRole | | -| 系统角色操作 | 角色权限查询 | /api/user/getAuthorityById | | -| 系统角色操作 | 角色权限编辑 | /api/user/updateAuthorityById | | - -## 系统权限管理 - -### 系统权限查询 +## 系统权限查询 提供获取所有系统权限的功能，POST方式 @@ -999,11 +976,7 @@ | authorityCode | string | NO | 权限编码 | | authorityName | string | NO | 权限名称 | - - -## 角色维护 - -### 系统角色查询 +## 系统角色查询 提供获取所有系统角色的功能，POST方式 @@ -1049,7 +1022,7 @@ | roleCode | string | No | 角色编码 | | roleName | string | No | 角色名称 | -### 系统角色删除 +## 系统角色删除 根据提供的ID,删除系统角色，POST方式 @@ -1078,7 +1051,7 @@ } ``` -### 系统角色新增 +## 系统角色新增 根据添加的信息创建系统角色，POST方式 @@ -1120,7 +1093,7 @@ "msg": "操作成功" } ``` -### 所有权限查询 +## 所有权限查询 提供获取所有权限权限的功能，POST方式 /api/authority/query @@ -1167,12 +1140,9 @@ | authorityName | string | No | 权限名称 | +## 角色权限查询 - - -### 角色权限查询 - 提供获取所有角色权限的功能，POST方式 /api/role/queryAuthorityById @@ -1216,7 +1186,7 @@ | authorityName | string | No | 权限名称 | -### 角色权限编辑 +## 角色权限编辑 根据提供的ID,修改角色权限，POST方式 @@ -1250,1289 +1220,3 @@ } ``` -# 物模型模块API接口 - -物模型模块提供的API包括物模型查询、添加、修改等功能。 - -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :------------: | :------------- | :-------------------------------- | --------------- | -| 物模型定义操作 | 物模型定义查询 | /api/devicemgr/getModel | /XXXX/XXX/XXX/X | -| 物模型定义操作 | 物模型定义删除 | /api/devicemgr/deleteModel | | -| 物模型定义操作 | 物模型定义新增 | /api/devicemgr/addModel | | -| 物模型定义操作 | 物模型定义修改 | /api/devicemgr/updateModel | | -| 物模型属性操作 | 物模型属性查询 | /api/devicemgr/getModelFiled | | -| 物模型属性操作 | 物模型属性删除 | /api/devicemgr/deleteModelFiled | | -| 物模型属性操作 | 物模型属性新增 | /api/devicemgr/addModelFiled | | -| 物模型属性操作 | 物模型属性修改 | /api/devicemgr/updateModelFiled | | -| 物模型方法操作 | 物模型方法查询 | /api/devicemgr/getModelService | | -| 物模型方法操作 | 物模型方法删除 | /api/devicemgr/deleteModelService | | -| 物模型方法操作 | 物模型方法新增 | /api/devicemgr/addModelService | | -| 物模型方法操作 | 物模型方法修改 | /api/devicemgr/updateModelService | | - -## 物模型定义 - -### 物模型定义查询 - -提供获取所有物模型定义信息的功能，POST方式 - -/api/devicemgr/getModel - -入参示例 - -``` -{ -"modelName":"xx", -"objectType":"xx", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :--------- | :------: | :---: | :----------- | -| modelName | String | Yes | 模型名称 | -| objectType | INT | Yes | 设备类型编码 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data": [ - { - "object_type": "xxxx", - "id": "xxx", - "iotModelCode": "xxx", - "iotModelName": "xxx" - }, - { - ... - } - ] -} -``` - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------ | -------- | -------- | ------------ | -| object_type | INT | No | 设备类型编码 | -| id | BIGINT | NO | 模型ID | -| iotModelCode | String | No | 模型编码 | -| iotModelName | String | No | 模型名称 | - -### 物模型定义删除 - -根据提供的ID,删除物模型定义，POST方式 - -> /api/devicemgr/deleteModel - -入参示例 - -``` -{ -"id":"123", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------ | -------- | ---- | -------------- | -| id | BIGINT | No | 要删除的模型ID | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -### 物模型定义新增 - -根据添加的信息创建物模型定义，POST方式 - -/api/devicemgr/addModel - -入参示例 - -``` -{ - "object_type": "xxxx", - "iotModelCode": "xxx", - "iotModelName": "xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------ | -------- | -------- | ------------ | -| object_type | INT | NO | 设备类型编码 | -| iotModelCode | String | NO | 模型编码 | -| iotModelName | String | NO | 模型名 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 物模型定义修改 - -根据提供的ID,修改物模型定义，POST方式 - -/api/devicemgr/updateModel - -入参示例 - -``` -{ - "object_type": "xxxx", - "id": "xxx", - "iotModelCode": "xxx", - "iotModelName": "xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------ | -------- | -------- | ------------ | -| object_type | INT | No | 设备类型编码 | -| id | BIGINT | NO | 模型ID | -| iotModelCode | String | No | 模型编码 | -| iotModelName | String | No | 模型名称 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"修改成功", -"data":"null" -} -``` - -## 物模型属性 - -### 物模型属性查询 - -提供获取所有物模型属性的功能，POST方式 - -/api/devicemgr/getModelFiled - -入参示例 - -``` -{ -"iotModelId":"xxx", -"attribute_name":"XX", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------------- | :------: | :---: | :----------- | -| iotModelId | BIGINT | yes | 所属物模型ID | -| attribute_name | String | yes | 属性名称 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data":[ - { - "id": "xxxx", - "iotModelId": "xxx", - "attributeCode": "xxx", - "attributeName": "xxx", - "attributeType","xxx", - "porder":"xxx" - }, - { - ... - } - ] - -} -``` - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------- | -------- | -------- | ------------ | -| id | BIGINT | NO | 属性主键ID | -| iotModelId | BIGINT | NO | 所属物模型ID | -| attributeCode | String | NO | 属性编码 | -| attributeName | String | NO | 属性名称 | -| attributeType | INT | NO | 量测类型 | -| porder | INT | NO | 测点序号 | - -### 物模型属性删除 - -根据提供的ID,删除物模型属性，POST方式 - -> /api/devicemgr/deleteModelFiled - -入参示例 - -``` -{ - "id":"123", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------ | -------- | ---- | ------------------ | -| id | BIGINT | NO | 要删除的属性主键ID | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -### 物模型属性新增 - -根据添加的信息创建物模型属性，POST方式 - -/api/devicemgr/addModelFiled - -入参示例 - -``` -{ - - "iotModelId": "xxx", - "attributeCode": "xxx", - "attributeName": "xxx", - "attributeType","xxx", - "porder":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------- | -------- | -------- | ------------ | -| iotModelId | BIGINT | NO | 所属物模型ID | -| attributeCode | String | NO | 属性编码 | -| attributeName | String | NO | 属性名称 | -| attributeType | INT | NO | 量测类型 | -| porder | INT | NO | 测点序号 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 物模型属性修改 - -根据提供的ID,修改物模型属性，POST方式 - -/api/devicemgr/updateModelFiled - -入参示例 - -``` -{ - "id": "xxxx", - "iotModelId": "xxx", - "attributeCode": "xxx", - "attributeName": "xxx", - "attributeType","xxx", - "porder":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ------------- | -------- | -------- | ------------ | -| id | BIGINT | NO | 属性主键ID | -| iotModelId | BIGINT | NO | 所属物模型ID | -| attributeCode | String | NO | 属性编码 | -| attributeName | String | NO | 属性名称 | -| attributeType | INT | NO | 量测类型 | -| porder | INT | NO | 测点序号 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"修改成功", -"data":"null" -} -``` - -## 物模型方法 - -### 物模型方法查询 - -提供获取所有物模型方法的功能，POST方式 - -/api/devicemgr/getModelService - -入参示例 - -``` -{ - "modelId":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------ | :------: | :---: | :----------- | -| modelId | String | no | 所属物模型ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data": [ - { - "id": "xxxx", - "iotModelId": "xxx", - "serviceCode": "xxx", - "serviceName": "xxx", - "serviceType","xxx", - "porder":"xxx" - }, - { - ... - } - ] -} -``` - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ----------- | -------- | -------- | ------------ | -| id | BIGINT | NO | 属性主键ID | -| iotModelId | String | NO | 所属物模型ID | -| serviceCode | String | NO | 动作编码 | -| serviceName | String | NO | 动作名称 | -| serviceType | INT | NO | 量测类型 | -| porder | INT | NO | 测点序号 | - -### 物模型方法删除 - -根据提供的ID,删除物模型方法，POST方式 - -> /api/devicemgr/deleteModelService - -入参示例 - -``` -{ - "id":"123", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------ | -------- | ---- | ------------------ | -| id | BIGINT | No | 要删除的属性主键ID | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -### 物模型方法新增 - -根据添加的信息创建物模型方法，POST方式 - -/api/devicemgr/addModelService - -入参示例 - -``` -{ - "serviceCode": "xxx", - "serviceCode": "xxx", - "serviceName": "xxx", - "serviceType","xxx", - "porder":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ----------- | -------- | -------- | ------------ | -| iotModelId | Long | NO | 所属物模型ID | -| serviceCode | String | NO | 动作编码 | -| serviceName | String | NO | 动作名称 | -| serviceType | Long | NO | 量测类型 | -| porder | Long | NO | 测点序号 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 物模型方法修改 - -根据提供的ID,修改物模型方法，POST方式 - -/api/devicemgr/updateModelService - -入参示例 - -``` -{ - "id": "xxxx", - "iotModelId": "xxx", - "serviceCode": "xxx", - "serviceName": "xxx", - "serviceType","xxx", - "porder":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| ----------- | -------- | -------- | ------------ | -| id | BIGINT | NO | 属性主键ID | -| iotModelId | String | NO | 所属物模型ID | -| serviceCode | String | NO | 动作编码 | -| serviceName | String | NO | 动作名称 | -| serviceType | INT | NO | 量测类型 | -| porder | INT | NO | 测点序号 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"修改成功", -"data":"null" -} -``` - -# 设备基础属性模块API接口 - -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :--------------: | :--------------- | :------------------------------ | --------------- | -| 设备基础属性操作 | 设备基础属性查询 | /api/devicemgr/getEquipment | /XXXX/XXX/XXX/X | -| 设备基础属性操作 | 设备基础属性删除 | /api/devicemgr/deleteEquipment | | -| 设备基础属性操作 | 设备基础属性新增 | /api/devicemgr/updateModelFiled | | -| 设备基础属性操作 | 设备基础属性修改 | /api/devicemgr/updateModelFiled | | - -## 设备基础属性查询 - -提供获取所有设备基础属性的功能，POST方式 - -/api/devicemgr/getEquipment - -入参示例 - -``` -{ -"name":"xxx", -"parentEquipmentId":"XX", -"orgId":"XXX", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----- | :------: | :---: | :------- | -| name | String | YES | 设备名称 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data": [ - { - "id": "xxxx", - "objectType": "xxx", - "code": "xxx", - "name": "xxx", - "madeinfactory","xxx", - "model":"xxx", - "location","xxx", - "longitude":"xxx", - "latitude": "xxx", - "installDate": "xxx", - "remarks","xxx", - "orgId":"xxx", - "parentEquipmentId","xxx", - "iotModelId":"xxx" - }, - { - ... - } - ] -} -``` - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| :---------------- | :------- | :------- | :------------ | -| id | BIGINT | NO | 设备ID | -| objectType | INT | NO | 设备类型编码 | -| code | String | NO | 设备编码 | -| name | String | NO | 设备名称 | -| madeinfactory | String | NO | 制造商 | -| model | String | NO | 型号规格 | -| location | String | NO | 安装位置 | -| longitude | DECIMAL | NO | 安装位置_经度 | -| latitude | DECIMAL | NO | 安装位置_纬度 | -| installDate | DATETIME | NO | 安装日期 | -| remarks | String | NO | 备注 | -| orgId | BIGINT | NO | 设备所属机构 | -| parentEquipmentId | BIGINT | NO | 上级设备ID | -| iotModelId | BIGINT | NO | 对应物模型 | - -## 设备基础属性删除 - -根据提供的ID,删除设备基础属性，POST方式 - -> /api/devicemgr/deleteEquipment - -入参示例 - -``` -{ - "id":"123", - "token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| ------ | -------- | ---- | -------------- | -| id | BIGINT | NO | 要删除的设备ID | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -## 设备基础属性新增 - -根据添加的信息创建设备基础属性，POST方式 - -/api/devicemgr/addEquipment - -入参示例 - -``` -{ - "objectType": "xxx", - "code": "xxx", - "name": "xxx", - "madeinfactory","xxx", - "model":"xxx", - "location","xxx", - "longitude":"xxx", - "latitude": "xxx", - "installDate": "xxx", - "remarks","xxx", - "orgId":"xxx", - "parentEquipmentId","xxx", - "iotModelId":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| :---------------- | :------- | :------- | :------------ | -| objectType | INT | NO | 设备类型编码 | -| code | String | NO | 设备编码 | -| name | String | NO | 设备名称 | -| madeinfactory | String | NO | 制造商 | -| model | String | NO | 型号规格 | -| location | String | NO | 安装位置 | -| longitude | DECIMAL | NO | 安装位置_经度 | -| latitude | DECIMAL | NO | 安装位置_纬度 | -| installDate | DATETIME | NO | 安装日期 | -| remarks | String | NO | 备注 | -| orgId | BIGINT | NO | 设备所属机构 | -| parentEquipmentId | BIGINT | NO | 上级设备ID | -| iotModelId | BIGINT | NO | 对应物模型 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -## 设备基础属性修改 - -根据提供的ID,修改设备基础属性，POST方式 - -/api/devicemgr/updateModelFiled - -入参示例 - -``` -{ - "id":"xxx", - "objectType": "xxx", - "code": "xxx", - "name": "xxx", - "madeinfactory","xxx", - "model":"xxx", - "location","xxx", - "longitude":"xxx", - "latitude": "xxx", - "installDate": "xxx", - "remarks","xxx", - "orgId":"xxx", - "parentEquipmentId","xxx", - "iotModelId":"xxx", - "token":"xxx" -} -``` - -入参描述 - -| 变量名 | 变量类型 | 可为NULL | 描述 | -| :---------------- | :------- | :------- | :------------ | -| id | BIGINT | NO | 设备ID | -| objectType | INT | NO | 设备类型编码 | -| code | String | NO | 设备编码 | -| name | String | NO | 设备名称 | -| madeinfactory | String | NO | 制造商 | -| model | String | NO | 型号规格 | -| location | String | NO | 安装位置 | -| longitude | DECIMAL | NO | 安装位置_经度 | -| latitude | DECIMAL | NO | 安装位置_纬度 | -| installDate | DATETIME | NO | 安装日期 | -| remarks | String | NO | 备注 | -| orgId | BIGINT | NO | 设备所属机构 | -| parentEquipmentId | BIGINT | NO | 上级设备ID | -| iotModelId | BIGINT | NO | 对应物模型 | -| token | String | NO | token | - -调用成功返回示例 - -``` -{ -"code":"200", -"msg":"修改成功", -"data":"null" -} -``` - -# 链路模块API接口 - -## API接口一览表 - -| 接口分类 | 接口描述 | API接口 | 权限 | -| :----------: | :----------- | :---------------------------- | --------------- | -| 链路映射操作 | 链路映射查询 | /api/link/getImptabmapping | /XXXX/XXX/XXX/X | -| 链路映射操作 | 链路映射新增 | /api/link/addImptabmapping | | -| 链路映射操作 | 链路映射修改 | /api/link/updateImptabmapping | | -| 链路映射操作 | 链路映射删除 | /api/link/deleteImptabmapping | | -| 通讯链路操作 | 通讯链路查询 | /api/link/getCommun | | -| 通讯链路操作 | 通讯链路新增 | /api/link/addCommun | | -| 通讯链路操作 | 通讯链路修改 | /api/user/addSysRole | | -| 通讯链路操作 | 通讯链路删除 | /api/link/deleteICommun | | -| 系统节点操作 | 系统节点查询 | /api/link/getNode | | -| 系统节点操作 | 系统节点新增 | /api/link/addNode | | -| 系统节点操作 | 系统节点修改 | /api/link/updateNode | | -| 系统节点操作 | 系统节点删除 | /api/link/deleteINode | | - -## 链路映射 - -### 链路映射查询 - -提供获取所有链路映射的功能，POST方式 - -/api/link/getImptabmapping - -入参示例 - -``` -{ - -"linkId":"xxx", -"equipmentId":"xxx", -"token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :---------- | :------: | :---: | :--------- | -| linkId | BIGINT | no | 对应链路ID | -| equipmentId | BIGINT | no | 对应设备ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data":[ - { - "id":"xxx", - "linkId":"xxx", - "equipmentId":"xxx", - "equipmentAttribute":"xxx", - "equipmentService":"xxx", - "porder":"xxx", - "params":"xxx" - }, - { - ... - } - ] -} -``` - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----------------- | :------: | :---: | :----------- | -| id | BIGINT | no | 主键 | -| linkId | BIGINT | no | 对应链路ID | -| equipmentId | BIGINT | no | 对应设备ID | -| equipmentAttribute | String | no | 备属性 | -| equipmentService | String | no | 对应设备服务 | -| porder | INT | no | 测点序号 | -| params | TEXT | no | 参数 | - -### 链路映射新增 - -根据添加的信息创建链路映射，POST方式 - -/api/link/addImptabmapping - -入参示例 - -``` -{ - "id":"xxx", - "linkId":"xxx", - "equipmentId":"xxx", - "equipmentAttribute":"xxx", - "equipmentService":"xxx", - "porder":"xxx", - "params":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----------------- | :------: | :---: | :----------- | -| linkId | BIGINT | no | 对应链路ID | -| equipmentId | BIGINT | no | 对应设备ID | -| equipmentAttribute | String | no | 备属性 | -| equipmentService | String | no | 对应设备服务 | -| porder | INT | no | 测点序号 | -| params | TEXT | no | 参数 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 链路映射修改 - -根据提供的ID,修改链路映射，POST方式 - -/api/link/updateImptabmapping - -入参示例 - -``` -{ - "id":"xxx", - "linkId":"xxx", - "equipmentId":"xxx", - "equipmentAttribute":"xxx", - "equipmentService":"xxx", - "porder":"xxx", - "params":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----------------- | :------: | :---: | :----------- | -| linkId | BIGINT | NO | 对应链路ID | -| equipmentId | BIGINT | NO | 对应设备ID | -| equipmentAttribute | String | NO | 备属性 | -| equipmentService | String | NO | 对应设备服务 | -| porder | INT | NO | 测点序号 | -| params | TEXT | NO | 参数 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"编辑成功", -"data":"null" -} -``` - -### 链路映射删除 - -根据提供的ID,删除链路映射，POST方式 - -/api/link/deleteImptabmapping - -入参示例 - -``` -{ - - "id":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----- | :------: | :---: | :---- | -| id | BIGINT | NO | 主键 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -## 通讯链路 - -### 通讯链路查询 - -提供获取所有通讯链路的功能，POST方式 - -/api/link/getCommun - -入参示例 - -``` -{ -"linkName":"xxx" -"nodeId":"XXX", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------------- | -| linkName | STRING | NO | 链路名称 | -| nodeId | BIGINT | NO | 所属系统节点ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data":[ - { - "id":"xxx", - "linkName":"xxx", - "protocol":"xxx", - "params":"xxx", - "nodeId":"xxx" - }, - { - ... - } - ] -} -``` - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------------- | -| id | VARCHAR | NO | 链路主键 | -| linkName | BIGINT | NO | 链路名称 | -| protocol | INT | NO | 通讯协议 | -| params | TEXT | NO | 协议参数 | -| nodeId | BIGINT | NO | 所属系统节点ID | - -### 通讯链路新增 - -根据添加的信息创建通讯链路，POST方式 - -/api/link/addCommun - -入参示例 - -``` -{ - "linkName":"xxx", - "protocol":"xxx", - "params":"xxx", - "nodeId":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------------- | -| linkName | BIGINT | NO | 链路名称 | -| protocol | INT | NO | 通讯协议 | -| params | TEXT | NO | 协议参数 | -| nodeId | BIGINT | NO | 所属系统节点ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 通讯链路修改 - -根据提供的ID,修改通讯链路，POST方式 - -/api/link/updateCommun - -入参示例 - -``` -{ - "id":"xxx", - "linkName":"xxx", - "protocol":"xxx", - "params":"xxx", - "nodeId":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------------- | -| id | VARCHAR | NO | 链路主键 | -| linkName | BIGINT | NO | 链路名称 | -| protocol | INT | NO | 通讯协议 | -| params | TEXT | NO | 协议参数 | -| nodeId | BIGINT | NO | 所属系统节点ID | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"编辑成功", -"data":"null" -} -``` - -### 通讯链路删除 - -根据提供的ID,删除通讯链路，POST方式 - -/api/link/deleteICommun - -入参示例 - -``` -{ - -"id":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----- | :------: | :---: | :---- | -| id | BIGINT | NO | 主键 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - -## 系统节点 - -### 系统节点查询 - -提供获取所有系统节点的功能，POST方式 - -/api/link/getNode - -入参示例 - -``` -{ -"nodeName":"xxx" -"nodeIp":"XXX", -"orgId":"xxx", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------- | -| nodeName | STRING | YES | 节点名称 | -| nodeIp | STRING | YES | 节点IP | -| orgId | BIGINT | YES | 所属机构 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ - "code":"200", - "msg":"调用成功", - "data":[ - { - "id":"xxx", - "nodeName":"xxx", - "nodeIp":"xxx", - "orgId":"xxx" - }, - { - ... - } - ] -} -``` - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :--------- | -| id | BIGINT | no | 系统节点ID | -| nodeName | STRING | no | 节点名称 | -| nodeIp | STRING | no | 节点IP | -| orgId | BIGINT | no | 所属机构 | - -### 系统节点新增 - -根据添加的信息创建系统节点，POST方式 - -/api/link/addNode - -入参示例 - -``` -{ -"nodeName":"xxx" -"nodeIp":"XXX", -"orgId":"xxx", -"token":"xxx" -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :------- | -| nodeName | STRING | NO | 节点名称 | -| nodeIp | STRING | NO | 节点IP | -| orgId | BIGINT | NO | 所属机构 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"新增成功", -"data":"null" -} -``` - -### 系统节点修改 - -根据提供的ID,修改系统节点，POST方式 - -/api/link/updateNode - -入参示例 - -``` -{ - "id":"xxx", - "nodeName":"xxx", - "nodeIp":"xxx", - "orgId":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :------- | :------: | :---: | :--------- | -| id | BIGINT | NO | 系统节点ID | -| nodeName | STRING | NO | 节点名称 | -| nodeIp | STRING | NO | 节点IP | -| orgId | BIGINT | NO | 所属机构 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"编辑成功", -"data":"null" -} -``` - -### 系统节点删除 - -根据提供的ID,删除系统节点，POST方式 - -/api/link/deleteINode - -入参示例 - -``` -{ - - "id":"xxx", - "token":"xxx" - -} -``` - -入参描述 - -| 参数名 | 参数类型 | 可选 | 描述 | -| :----- | :------: | :---: | :---- | -| id | BIGINT | NO | 主键 | -| token | String | NO | token | - -调用成功返回示例 - -```json -{ -"code":"200", -"msg":"删除成功", -"data":"null" -} -``` - - \ No newline at end of file