Browse Source

新增及调整接口

lijie 3 years ago
parent
commit
a98a75e93a
2 changed files with 289 additions and 14 deletions
  1. 175 0
      docs/dic/dic_api.md
  2. 114 14
      docs/rwd/rwd_api.md

+ 175 - 0
docs/dic/dic_api.md

@@ -69,6 +69,7 @@ typeCode参考[码表类型](/utils/common.md)
 |   modifier   |    否    |     最后修改人     |                               |
 | modifiedTime |    否    |    最后修改时间    |     格式为yyyyMMddHHmmss      |
 |    valid     |    否    |      合法标识      |         0-无效,1-有效         |
+|   content    |    否    |  下级码表数据数组  |         下级码表数据          |
 
 #### 接口修改记录
 
@@ -78,6 +79,180 @@ typeCode参考[码表类型](/utils/common.md)
 
 
 
+### 11002 根据码表类型及码表数据code查询知识库详情
+
+接口:`http://localhost:8831/dmp-dic/dic/code/queryCodeTableDatasByTypeCodeAndCodes`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### 参数例子
+
+```
+{
+  "typeCode": "major",
+  "codes": ["**","**"]
+}
+```
+
+| 字段     | 是否必须 | 字段说明                         |
+| -------- | -------- | -------------------------------- |
+| typeCode | 是       | 参考[码表类型](/utils/common.md) |
+| codes    | 是       | 码表数据code数组                 |
+
+#### 
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "CODEDATA000000000000000003000001",
+            "valid": null,
+            "creationTime": null,
+            "creator": null,
+            "modifiedTime": null,
+            "modifier": null,
+            "projectId": null,
+            "typeId": null,
+            "typeCode": null,
+            "code": "1",
+            "name": "晴",
+            "parentId": null,
+            "innerCode": null,
+            "extras": null,
+            "showOrder": null,
+            "remark": null
+        }
+    ],
+    "count": 26
+}
+```
+
+|     字段     | 是否必有 |      字段说明      |             备注              |
+| :----------: | :------: | :----------------: | :---------------------------: |
+|      id      |    是    | 主键(无业务含义) | "CODEDATA"+18位0占位符+内部码 |
+|  groupCode   |    否    |      集团编码      |                               |
+|  projectId   |    否    |       项目id       | id规则:Pj+6位地区码+4位顺序码 |
+|    typeId    |    是    |       类型ID       |                               |
+|   typeCode   |    是    |      类型编码      |                               |
+|     code     |    是    |        编码        |                               |
+|     name     |    是    |        名称        |                               |
+|   parentId   |    否    |       上级ID       |         顶级上级id为0         |
+|  innerCode   |    否    |       内部码       |                               |
+|    extras    |    否    |      扩展属性      |          格式为{...}          |
+|  showOrder   |    否    |      显示顺序      |                               |
+|    remark    |    否    |        备注        |                               |
+|   creator    |    否    |       创建人       |                               |
+| creationTime |    否    |      创建时间      |     格式为yyyyMMddHHmmss      |
+|   modifier   |    否    |     最后修改人     |                               |
+| modifiedTime |    否    |    最后修改时间    |     格式为yyyyMMddHHmmss      |
+|    valid     |    否    |      合法标识      |         0-无效,1-有效         |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月31日09:48:46 | 新增 | 新增接口 |
+
+
+
+### 11003 根据码表类型及父码表数据code查询知识库详情
+
+接口:`http://localhost:8831/dmp-dic/dic/code/queryCodeTableDatasByParentCode`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### 参数例子
+
+```
+{
+  "typeCode": "major",
+  "parentCode": "**"
+}
+```
+
+| 字段       | 是否必须 | 字段说明                         |
+| ---------- | -------- | -------------------------------- |
+| typeCode   | 是       | 参考[码表类型](/utils/common.md) |
+| parentCode | 是       | 父码表数据code                   |
+
+#### 
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "CODEDATA000000000000000003000001",
+            "valid": null,
+            "creationTime": null,
+            "creator": null,
+            "modifiedTime": null,
+            "modifier": null,
+            "projectId": null,
+            "typeId": null,
+            "typeCode": null,
+            "code": "1",
+            "name": "晴",
+            "parentId": null,
+            "innerCode": null,
+            "extras": null,
+            "showOrder": null,
+            "remark": null
+        }
+    ],
+    "count": 26
+}
+```
+
+|     字段     | 是否必有 |      字段说明      |             备注              |
+| :----------: | :------: | :----------------: | :---------------------------: |
+|      id      |    是    | 主键(无业务含义) | "CODEDATA"+18位0占位符+内部码 |
+|  groupCode   |    否    |      集团编码      |                               |
+|  projectId   |    否    |       项目id       | id规则:Pj+6位地区码+4位顺序码 |
+|    typeId    |    是    |       类型ID       |                               |
+|   typeCode   |    是    |      类型编码      |                               |
+|     code     |    是    |        编码        |                               |
+|     name     |    是    |        名称        |                               |
+|   parentId   |    否    |       上级ID       |         顶级上级id为0         |
+|  innerCode   |    否    |       内部码       |                               |
+|    extras    |    否    |      扩展属性      |          格式为{...}          |
+|  showOrder   |    否    |      显示顺序      |                               |
+|    remark    |    否    |        备注        |                               |
+|   creator    |    否    |       创建人       |                               |
+| creationTime |    否    |      创建时间      |     格式为yyyyMMddHHmmss      |
+|   modifier   |    否    |     最后修改人     |                               |
+| modifiedTime |    否    |    最后修改时间    |     格式为yyyyMMddHHmmss      |
+|    valid     |    否    |      合法标识      |         0-无效,1-有效         |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月31日09:48:39 | 新增 | 新增接口 |
+
+
+
 ## 数据字典接口(Deprecated)-兼容旧中台
 
 ### 12001 查询字典类型数据

+ 114 - 14
docs/rwd/rwd_api.md

@@ -1204,7 +1204,7 @@ POST请求
 
 #### 接口
 
-`http://localhost:8831/dmp-rwd/rwd/instance/object/queryEquipListBySystemId?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryEquipListByConditions?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
 #### 请求方式
 
@@ -1237,24 +1237,32 @@ POST请求
   "equipStatus":"***",
   "warranter":"***",
   "keyword":"***",
+  "orders":[
+  	{
+  		"column":"",
+  		"asc":true
+  	}
+  ]
   "page":1,
   "size":50
 }
 ```
 
-| 字段            | 是否必须 | 字段说明               |
-| --------------- | -------- | ---------------------- |
-| classCode       | 否       | 专业编码               |
-| systemId        | 否       | 系统id                 |
-| floorId         | 否       | 楼层id                 |
-| installLocation | 否       | 安装位置               |
-| manufacturer    | 否       | 生产厂家               |
-| equipStatus     | 否       | 设备状态               |
-| warranter       | 否       | 维保单位名称           |
-| keyword         | 否       | 设备本地名称筛选关键字 |
-| systemId        | 是       | 系统id                 |
-| page            | 否       | 分页页数,从1开始       |
-| pageSize        | 否       | 分页条数               |
+| 字段            | 子字段 | 是否必须 | 字段说明                                                    |
+| --------------- | ------ | -------- | ----------------------------------------------------------- |
+| classCode       |        | 否       | 专业,系统类,设备类code                                      |
+| systemId        |        | 否       | 系统id                                                      |
+| floorId         |        | 否       | 楼层id                                                      |
+| installLocation |        | 否       | 安装位置                                                    |
+| manufacturer    |        | 否       | 生产厂家                                                    |
+| equipStatus     |        | 否       | 设备状态                                                    |
+| warranter       |        | 否       | 维保单位名称                                                |
+| keyword         |        | 否       | 设备本地名称筛选关键字                                      |
+| page            |        | 否       | 分页页数,从1开始                                            |
+| size            |        | 否       | 分页条数                                                    |
+| orders          |        | 否       | 排序参数                                                    |
+|                 | column | 是       | 排序字段,installLocation,manufacturer,equipStatus,warranter |
+|                 | asc    | 是       | true-正序,false-倒序                                        |
 
 #### 成功例子
 
@@ -1838,6 +1846,98 @@ POST请求
 
 
 
+### 22004 根据对象id和关系查询对象列表
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryObjMesByObjIdsAndRelCode?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   |
+
+#### 参数例子
+
+```
+{
+    "projectId":"****",
+	"objIds":["***","***"],
+	"relCodes":["",""]
+}
+```
+
+| 字段    | 子字段 | 是否必须 | 字段说明   |
+| ------- | ------ | -------- | ---------- |
+| objIds  |        | 否       | 对象id     |
+| graphId |        | 否       | 图类型Id   |
+| relCode |        | 否       | 边类型编码 |
+| objFrom |        | 否       | 来源对象id |
+| objTo   |        | 否       | 去向对象id |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id":"***",
+            "graphCode": "图类型编码",
+            "graphId": "图类型Id",
+            "relCode": "边类型编码",
+            "objFrom": "",
+            "objTo": "",
+            "valid":1,
+            "creator":"创建人账号id",
+            "creationTime":"创建时间,格式为yyyyMMddHHmmss",
+            "modifiedTime":"最后更新时间,格式为yyyyMMddHHmmss",
+            "modifier":"最后更新账号id"
+        }
+    ]
+}
+```
+
+| 字段         | 是否必有 | 字段说明                          |
+| ------------ | -------- | --------------------------------- |
+| id           | 是       | 32位UUID                          |
+| groupCode    | 否       | 集团编码                          |
+| projectId    | 是       | 项目id                            |
+| graphId      | 否       | 图主键                            |
+| graphCode    | 否       | 图编码                            |
+| relCode      | 否       | 关系编码                          |
+| objFrom      | 否       | 来源对象id                        |
+| objTo        | 否       | 目标对象id                        |
+| valid        | 是       | 合法标识,1-有效,0-无效            |
+| creator      | 否       | 创建人账号id                      |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss     |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss |
+| modifier     | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月16日11:45:22 | 新增 | 新增接口 |
+
+
+
+
+
 ## 图类型接口
 
 ### 23001 查询图类型(Deprecated)