补充技能说明

2026-05-20 14:59:18 +08:00
parent 96d894d1e0
commit bd04444d9d
38 changed files with 618 additions and 83 deletions
@@ -22,3 +22,13 @@ version: 3.0.0
 | GET | `/api/v1/composite/scada-simulation` | 获取SCADA关联的模拟数据 | start_time (query), end_time (query), device_ids (query) | scheme_type (query), scheme_name (query) |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /composite/scada-simulation` | 将 SCADA 设备历史监测数据与水力模拟结果对齐返回，便于压差分析 |
+| `GET /composite/element-simulation` | 按管网元素ID和属性类型查询该元素在某方案下的模拟时序数据 |
+| `GET /composite/element-scada` | 查询某管网元素关联的 SCADA 设备的历史监测时序数据，支持使用清洗后数据（use_cleaned） |
+| `POST /composite/clean-scada` | 对指定设备在指定时间段的 SCADA 数据进行清洗处理（去噪、异常值替换） |
+| `GET /composite/pipeline-health-prediction` | 在指定时刻对整个管网的管道健康状态进行预测，返回各管道健康评分 |
@@ -27,3 +27,18 @@ version: 3.0.0
 | POST | `/api/v1/realtime/simulation/store` | 存储实时模拟结果 | node_result_list (body), link_result_list (body), result_start_time (query) | - |

 - 覆盖方法：`DELETE, GET, PATCH, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `POST /realtime/links/batch` | 批量将管道（link）模拟结果写入实时数据表（TimescaleDB） |
+| `GET /realtime/links` | 查询指定时间范围内的实时管道模拟数据 |
+| `DELETE /realtime/links` | 删除指定时间范围内的实时管道数据 |
+| `PATCH /realtime/links/{link_id}/field` | 修改某条管道在特定时刻的某个字段值 |
+| `POST /realtime/nodes/batch` | 批量将节点模拟结果写入实时数据表 |
+| `GET /realtime/nodes` | 查询指定时间范围内的实时节点模拟数据 |
+| `DELETE /realtime/nodes` | 删除指定时间范围内的实时节点数据 |
+| `POST /realtime/simulation/store` | 一次性存储一次完整模拟运行的节点和管道结果（含起始时间） |
+| `GET /realtime/query/by-time-property` | 按查询时间点和属性名（如 pressure/flow）查询全网实时模拟值 |
+| `GET /realtime/query/by-id-time` | 按单个元素ID、类型和时间点查询其实时模拟值 |
@@ -29,3 +29,20 @@ version: 3.0.0
 | POST | `/api/v1/scheme/simulation/store` | 存储方案模拟结果 | scheme_type (query), scheme_name (query), node_result_list (body), link_result_list (body), result_start_time (query) | - |

 - 覆盖方法：`DELETE, GET, PATCH, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `POST /scheme/links/batch` | 批量将管道模拟结果写入指定方案（scheme_type + scheme_name）的数据表 |
+| `GET /scheme/links` | 查询指定方案和时间范围内的所有管道模拟数据 |
+| `DELETE /scheme/links` | 删除指定方案和时间范围内的管道模拟数据 |
+| `GET /scheme/links/{link_id}/field` | 查询特定管道在指定方案和时间范围内某字段的时序数据 |
+| `PATCH /scheme/links/{link_id}/field` | 修改特定管道在指定方案某时刻的某个字段值 |
+| `POST /scheme/nodes/batch` | 批量将节点模拟结果写入指定方案的数据表 |
+| `GET /scheme/nodes/{node_id}/field` | 查询特定节点在指定方案和时间范围内某字段的时序数据 |
+| `PATCH /scheme/nodes/{node_id}/field` | 修改特定节点在指定方案某时刻的某个字段值 |
+| `DELETE /scheme/nodes` | 删除指定方案和时间范围内的节点模拟数据 |
+| `POST /scheme/simulation/store` | 一次性存储完整方案模拟结果（节点 + 管道），需提供 scheme_type 和 scheme_name |
+| `GET /scheme/query/by-id-time` | 按元素ID、类型和时间点查询该元素在指定方案下的模拟值 |
+| `GET /scheme/query/by-scheme-time-property` | 按方案、时间点和属性名查询全网在指定方案下的模拟值 |