51 lines
3.0 KiB
Markdown
51 lines
3.0 KiB
Markdown
---
|
||
name: tjwater-action-business-network-assets-valves
|
||
description: business/network-assets 下 valves 操作技能。
|
||
version: 3.0.0
|
||
---
|
||
|
||
# valves Action Skill
|
||
|
||
## 简介
|
||
负责 `business/network-assets` 场景下 `valves` 的具体接口调用。
|
||
|
||
## 子模块索引 (渐进式引导)
|
||
- 当前为叶子节点,直接使用下方接口目录。
|
||
|
||
## 接口目录
|
||
| Method | Path | Summary | Required Params | Optional Params |
|
||
|---|---|---|---|---|
|
||
| POST | `/api/v1/addvalve/` | 添加阀门 | network (query), valve (query), node1 (query), node2 (query) | diameter (query), v_type (query), setting (query), minor_loss (query) |
|
||
| POST | `/api/v1/deletevalve/` | 删除阀门 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getallvalveproperties/` | 获取所有阀门属性 | network (query) | - |
|
||
| GET | `/api/v1/getvalvediameter/` | 获取阀门直径 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalveminorloss/` | 获取阀门损失系数 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalvenode1/` | 获取阀门起点节点 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalvenode2/` | 获取阀门终点节点 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalveproperties/` | 获取阀门所有属性 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalveschema` | 获取阀门架构 | network (query) | - |
|
||
| GET | `/api/v1/getvalvesetting/` | 获取阀门开度 | network (query), valve (query) | - |
|
||
| GET | `/api/v1/getvalvetype/` | 获取阀门类型 | network (query), valve (query) | - |
|
||
| POST | `/api/v1/setvalvenode1/` | 设置阀门起点节点 | network (query), valve (query), node1 (query) | - |
|
||
| POST | `/api/v1/setvalvenode2/` | 设置阀门终点节点 | network (query), valve (query), node2 (query) | - |
|
||
| POST | `/api/v1/setvalvenodediameter/` | 设置阀门直径 | network (query), valve (query), diameter (query) | - |
|
||
| POST | `/api/v1/setvalveproperties/` | 批量设置阀门属性 | network (query), valve (query) | - |
|
||
| POST | `/api/v1/setvalvesetting/` | 设置阀门开度 | network (query), valve (query), setting (query) | - |
|
||
| 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*/` | 设置阀门某个具体属性(类型、设定值、管径等) |
|