补充技能说明

2026-05-20 14:59:18 +08:00
parent 96d894d1e0
commit bd04444d9d
38 changed files with 618 additions and 83 deletions
@@ -21,3 +21,12 @@ version: 3.0.0
 | POST | `/api/v1/setextensiondata/` | 设置扩展数据 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallextensiondatakeys/` | 获取当前管网中所有已存储的自定义扩展数据的键名列表 |
+| `GET /getallextensiondata/` | 获取当前管网所有自定义扩展数据（键值对集合） |
+| `GET /getextensiondata/` | 按 key 查询指定的自定义扩展数据值 |
+| `POST /setextensiondata/` | 设置或更新一个自定义扩展数据键值对（可用于存储任意业务自定义信息） |
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/test_dict/` | 测试字典处理 | data (body) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getallburstlocateresults/` | 获取当前管网所有历史爆管定位分析结果（旧版接口） |
+| `GET /getallsensorplacements/` | 获取当前管网所有传感器布置方案的结果列表 |
+| `GET /getsimulationresult/` | 获取最近一次水力模拟结果（旧版接口） |
+| `GET /getrealtimedata/` | 获取管网实时监测数据（旧版接口） |
+| `GET /getjson/` | 返回示例 JSON 数据结构，用于开发调试 |
+| `POST /test_dict/` | 测试字典类型请求体的接口，用于开发调试 |
@@ -21,3 +21,12 @@ version: 3.0.0
 | GET | `/api/v1/scheme-list` | 获取方案列表 | - | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /burst-locate-result` | 获取所有爆管定位事件的历史结果列表（新版REST接口） |
+| `GET /burst-locate-result/{burst_incident}` | 查询指定爆管事件（burst_incident ID）的详细定位结果 |
+| `GET /scada-info` | 获取当前项目关联的 SCADA 设备和监测点信息汇总 |
+| `GET /scheme-list` | 获取当前项目中所有可用的水力计算方案列表 |
@@ -15,34 +15,41 @@ version: 3.0.0
 ## 接口目录
 | Method | Path | Summary | Required Params | Optional Params |
 |---|---|---|---|---|
-| POST | `/api/v1/closeproject/` | 关闭项目 | network (query) | - |
-| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |
-| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |
-| POST | `/api/v1/copyproject/` | 复制项目 | source (query), target (query) | - |
+| GET | `/api/v1/listprojects/` | 获取项目列表 | - | - |
+| GET | `/api/v1/project_info/` | 获取项目信息 | network (query) | - |
+| GET | `/api/v1/haveproject/` | 检查项目是否存在 | network (query) | - |
 | POST | `/api/v1/createproject/` | 创建新项目 | network (query) | - |
 | POST | `/api/v1/deleteproject/` | 删除项目 | network (query) | - |
-| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
-| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
-| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
-| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
-| GET | `/api/v1/exportinp/` | 导出项目为 ChangeSet | network (query), version (query) | - |
-| GET | `/api/v1/haveproject/` | 检查项目是否存在 | network (query) | - |
-| POST | `/api/v1/importinp/` | 导入 INP 文件内容 | network (query) | - |
-| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
-| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
+| POST | `/api/v1/copyproject/` | 复制项目 | source (query), target (query) | - |
 | GET | `/api/v1/isprojectopen/` | 检查项目是否已打开 | network (query) | - |
-| GET | `/api/v1/listprojects/` | 获取项目列表 | - | - |
-| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
-| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
 | POST | `/api/v1/openproject/` | 打开项目 | network (query) | - |
-| GET | `/api/v1/project_info/` | 获取项目信息 | network (query) | - |
-| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
-| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
-| POST | `/api/v1/unlockproject/` | 解锁项目 | network (query) | - |
+| POST | `/api/v1/closeproject/` | 关闭项目 | network (query) | - |
+| GET | `/api/v1/isprojectlocked/` | 检查项目是否被锁定 | network (query) | - |
+| GET | `/api/v1/isprojectlockedbyme/` | 检查项目是否被当前用户锁定 | network (query) | - |
+| POST | `/api/v1/lockproject/` | 锁定项目 | network (query) | - |
 | POST | `/api/v1/unlockproject/` | 解锁项目 | network (query) | - |
+| POST | `/api/v1/importinp/` | 导入 INP 文件内容 | network (query) | - |
+| GET | `/api/v1/exportinp/` | 导出项目为 ChangeSet | network (query), version (query) | - |
+| POST | `/api/v1/readinp/` | 读取 INP 文件到项目 | network (query), inp (query) | - |
+| GET | `/api/v1/dumpinp/` | 导出项目到 INP 文件 | network (query), inp (query) | - |
 | POST | `/api/v1/uploadinp/` | 上传 INP 文件 | afile (body), name (query) | - |
-| POST | `/api/v1/uploadinp/` | 上传 INP 文件 | afile (body), name (query) | - |
+| GET | `/api/v1/downloadinp/` | 下载 INP 文件 | name (query) | - |
+| GET | `/api/v1/convertv3tov2/` | 转换 INP V3 为 V2 | - | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /listprojects/` | 获取服务器上所有可用的供水管网项目名称列表 |
+| `GET /project_info/` | 从数据库获取项目的详细信息，包括地图范围等配置 |
+| `POST /createproject/` | 创建一个新的供水管网项目；若已存在可能覆盖或报错 |
+| `POST /deleteproject/` | 永久删除指定项目，此操作不可恢复 |
+| `POST /openproject/` | 将指定项目加载到内存并初始化数据库连接池 |
+| `POST /closeproject/` | 将指定项目从内存中卸载，释放相关资源 |
+| `POST /lockproject/` | 锁定项目以防止并发修改 |
+| `POST /unlockproject/` | 释放对项目的锁定 |
+| `POST /importinp/` | 将 INP 格式文本内容导入到指定项目 |
+| `GET /exportinp/` | 导出项目变更集（ChangeSet），含顶点、SCADA元素、DMA、SA、VD等 |
+| `GET /convertv3tov2/` | 将 EPANET 3.0 格式的 INP 内容转换为 2.x 格式 |
@@ -20,3 +20,11 @@ version: 3.0.0
 | GET | `/api/v1/getschemeschema/` | 获取方案模式 | network (query) | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getschemeschema/` | 返回方案（Scheme）数据模型的字段定义 |
+| `GET /getallschemes/` | 获取当前管网下所有已保存方案的列表 |
+| `GET /getscheme/` | 查询指定方案名称（schema_name）的详细属性和配置 |
@@ -35,3 +35,20 @@ version: 3.0.0
 | POST | `/api/v1/undo/` | 撤销操作 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getsnapshots/` | 列出当前管网所有已保存的快照标签（tag）列表 |
+| `GET /havesnapshot/` | 检查指定 tag 的快照是否存在 |
+| `POST /takesnapshot/` | 保存当前管网状态为一个快照，tag 为快照名称 |
+| `POST /picksnapshot/` | 将管网状态回滚到指定快照，discard=true 时丢弃当前未保存修改 |
+| `GET /getcurrentoperationid/` | 获取当前管网的操作ID（用于追踪操作历史） |
+| `POST /undo/` | 撤销对管网的最近一次操作 |
+| `POST /redo/` | 重做上一次被撤销的操作 |
+| `POST /batch/` | 批量执行多个管网操作命令（原子事务） |
+| `POST /compressedbatch/` | 执行压缩格式的批量命令（减少网络传输量） |
+| `GET /syncwithserver/` | 将客户端的操作与服务端管网状态同步 |
+| `POST /pickoperation/` | 切换到指定 operation ID 的历史操作状态 |
+| `POST /takesnapshotforcurrentoperation` | 为当前 operation 创建快照（保存当前操作节点状态） |