das接口文档修改

This commit is contained in:
chenhaojie 2024-07-09 14:33:16 +08:00
parent 6187a866df
commit 9295186eac
2 changed files with 155 additions and 189 deletions

View File

@ -875,195 +875,145 @@ POST请求接口
{ {
"code": 200, "code": 200,
"success": true, "success": true,
"data": { "data": [
"revision": 1, {
"id": "1", "id": "2",
"name": "某风电场", "objectType": 10002,
"mrid": "111", "code": "10002",
"province": "江苏省", "name": "机组",
"city": "南京市", "longitude": 0,
"county": "玄武区", "latitude": 0,
"address": "1", "parentEquipmentId": "0",
"contactPhone": "1", "equipChildren": [
"parentOrgId": 0, {
"equipChildren": [ "createdBy": "测试",
{ "createdTime": "2024-07-08 06:50:32",
"id": "2", "updatedBy": "测试",
"objectType": 10002, "updatedTime": "2024-07-08 06:50:32",
"code": "10002", "revision": 1,
"name": "机组", "id": "1810204805816188930",
"longitude": 0, "objectType": 10002,
"latitude": 0, "code": "",
"parentEquipmentId": "0", "name": "GGG",
"equipChildren": [ "madeinFactory": "",
{ "model": "",
"createdBy": "测试", "location": "",
"createdTime": "2024-07-08 06:50:32", "longitude": 0,
"updatedBy": "测试", "latitude": 0,
"updatedTime": "2024-07-08 06:50:32", "remarks": "",
"revision": 1, "orgId": "1",
"id": "1810204805816188930", "parentEquipmentId": "2"
"objectType": 10002, },
"code": "", {
"name": "GGG", "createdBy": "测试",
"madeinFactory": "", "createdTime": "2024-07-08 06:52:44",
"model": "", "updatedBy": "测试",
"location": "", "updatedTime": "2024-07-08 06:52:44",
"longitude": 0, "revision": 1,
"latitude": 0, "id": "1810205361720852481",
"remarks": "", "objectType": 10002,
"orgId": "1", "code": "",
"parentEquipmentId": "2" "name": "RRR",
}, "madeinFactory": "",
{ "model": "",
"createdBy": "测试", "location": "",
"createdTime": "2024-07-08 06:52:44", "longitude": 0,
"updatedBy": "测试", "latitude": 0,
"updatedTime": "2024-07-08 06:52:44", "remarks": "",
"revision": 1, "orgId": "1",
"id": "1810205361720852481", "parentEquipmentId": "2"
"objectType": 10002, },
"code": "", {
"name": "RRR", "createdBy": "测试",
"madeinFactory": "", "createdTime": "2024-07-08 06:53:07",
"model": "", "updatedBy": "测试",
"location": "", "updatedTime": "2024-07-08 15:01:33",
"longitude": 0, "revision": 1,
"latitude": 0, "id": "1810205456222715906",
"remarks": "", "objectType": 10002,
"orgId": "1", "code": "test1",
"parentEquipmentId": "2" "name": "test1",
}, "madeinFactory": "test1",
{ "model": "test1",
"createdBy": "测试", "location": "test1",
"createdTime": "2024-07-08 06:53:07", "longitude": 48.69145,
"updatedBy": "测试", "latitude": 20.6946,
"updatedTime": "2024-07-08 15:01:33", "installDate": "2027-07-05 15:30:23",
"revision": 1, "remarks": "test1",
"id": "1810205456222715906", "orgId": "1",
"objectType": 10002, "parentEquipmentId": "2"
"code": "test1", },
"name": "test1", {
"madeinFactory": "test1", "createdBy": "测试",
"model": "test1", "createdTime": "2024-07-08 07:02:38",
"location": "test1", "updatedBy": "测试",
"longitude": 48.69145, "updatedTime": "2024-07-08 07:02:38",
"latitude": 20.6946, "revision": 1,
"installDate": "2027-07-05 15:30:23", "id": "1810207853032570881",
"remarks": "test1", "objectType": 10002,
"orgId": "1", "code": "",
"parentEquipmentId": "2" "name": "12121",
}, "madeinFactory": "",
{ "model": "",
"createdBy": "测试", "location": "",
"createdTime": "2024-07-08 07:02:38", "longitude": 0,
"updatedBy": "测试", "latitude": 0,
"updatedTime": "2024-07-08 07:02:38", "remarks": "",
"revision": 1, "orgId": "1",
"id": "1810207853032570881", "parentEquipmentId": "2"
"objectType": 10002, }
"code": "", ]
"name": "12121", },
"madeinFactory": "", {
"model": "", "id": "1",
"location": "", "objectType": 10001,
"longitude": 0, "code": "10001",
"latitude": 0, "name": "风电场",
"remarks": "", "longitude": 0,
"orgId": "1", "latitude": 0,
"parentEquipmentId": "2" "parentEquipmentId": "0",
}, "equipChildren": [
{ {
"createdBy": "测试", "createdBy": "测试",
"createdTime": "2024-07-08 07:20:51", "createdTime": "2024-07-08 06:41:56",
"updatedBy": "测试", "updatedBy": "测试",
"updatedTime": "2024-07-08 07:20:51", "updatedTime": "2024-07-08 06:41:56",
"revision": 1, "revision": 1,
"id": "1810212434735071233", "id": "1810202642163499009",
"objectType": 10002, "objectType": 10001,
"code": "", "code": "",
"name": "儿童", "name": "aaaa",
"madeinFactory": "", "madeinFactory": "",
"model": "", "model": "",
"location": "", "location": "",
"longitude": 0, "longitude": 0,
"latitude": 0, "latitude": 0,
"remarks": "", "remarks": "",
"orgId": "1", "orgId": "1",
"parentEquipmentId": "2" "parentEquipmentId": "1"
} },
] {
}, "createdBy": "测试",
{ "createdTime": "2024-07-08 06:45:09",
"id": "1", "updatedBy": "测试",
"objectType": 10001, "updatedTime": "2024-07-08 06:45:09",
"code": "10001", "revision": 1,
"name": "风电场", "id": "1810203450657538050",
"longitude": 0, "objectType": 10001,
"latitude": 0, "code": "",
"parentEquipmentId": "0", "name": "yy",
"equipChildren": [ "madeinFactory": "",
{ "model": "",
"createdBy": "测试", "location": "",
"createdTime": "2024-07-08 06:41:56", "longitude": 0,
"updatedBy": "测试", "latitude": 0,
"updatedTime": "2024-07-08 06:41:56", "remarks": "",
"revision": 1, "orgId": "1",
"id": "1810202642163499009", "parentEquipmentId": "1"
"objectType": 10001, }
"code": "", ]
"name": "aaaa", }
"madeinFactory": "", ],
"model": "",
"location": "",
"longitude": 0,
"latitude": 0,
"remarks": "",
"orgId": "1",
"parentEquipmentId": "1"
},
{
"createdBy": "测试",
"createdTime": "2024-07-08 06:45:09",
"updatedBy": "测试",
"updatedTime": "2024-07-08 06:45:09",
"revision": 1,
"id": "1810203450657538050",
"objectType": 10001,
"code": "",
"name": "yy",
"madeinFactory": "",
"model": "",
"location": "",
"longitude": 0,
"latitude": 0,
"remarks": "",
"orgId": "1",
"parentEquipmentId": "1"
}
]
}
],
"orgChildren": [
{
"id": "73280038685114368",
"name": "test",
"mrid": "test",
"province": "山西省",
"city": "绛县",
"county": "运城市",
"address": "test",
"contactPhone": "13045088888",
"remarks": "test",
"aliasName": "test",
"parentOrgId": "1",
"parentOrgName": "某风电场",
"revision": 1,
"createdTime": "2024-06-28 00:00:00",
"updatedTime": "2024-06-28 00:00:00"
}
]
},
"msg": "操作成功" "msg": "操作成功"
} }
``` ```

16
docs/api/node.md Normal file
View File

@ -0,0 +1,16 @@
# 节点模块
# API接口一览表
| 接口分类 | 接口描述 | API接口 | 权限 |
|-------|--------------------------|--------------------------------------| ---------------------------- |
| 1.1节点 | 1.1.1获取所有节点信息列表 | /api/node/list | |
| | 1.1.2新增节点信息 | /api/node/add | |
| | 1.1.3修改节点信息 | /api/node/update | SYS_AUTHORITY_ID_ADMIN |
| | 1.1.4删除节点信息 | /api/node/delete | SYS_AUTHORITY_ID_ADMIN |
| | 1.1.5配置下发 | /api/node/add | SYS_AUTHORITY_ID_ADMIN |
| 1.2链路 | 1.2.1获取所有链路分页查询 | /api/node/link/list | |
| | 1.2.2新增链路信息 | /api/node/link/add | SYS_AUTHORITY_ID_ADMIN |
| | 1.2.3修改链路信息 | /api/node/link/update | SYS_AUTHORITY_ID_ADMIN |
| | 1.2.4删除链路信息 | /api/node/link/delete | SYS_AUTHORITY_ID_ADMIN |