Przeglądaj źródła

增加BDTP交付范围相关接口说明

linhuili 3 lat temu
rodzic
commit
6ac7285970
1 zmienionych plików z 264 dodań i 0 usunięć
  1. 264 0
      docs/rwd/api.md

+ 264 - 0
docs/rwd/api.md

@@ -5459,3 +5459,267 @@ POST请求
 | ---------------------- | ---- | -------- |
 | 2021年10月28日14:19:16 | 新增 | 新增接口 |
 
+## 交付范围的接口
+
+### 220001 查询交付范围内的类型定义
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/api/rwd/def/class/collect?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+["***","****"]
+```
+
+| 字段 | 是否必须 | 字段说明   |
+| ---- | -------- | ---------- |
+| ***  | 是       | 项目id集合 |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "***",
+            "defineTypeId": "***",
+            "groupCode":"***",
+            “projectId”:"***",
+            “code”:"ACCCCA",
+            "objType": "equipment",
+            "deliveryType": 0,
+            "instanceScope":"玻璃栏杆、常规栏杆",
+            "deliveryRelation":"同时交付配电控制箱",
+            "remark":"***",
+            "valid": 1,
+            "creationTime": 1628733867000,
+            "creator": "0",
+            "modifiedTime": null,
+            "modifier": null
+        }
+    ],
+    "count":1
+}
+```
+
+| 字段         | 是否必有 | 字段说明                          |
+| ------------ | -------- | --------------------------------- |
+| id           | 是       | 32位UUID                          |
+| groupCode    | 否       | 集团编码                          |
+| projectId    | 是       | 项目id                            |
+| defineTypeId | 是       | 类型ID                            |
+| code         | 否       | 对象类型编码                            |
+| objType      | 否       | 对象类型                          |
+| deliveryType | 是       | 交付类型:0-项目交付 1-现场交付      |
+| instanceScope| 否       | 交付范围:实例范围         |
+| deliveryRelation| 否    | 交付范围:依赖&关联         |
+| remark       | 否       | 交付范围:备注         |
+| valid        | 是       | 合法标识,1-有效,0-无效            |
+| creator      | 否       | 创建人账号id                      |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss     |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss |
+| modifier     | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间             | 操作 | 操作内容 |
+| -------------------- | ---- | -------- |
+| 2022年1月11日10:01:12 | 新增 | 新增接口 |
+
+### 220002 查询交付范围内的信息点定义
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/api/rwd/def/funcid/collect?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+["***","****"]
+```
+
+| 字段 | 是否必须 | 字段说明   |
+| ---- | -------- | ---------- |
+| ***  | 是       | 项目id集合 |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "***",
+            "defineInfoId": "***",
+            "groupCode":"***",
+            “projectId”:"***",
+            “code”:"***",
+            "classCode": "ACCCCA",
+            "keyWord":0,
+            "deliveryScope":"***",
+            "dataSource":"***",
+            "collectInfo":"***",
+            "remark":"***",
+            "valid": 1,
+            "creationTime": 1628733867000,
+            "creator": "0",
+            "modifiedTime": null,
+            "modifier": null
+        }
+    ],
+    "count":1
+}
+```
+
+| 字段         | 是否必有 | 字段说明                             |
+| ------------ | -------- | --------------------------------  |
+| id           | 是       | 32位UUID                          |
+| groupCode    | 否       | 集团编码                           |
+| projectId    | 是       | 项目id                            |
+| defineInfoId | 是       | 信息点ID                          |
+| code         | 否       | 信息点编码                         |
+| classCode    | 否       | 类型编码                          |
+| keyWord      | 否       | 是否为关键信息点 0-否 1-是(台账详情使用)|
+| deliveryScope| 否       | 交付范围                          |
+| dataSource   | 否       | 交付数据来源                      |
+| collectInfo  | 否       | 现场收集信息                      |
+| remark       | 否       | 备注                             |
+| valid        | 是       | 合法标识,1-有效,0-无效             |
+| creator      | 否       | 创建人账号id                      |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss     |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss  |
+| modifier     | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间             | 操作 | 操作内容 |
+| -------------------- | ---- | -------- |
+| 2021年10月14日17:40:12 | 新增 | 新增接口 |
+| 2022年01月11日10:01:12 | 修改 | 去除visiable字段,统一使用valid字段 |
+
+### 220003 查询交付范围内的关系定义
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/api/rwd/def/rel/collect?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+["***","****"]
+```
+
+| 字段 | 是否必须 | 字段说明   |
+| ---- | -------- | ---------- |
+| ***  | 是       | 项目id集合 |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "***",
+            "groupCode":"***",
+            “projectId”:"***",
+            “sourceTypeCodes”:["***"],
+            "endTypeCodes": ["***"],
+            "graphCode":"***",
+            "relCode":"***",
+            "collectInfo":"***",
+            "automaticFlag":0,
+            "remark":"***",
+            "valid": 1,
+            "creationTime": 1628733867000,
+            "creator": "0",
+            "modifiedTime": null,
+            "modifier": null
+        }
+    ],
+    "count":1
+}
+```
+
+| 字段         | 是否必有 | 字段说明                             |
+| ------------ | -------- | --------------------------------  |
+| id              | 是       | 32位UUID                          |
+| groupCode       | 否       | 集团编码                           |
+| projectId       | 是       | 项目id                            |
+| sourceTypeCodes | 否       | 源端对象类型编码                    |
+| endTypeCodes    | 否       | 末端对象类型编码                    |
+| graphCode       | 是       | 图类型编码                         |
+| relCode         | 是       | 边类型编码                         |
+| automaticFlag   | 否       | 计算方式:0-手动计算 1-自动计算       |
+| remark          | 否       | 备注                             |
+| valid           | 是       | 合法标识,1-有效,0-无效             |
+| creator         | 否       | 创建人账号id                      |
+| creationTime    | 否       | 创建时间,格式为yyyyMMddHHmmss      |
+| modifiedTime    | 否       | 最后更新时间,格式为yyyyMMddHHmmss  |
+| modifier        | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间             | 操作 | 操作内容 |
+| -------------------- | ---- | -------- |
+| 2022年1月11日10:01:12 | 新增 | 新增接口 |