diff --git a/docs/api/equipment.md b/docs/api/equipment.md index 9fba6c1d..b61191ad 100644 --- a/docs/api/equipment.md +++ b/docs/api/equipment.md @@ -19,8 +19,8 @@ | | 2.2.12物模型方法删除 | /api/equipment/model/service/delete | SYS_AUTHORITY_ID_ADMIN | | | 2.2.13 Excel导出物模型属性和方法 | /api/equipment/model/export | | | | 2.2.14 Excel导入物模型属性和方法 | /api/equipment/model/import | SYS_AUTHORITY_ID_ADMIN | -| 2.3设备台账 | 2.3.1 设备分页查询 | /api/equipment/query | SYS_AUTHORITY_ID_DEVICE_VIEW | -| | 2.3.2 设备不分页查询 | /api/equipment/list | SYS_AUTHORITY_ID_DEVICE_VIEW | +| 2.3设备台账 | 2.3.1 设备不分页查询 | /api/equipment/list | SYS_AUTHORITY_ID_DEVICE_VIEW | +| | 2.3.2 设备分页查询 | /api/equipment/query | SYS_AUTHORITY_ID_DEVICE_VIEW | | | 2.3.3 设备新增 | /api/equipment/add | SYS_AUTHORITY_ID_DEVICE_MGR | | | 2.3.4 设备修改 | /api/equipment/update | SYS_AUTHORITY_ID_DEVICE_MGR | | | 2.3.5 设备删除 | /api/equipment/delete | SYS_AUTHORITY_ID_DEVICE_MGR | @@ -592,30 +592,91 @@ Excel导入 ### 2.3 设备台账相关接口 -#### 2.3.1 设备分页查询 +#### 2.3.1 设备不分页查询 + +POST请求接口 + +> /api/equipment/list + +请求参数 + +```json +{ + "orgId":"1", + "parentEquipmentId":"2", + "objectType":"10001" +} +``` + +参数说明 + +| 参数名 | 参数类型 | 可选 | 描述 | +| ----------------- | -------- | ---- | ---------- | +| orgId | 字符串 | Yes | 所属机构ID | +| parentEquipmentId | 字符串 | Yes | 上级设备ID | +| objectType | 字符串 | No | 设备类型 | + +返回报文 + +```json +{ + "code": 200, + "msg": "操作成功", + "success": true, + "data": [ + { + "id": "2017011807", + "objectType": "10001", + "code": "Station01", + "name": "某某风电场", + "madeinfactory": "生产厂家", + "model": "规格型号", + "location": "徐庄软件园", + "longitude": 46.12345, + "latitude": 137.01678, + "installDate": "2024-06-27 15:08:23", + "remarks": null, + "orgId": "101", + "parentEquipmentId": null, + "iotModelId": "45678", + "revision": 1, + "createdBy": "admin", + "createdTime": "2024-06-27 15:08:23", + "updatedBy": "admin", + "updatedTime": "2024-06-27 15:08:23" + } + ] +} +``` + + + +#### 2.3.2 设备分页查询 + +> /api/equipment/query + -> /api/equipment/query -> -> -#### 2.3.2 设备不分页查询 -> /api/equipment/list -> -> #### 2.3.3 设备新增 > /api/equipment/add + + #### 2.3.4 设备修改 > /api/equipment/update + + #### 2.3.5 设备删除 > /api/equipment/delete + + #### 2.3.6 Excel导出设备清单 > /api/equipment/export