补充技能说明

2026-05-20 14:59:18 +08:00
parent 2dfe06bef7
commit 5835df7263
38 changed files with 618 additions and 83 deletions
@@ -23,3 +23,14 @@ version: 3.0.0
 | POST | `/api/v1/setdemandproperties/` | 设置需水量属性 | network (query), junction (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getdemandschema` | 返回需水量（Demand）数据模型的字段定义 |
+| `GET /getdemandproperties/` | 查询指定节点的需水量属性（基础需水量、模式等） |
+| `POST /setdemandproperties/` | 设置节点的需水量属性 |
+| `POST /calculatedemandtonodes/` | 将指定总需水量计算分配到各节点 |
+| `POST /calculatedemandtoregion/` | 将指定总需水量计算分配到指定区域内的节点 |
+| `POST /calculatedemandtonetwork/` | 将指定总需水量按比例分配到整个管网的所有节点 |
@@ -46,3 +46,17 @@ version: 3.0.0
 | GET | `/api/v1/settitle/` | 设置水网标题属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getelementtype/` | 查询指定ID元素的类型（Junction/Pipe/Pump/Tank/Valve/Reservoir） |
+| `GET /getelementtypevalue/` | 查询指定ID元素的类型编码值 |
+| `GET /getelementproperties/` | 查询指定ID元素的所有属性（自动识别类型） |
+| `GET /getelementpropertieswithtype/` | 查询指定类型和ID的元素属性 |
+| `GET /getlinkproperties/` | 查询管线（Pipe/Pump/Valve）的属性 |
+| `GET /getnodeproperties/` | 查询节点（Junction/Tank/Reservoir）的属性 |
+| `GET /settitle/` | 设置管网标题属性 |
+| `POST /deletelink/` | 删除管线（管道/水泵/阀门） |
+| `POST /deletenode/` | 删除节点（节点/水箱/水库） |
@@ -23,3 +23,14 @@ version: 3.0.0
 | GET | `/api/v1/getnodecoord/` | 获取节点坐标 | network (query), node (query) | - |

 - 覆盖方法：`GET`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getnodecoord/` | 查询单个节点（任意类型）的坐标（x, y） |
+| `GET /getmajornodecoords/` | 获取管网主要节点（干管节点）的坐标列表，用于快速渲染 |
+| `GET /getmajorpipenodes/` | 获取主要管道的起终节点列表 |
+| `GET /getnetworklinknodes/` | 获取管网中所有管线的起终节点信息 |
+| `GET /getnetworkgeometries/` | 获取整个管网的完整几何信息（节点坐标 + 管线折点），适合地图绘制 |
+| `GET /getnetworkinextent/` | 查询指定地理范围（bbox）内的管网节点和管线 |
@@ -35,3 +35,18 @@ version: 3.0.0
 | POST | `/api/v1/setjunctiony/` | 设置节点 Y 坐标 | network (query), junction (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getjunctionschema` | 返回节点（Junction）数据模型的所有字段定义 |
+| `GET /getjunctionproperties/` | 查询单个节点的所有属性（标高、需水量、坐标等） |
+| `GET /getalljunctionproperties/` | 批量获取管网中所有节点的属性列表 |
+| `GET /getjunctioncoord/` | 查询单个节点的坐标（x, y） |
+| `GET /getjunctionelevation/` | 查询节点标高值 |
+| `GET /getjunctiondemand/` | 查询节点基础需水量 |
+| `GET /getjunctionpattern/` | 查询节点关联的需水时间模式名称 |
+| `POST /addjunction/` | 向管网添加一个新节点，需提供ID、坐标和标高 |
+| `POST /deletejunction/` | 从管网删除指定节点 |
+| `POST /setjunction*/` | 设置节点某个具体属性（坐标、标高、需水量等） |
@@ -37,3 +37,18 @@ version: 3.0.0
 | POST | `/api/v1/setpipestatus/` | 设置管道状态 | network (query), pipe (query), status (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getpipeschema` | 返回管道（Pipe）数据模型的所有字段定义 |
+| `GET /getpipeproperties/` | 查询单条管道的所有属性（管径、长度、起终节点等） |
+| `GET /getallpipeproperties/` | 批量获取管网中所有管道的属性列表 |
+| `GET /getpipelength/` | 查询管道长度 |
+| `GET /getpipediameter/` | 查询管道管径 |
+| `GET /getpipestatus/` | 查询管道当前状态（开/关/CV） |
+| `GET /getpiperoughness/` | 查询管道粗糙系数 |
+| `POST /addpipe/` | 向管网添加一条新管道，需提供ID、起终节点、长度和管径 |
+| `POST /deletepipe/` | 从管网删除指定管道 |
+| `POST /setpipe*/` | 设置管道某个具体属性（管径、长度、状态等） |
@@ -27,3 +27,16 @@ version: 3.0.0
 | POST | `/api/v1/setpumpproperties/` | 设置水泵属性 | network (query), pump (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getpumpschema` | 返回水泵（Pump）数据模型的所有字段定义 |
+| `GET /getpumpproperties/` | 查询单台水泵的所有属性（曲线名称、起终节点等） |
+| `GET /getallpumpproperties/` | 批量获取管网中所有水泵的属性列表 |
+| `POST /addpump/` | 向管网添加一台新水泵，需提供ID和起终节点 |
+| `POST /deletepump/` | 从管网删除指定水泵 |
+| `POST /setpumpproperties/` | 批量设置水泵属性（曲线、初始状态、效率等） |
+| `POST /setpumpnode1/` | 设置水泵起始节点 |
+| `POST /setpumpnode2/` | 设置水泵终止节点 |
@@ -54,3 +54,20 @@ version: 3.0.0
 | POST | `/api/v1/setvirtualdistrict/` | 设置虚拟分区属性 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getregionschema` | 返回区域（Region）数据模型的字段定义 |
+| `GET /getregion/` | 查询单个区域的属性 |
+| `GET /getallregions/` | 获取管网中所有区域列表 |
+| `GET /getalldistrictmeteringareas/` | 获取所有 DMA（独立计量区）列表 |
+| `GET /getallserviceareas/` | 获取所有服务区列表 |
+| `POST /addregion/` | 新增区域（需提供名称和节点/管道列表） |
+| `POST /adddistrictmeteringarea/` | 新增 DMA 分区 |
+| `POST /addvirtualdistrict/` | 新增虚拟分区 |
+| `POST /addservicearea/` | 新增服务区 |
+| `POST /calculatedistrictmeteringarea/` | 为指定节点集合计算其所属 DMA |
+| `POST /calculatedistrictmeteringareaforregion/` | 为指定区域内的所有节点计算 DMA 归属 |
+| `POST /calculatedistrictmeteringareafornetwork/` | 为整个管网的所有节点计算 DMA 归属 |
@@ -33,3 +33,16 @@ version: 3.0.0
 | POST | `/api/v1/setreservoiry/` | 设置水库Y坐标 | network (query), reservoir (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getreservoirschema` | 返回水库（Reservoir）数据模型的所有字段定义 |
+| `GET /getreservoirproperties/` | 查询单个水库的所有属性（水头、模式、坐标等） |
+| `GET /getallreservoirproperties/` | 批量获取管网中所有水库的属性列表 |
+| `GET /getreservoirhead/` | 查询水库水头（即水库水位高度） |
+| `GET /getreservoirpattern/` | 查询水库关联的时间模式名称 |
+| `POST /addreservoir/` | 向管网添加一个新水库，需提供ID、坐标和水头 |
+| `POST /deletereservoir/` | 从管网删除指定水库 |
+| `POST /setreservoir*/` | 设置水库某个具体属性（水头、模式、坐标等） |
@@ -21,3 +21,12 @@ version: 3.0.0
 | POST | `/api/v1/settag/` | 设置标签 | network (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /gettagschema/` | 返回标签（Tag）数据模型的字段定义 |
+| `GET /gettag/` | 查询单个元素绑定的标签信息 |
+| `GET /gettags/` | 获取管网中所有标签列表 |
+| `POST /settag/` | 为管网元素设置/更新标签（支持自定义键值对属性） |
@@ -45,3 +45,17 @@ version: 3.0.0
 | POST | `/api/v1/settanky/` | 设置水箱Y坐标 | network (query), tank (query), y (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /gettankschema` | 返回水箱（Tank）数据模型的所有字段定义 |
+| `GET /gettankproperties/` | 查询单个水箱的所有属性（标高、直径、初始/最大/最小水位等） |
+| `GET /getalltankproperties/` | 批量获取管网中所有水箱的属性列表 |
+| `GET /gettankelevation/` | 查询水箱底部标高 |
+| `GET /gettankdiameter/` | 查询水箱直径 |
+| `GET /gettankinitlevel/` | 查询水箱初始水位 |
+| `POST /addtank/` | 向管网添加一个新水箱，需提供ID、坐标、标高和水位参数 |
+| `POST /deletetank/` | 从管网删除指定水箱 |
+| `POST /settank*/` | 设置水箱某个具体属性（坐标、标高、直径、水位等） |
@@ -34,3 +34,17 @@ version: 3.0.0
 | POST | `/api/v1/setvalvetype/` | 设置阀门类型 | network (query), valve (query), type (query) | - |

 - 覆盖方法：`GET, POST`
+
+## 接口说明
+
+| 接口 | 说明 |
+|---|---|
+| `GET /getvalveschema` | 返回阀门（Valve）数据模型的所有字段定义 |
+| `GET /getvalveproperties/` | 查询单个阀门的所有属性（管径、类型、设定值等） |
+| `GET /getallvalveproperties/` | 批量获取管网中所有阀门的属性列表 |
+| `GET /getvalvediameter/` | 查询阀门管径 |
+| `GET /getvalvetype/` | 查询阀门类型（PRV/PSV/TCV/FCV/PBV/GPV） |
+| `GET /getvalvesetting/` | 查询阀门设定值（压力设定或流量设定） |
+| `POST /addvalve/` | 向管网添加一个新阀门，需提供ID、起终节点、管径和类型 |
+| `POST /deletevalve/` | 从管网删除指定阀门 |
+| `POST /setvalve*/` | 设置阀门某个具体属性（类型、设定值、管径等） |