56 lines
3.0 KiB
Markdown
56 lines
3.0 KiB
Markdown
---
|
|
name: tjwater-action-business-project-workspace-project
|
|
description: business/project-workspace 下 project 操作技能。
|
|
version: 3.0.0
|
|
---
|
|
|
|
# project Action Skill
|
|
|
|
## 简介
|
|
负责 `business/project-workspace` 场景下 `project` 的具体接口调用。
|
|
|
|
## 子模块索引 (渐进式引导)
|
|
- 当前为叶子节点，直接使用下方接口目录。
|
|
|
|
## 接口目录
|
|
| Method | Path | Summary | Required Params | Optional Params |
|
|
|---|---|---|---|---|
|
|
| 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) | - |
|
|
| POST | `/api/v1/copyproject/` | 复制项目 | source (query), target (query) | - |
|
|
| GET | `/api/v1/isprojectopen/` | 检查项目是否已打开 | network (query) | - |
|
|
| POST | `/api/v1/openproject/` | 打开项目 | 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) | - |
|
|
| 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 格式 |
|