74 lines
4.8 KiB
Markdown
74 lines
4.8 KiB
Markdown
---
|
|
name: tjwater-action-business-network-assets-regions
|
|
description: business/network-assets 下 regions 操作技能。
|
|
version: 3.0.0
|
|
---
|
|
|
|
# regions Action Skill
|
|
|
|
## 简介
|
|
负责 `business/network-assets` 场景下 `regions` 的具体接口调用。
|
|
|
|
## 子模块索引 (渐进式引导)
|
|
- 当前为叶子节点，直接使用下方接口目录。
|
|
|
|
## 接口目录
|
|
| Method | Path | Summary | Required Params | Optional Params |
|
|
|---|---|---|---|---|
|
|
| POST | `/api/v1/adddistrictmeteringarea/` | 添加新DMA | network (query) | - |
|
|
| POST | `/api/v1/addregion/` | 添加新区域 | network (query) | - |
|
|
| POST | `/api/v1/addservicearea/` | 添加新服务区 | network (query) | - |
|
|
| POST | `/api/v1/addvirtualdistrict/` | 添加新虚拟分区 | network (query) | - |
|
|
| GET | `/api/v1/calculatedistrictmeteringarea/` | 计算DMA分区 | network (query) | - |
|
|
| GET | `/api/v1/calculatedistrictmeteringareafornetwork/` | 计算整网DMA分区 | network (query) | - |
|
|
| GET | `/api/v1/calculatedistrictmeteringareafornodes/` | 计算节点DMA分区 | network (query) | - |
|
|
| GET | `/api/v1/calculatedistrictmeteringareaforregion/` | 计算区域内DMA分区 | network (query) | - |
|
|
| GET | `/api/v1/calculateregion/` | 计算区域 | network (query), time_index (query) | - |
|
|
| GET | `/api/v1/calculateservicearea/` | 计算服务区 | network (query), time_index (query) | - |
|
|
| GET | `/api/v1/calculatevirtualdistrict/` | 计算虚拟分区 | network (query), centers (query) | - |
|
|
| POST | `/api/v1/deletedistrictmeteringarea/` | 删除DMA | network (query) | - |
|
|
| POST | `/api/v1/deleteregion/` | 删除区域 | network (query) | - |
|
|
| POST | `/api/v1/deleteservicearea/` | 删除服务区 | network (query) | - |
|
|
| POST | `/api/v1/deletevirtualdistrict/` | 删除虚拟分区 | network (query) | - |
|
|
| POST | `/api/v1/generatedistrictmeteringarea/` | 生成DMA分区 | network (query), part_count (query), part_type (query), inflate_delta (query) | - |
|
|
| POST | `/api/v1/generateregion/` | 生成区域分区 | network (query), inflate_delta (query) | - |
|
|
| POST | `/api/v1/generateservicearea/` | 生成服务区分区 | network (query), inflate_delta (query) | - |
|
|
| POST | `/api/v1/generatesubdistrictmeteringarea/` | 生成DMA子分区 | network (query), dma (query), part_count (query), part_type (query), inflate_delta (query) | - |
|
|
| POST | `/api/v1/generatevirtualdistrict/` | 生成虚拟分区 | network (query), inflate_delta (query) | - |
|
|
| GET | `/api/v1/getalldistrictmeteringareaids/` | 获取所有DMA ID | network (query) | - |
|
|
| GET | `/api/v1/getalldistrictmeteringareas/` | 获取所有DMA | network (query) | - |
|
|
| GET | `/api/v1/getallregions/` | 获取所有区域 | network (query) | - |
|
|
| GET | `/api/v1/getallserviceareas/` | 获取所有服务区 | network (query) | - |
|
|
| GET | `/api/v1/getallvirtualdistrict/` | 获取所有虚拟分区 | network (query) | - |
|
|
| GET | `/api/v1/getdistrictmeteringarea/` | 获取DMA信息 | network (query), id (query) | - |
|
|
| GET | `/api/v1/getdistrictmeteringareaschema/` | 获取DMA属性架构 | network (query) | - |
|
|
| GET | `/api/v1/getregion/` | 获取区域信息 | network (query), id (query) | - |
|
|
| GET | `/api/v1/getregionschema/` | 获取区域属性架构 | network (query) | - |
|
|
| GET | `/api/v1/getservicearea/` | 获取服务区信息 | network (query), id (query) | - |
|
|
| GET | `/api/v1/getserviceareaschema/` | 获取服务区属性架构 | network (query) | - |
|
|
| GET | `/api/v1/getvirtualdistrict/` | 获取虚拟分区信息 | network (query), id (query) | - |
|
|
| GET | `/api/v1/getvirtualdistrictschema/` | 获取虚拟分区属性架构 | network (query) | - |
|
|
| POST | `/api/v1/setdistrictmeteringarea/` | 设置DMA属性 | network (query) | - |
|
|
| POST | `/api/v1/setregion/` | 设置区域属性 | network (query) | - |
|
|
| POST | `/api/v1/setservicearea/` | 设置服务区属性 | network (query) | - |
|
|
| 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 归属 |
|