Browse Source

调整接口文档

lijie 3 years ago
parent
commit
95b692cc5b
8 changed files with 38 additions and 1374 deletions
  1. 0 98
      docs/rwd/def_class.md
  2. 0 146
      docs/rwd/def_funcid.md
  3. 0 107
      docs/rwd/def_graph.md
  4. 0 244
      docs/rwd/instance_object.md
  5. 0 245
      docs/rwd/instance_relation.md
  6. 0 275
      docs/rwd/iot.md
  7. 38 34
      docs/rwd/rwd_api.md
  8. 0 225
      docs/rwd/schema.md

+ 0 - 98
docs/rwd/def_class.md

@@ -1,98 +0,0 @@
-### 数据说明
-
-```
-1.类型定义,用于描述现实世界的对象的分类,如空间、新风机等
-2.平台字典,系统内置的一组类型定义和信息点定义数据,与集团和项目无关
-3.集团字典,是平台字典和集团自定义数据的并集(目前不提供集团自定义功能,若有自定义需求需联系研发处理)
-4.集团方案,根据业态不同,从集团字典中筛选(订阅)特定的类型和信息点形成方案,从而过滤掉实际业务中不关注的类型和信息点,集团方案是集团字典的子集,集团所拥有的项目必须应用一个且仅有一个集团方案
-5.项目字典,集团方案和项目自定义数据的并集(目前不提供项目自定义功能,若有自定义需求需联系研发处理)
-6.应用订阅,根据应用关注点不同,从项目字典中筛选(订阅)特定的类型和信息点,从而过滤掉应用不关注的类型和信息点,每个应用对每个项目都需要进行订阅配置
-7.
-8.
-
-```
-
-### 数据结构
-
-| 字段          | 数据类型 | 查询字段 | 说明                                                            |
-| ------------- | -------- | -------- | --------------------------------------------------------------- |
-| code          | String   | Y        | 全局唯一                                                        |
-| name          | String   | Y        | 类型名称                                                        |
-| aliasCode     | String   | Y        | 类型别名编码, 集团下唯一                                        |
-| aliasName     | String   | Y        | 类型别名名称                                                    |
-| type          | String   | Y        | 类别:平台级 common,集团级 group,项目级 project                  |
-| groupCode     | String   | Y        | 集团 id, type=group 或 type=project 时该字段为集团 id,否则为"0" |
-| projectId     | String   | Y        | 集团 id, type=project 时该字段为项目 id,否则为"0"               |
-| majorCode     | String   | Y        | 专业编码, 上级类型是系统 or 设备时该字段有值                    |
-| systemCode    | String   | Y        | 系统编码,上级类型是设备时该字段有值,值为系统类型的 code         |
-| equipmentCode | String   | Y        | 设备编码,上级类型是部件时该字段有值,值为系统类型的 code         |
-| parentCode    | String   | Y        | 上级类型 code                                                   |
-
-### 查询接口
-
-接口说明
-
-```
-1.若集团编码、方案id、项目id全部为空,则返回(符合查询条件的)平台级字典定义的类型数据
-2.若集团编码不为空,则返回集团级字典定义的类型数据
-3.若集团方案id不为空,则返回集团方案订阅的类型数据
-4.若项目id不为空,则返回项目级字典定义的类型数据
-5.若应用id不为空,则返回应用订阅的类型数据
-6.若subFlag=true,则按子分类信息点将类型拆分后返回
-7.不支持分页
-8.如果平台级、集团级、项目级均有相同code对应的类型数据,则按优先级顺序(项目级 > 集团级 > 平台级)返回高优先级的数据
-9.该接口已处理平台级、集团级、项目级三级字典逻辑,返回数据中type、groupCode、projectId三个字段可以忽略
-
-```
-
-请求方式
-
-```
-POST /rwd/def/class?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id&subFlag=false
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明                                                                                 |
-| --------- | -------- | ------------------------------------------------------------------------------------ |
-| groupCode | String   | 集团编码                                                                             |
-| schemeId  | String   | 方案 id                                                                              |
-| projectId | String   | 项目 id                                                                              |
-| appId     | String   | 应用 id, 若应用不为空则必须项目 id 同时不为空                                        |
-| subFlag   | Boolean  | 子分类标记,若为 true 则按子分类字段将类型拆解后返回,目前不支持指定类型进行子分类展开 |
-
-请求体
-
-```
-{
-    "criteria": {
-        "code": "ACATAH"
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "3b53b2e3019811eb9ef10242ac110002",
-            "code": "ACATAH",
-            "objType": "equipment",
-            "name": "空调机组",
-            "aliasCode": "ACATAH",
-            "aliasName": "空调机组",
-            "type": "common",
-            "groupCode": "0",
-            "projectId": "0",
-            "majorCode": "AC",
-            "systemCode": "ACAT",
-            "parentCode": "equipment"
-        }
-    ]
-}
-
-```

+ 0 - 146
docs/rwd/def_funcid.md

@@ -1,146 +0,0 @@
-### 数据说明
-
-```
-1.信息点定义,用于描述类型的属性
-2.默认每个类型都有id、name、localId、localName、objType、classCode、projectId,无需订阅,也不能取消订阅
-
-
-```
-
-### 数据结构
-
-| 字段       | 数据类型 | 查询字段 | 说明                                                                             |
-| ---------- | -------- | -------- | -------------------------------------------------------------------------------- |
-| code       | String   | Y        | 信息点编码,同类型下唯一                                                          |
-| name       | String   | Y        | 信息点名称                                                                       |
-| aliasCode  | String   | Y        | 信息点别编码,同类型下唯一                                                        |
-| aliasName  | String   | Y        | 信息点别名                                                                       |
-| classCode  | String   | Y        | 类型编码                                                                         |
-| type       | String   | Y        | 字典级别:平台级 common,集团级 group,项目级 project                               |
-| category   | String   | Y        | 信息点分类:静态,脉冲,阶段,时序                                                   |
-| groupCode  | String   | Y        | 集团 id, type=group 或 type=project 时该字段为集团 id,否则为"0"                  |
-| projectId  | String   | Y        | 集团 id, type=project 时该字段为项目 id,否则为"0"                                |
-| firstTag   | String   | Y        | 一级标签                                                                         |
-| secondTag  | String   | Y        | 二级标签                                                                         |
-| priority   | String   |          | 优先级                                                                           |
-| inputMode  | String   |          | 输入方式                                                                         |
-| unit       | String   |          | 单位                                                                             |
-| dataType   | String   | Y        | 数据类型                                                                         |
-| isMultiple | Boolean  |          | 是否复数                                                                         |
-| isRegion   | Boolean  |          | 是否区间                                                                         |
-| formater   | String   |          | 数据格式                                                                         |
-| dataSource | Object[] |          | 数据源取值范围/枚举值清单等,根据 dataType 有不同的内容                           |
-| note       | String   |          | 备注                                                                             |
-| subFlag    | String   | Y        | 子分类标记:是否可以按此信息点进行子分类替换,同一类型下目前只支持一个子分类信息点 |
-
-### 数据类型
-
-| 数据类型   | 类型名称 | 信息点分类          | 是否复数   | 是否区间   | 数据源                           | 格式    |
-| ---------- | -------- | ------------------- | ---------- | ---------- | -------------------------------- | ------- |
-| INTEGER    | 整数     | 静态/脉冲/时序/阶段 | true/false | true/false | {$gt:10, $lt:50}                 | 无      |
-| DOUBLE     | 浮点型   | 静态/脉冲/时序/阶段 | true/false | true/false | {$gte:10.1, $lt:50.9}            | 无      |
-| BOOLEAN    | 布尔值   | 静态/脉冲/时序/阶段 | true/false | false      | [0, 1]                           | 无      |
-| STRING     | 字符串   | 静态/脉冲/时序/阶段 | true/false | false      | (字符串长度区间){$gt:10, $lt:50} | 无      |
-| DATETIME   | 日期时间 | 静态/脉冲/时序/阶段 | true/false | true/false | {'$gt':'0915', '$lt':'1031'}     | 'MMdd'  |
-| ENUM       | 单选枚举 | 静态/脉冲/时序/阶段 | true/false | false      | 应用数据标准化中定义的数据类型   | 无      |
-| MENUM      | 多选枚举 | 静态/脉冲/时序/阶段 | true/false | false      | 应用数据标准化中定义的数据类型   | 无      |
-| ATTACHMENT | 附件     | 静态                | true/false | false      |                                  | pdf     |
-| OBJECT     | 对象     | 静态                | true/false | false      |                                  | 对象 id |
-
-说明
-
-```
-把原来的data_type拆解成多个属性,减少了data_type种类数量
-使用新的数据类型时,使用新的数据类型时,创建或编辑信息点需要明确指出数据类型、动静分类、是否复数、是否区间、长度(可选)、取值区间(可选)、格式(可选)
-Tree、Topology、Route、Function四种类型不再支持(有需求再加回来)
-
-动静分类(静态 STATIC、脉冲 PULSE、时序 SEQUENTIAL、阶段 GRADATION)应该是信息点的一个分类,不是数据类型的属性,放在这里是为了更直观更容易理解
-根据动静分类区分动态量或静态量,静态量的值存储的是具体的数据,动态量的值存储的是表号-功能号,动态量包括脉冲量、时序量和阶段量
-根据是否区间来判断存储的值是具体值还是区间, 比如INTEGER非区间的值12, 区间值[8, 15],为了区分开闭区间,这里实际存储为{$gt: 12, $lte: 15}, 其中$gt大于,$lt小于,$gte大于等于,$lte小于等于
-根据是否复数区分存储的值是单个值还是多个值,单个值存储形式为xxx,多个值存储形式为[xxx, yyy],如果同时是复数和区间,存储的是多个区间
-取值区间可以约束值的取值范围,可以通过取值区间做一次校验,如果是区间值,区间也应该是在取值区间的内部
-统一用DATETIME表示日期和时间,通过格式设定具体存储的内容,格式由数据字典进行维护,物理世界存储的数据严格符合格式
-格式是数据存储的数据格式或文件格式,对于日期时间附件对象等可进行校验
-单选枚举Enum单数存储为GC, 复数存储为[GC, JK]
-多选枚举MEnum单数存储为[GC, JK], 复数存储为[[GC], [GC,JK]], 多选枚举单数和单选枚举复数的存储形式一样应该不会出现问题,因为实际使用时是和类型(Enum,Menum)一起使用
-
-布尔值BOOLEAN只允许0或1, 其中0表示false,1表示true.
-```
-
-### 查询接口
-
-接口说明
-
-```
-1.若集团编码、方案id、项目id全部为空,则返回(符合查询条件的)平台级字典定义的数据
-2.若集团编码不为空,则返回集团级字典定义的数据
-3.若集团方案id不为空,则返回集团方案订阅的数据
-4.若项目id不为空,则返回项目级字典定义的数据
-5.若应用id不为空,则返回应用订阅的数据
-6.查询应带上classCode字段
-7.不支持分页
-8.如果平台级、集团级、项目级均有相同code对应的信息点数据,则按优先级顺序(项目级 > 集团级 > 平台级)返回高优先级的数据
-9.该接口已处理平台级、集团级、项目级三级字典逻辑,返回数据中type、groupCode、projectId三个字段可以忽略
-
-```
-
-请求方式
-
-```
-POST /rwd/def/funcid?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明                                          |
-| --------- | -------- | --------------------------------------------- |
-| groupCode | String   | 集团编码                                      |
-| schemeId  | String   | 方案 id                                       |
-| projectId | String   | 项目 id                                       |
-| appId     | String   | 应用 id, 若应用不为空则必须项目 id 同时不为空 |
-
-请求体
-
-```
-{
-    "criteria": {
-        "classCode": "ACATAH",
-        "category": "STATIC"
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "29bdf24e030d47cdb05cfde4c8028d59",
-            "code": "isFanGear",
-            "origCode": "isFanGear",
-            "name": "风机有无档位选项",
-            "aliasCode": "isFanGear",
-            "aliasName": "风机有无档位选项",
-            "classCode": "ACATFC",
-            "category": "STATIC",
-            "type": "common",
-            "groupCode": "0",
-            "projectId": "0",
-            "firstTag": "技术参数",
-            "secondTag": "风机",
-            "priority": "S",
-            "inputMode": "E1",
-            "dataType": "BOOLEAN",
-            "origDataType": "Bool",
-            "isMultiple": false,
-            "isRegion": false,
-            "subFlag": false,
-            "weakPoint": false
-        }
-    ]
-}
-
-```

+ 0 - 107
docs/rwd/def_graph.md

@@ -1,107 +0,0 @@
-# 图类型定义(Deprecated)
-
-## 数据结构
-
-### 图类型表(dt\_define\_graph)
-
-|      字段       |      字段说明      |   数据类型   | 是否非空 |               备注                |
-| :-------------: | :----------------: | :----------: | -------- | :-------------------------------: |
-|       id        | 主键(无业务含义) | varchar(40)  | Y        |  id全局唯一,命名规则:32位UUID   |
-|      code       |        编码        | varchar(40)  |          |                                   |
-|      name       |        名称        | varchar(200) |          |                                   |
-| first_category  |      一级分类      | varchar(40)  |          |                                   |
-| second_category |      二级分类      | varchar(40)  |          |                                   |
-|     remark      |      分类说明      | varchar(255) |          |                                   |
-|  object_types   |  关系两侧对象类别  | varchar(255) |          |                                   |
-|     creator     |      创建人员      | varchar(32)  |          |           创建的用户id            |
-|  creation_time  |      创建时间      |   char(14)   |          |       格式为yyyyMMddHHmmss        |
-|  modified_time  |    最后更新时间    |   char(14)   |          | 最后更新时间,格式为yyyyMMddHHmmss |
-|    modifier     |    最后更新人员    | varchar(32)  |          |         最后更新的用户id          |
-|      valid      |      合法标识      |  tinyint(4)  |          |           0-无效,1-有效           |
-|       ts        |       乐观锁       |  timestamp   | Y        |                                   |
-
-
-
-## 系统接口
-
-> #### (注:condition 为 query,create,update,delete)
->
-> #### (注:为了读写分离,serviceid还会变动,请不要写死)
->
-> #### (注:userId、groupCode、projectId必须传值,appId可以为空)
->
-> #### 请求方法:POST
-
-### 查询(请参考[通用查询](/utils/query.md))
-
-### 字典类型
-
-请求路径:/rwd/def/graph/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
-
-请求参数
-
-```json
-查询字段:
-{
-  "id": "dev_1",
-  "code": "PG",
-  "name": "major",
-  "firstCategory": "一级分类",
-  "secondCategory": "二级分类",
-  "remark": "分类说明",
-  "objectTypes": "关系两侧对象类别",
-  "creator": "wdl",
-  "creationTime": "20210813000000",
-  "modifier": "wdl",
-  "modifiedTime": "20210813000000",
-  "valid":1
-}
-新增:
-{
-  "code": "major",//非空
-  "name": "专业",//非空
-  "firstCategory": "Testing",
-  "secondCategory": "Testing",
-  "remark":"**",
-  "objectTypes":"**"  
-}
-更新:
-{
-  "id": "dev_1",//非空
-  "type": "major",
-  "name": "专业",
-  "description": "Testing",
-  "remark": "Testing"
-}
-删除:
-{
-  "id": ""
-}
-```
-
-
-
-## DDL语句
-
-### 图类型表
-
-```sql
-CREATE TABLE  IF NOT EXISTS `dt_define_graph` (
-  `id` varchar(40) NOT NULL,
-  `code` varchar(40) DEFAULT NULL COMMENT '编码',
-  `name` varchar(200) DEFAULT NULL COMMENT '名称',
-  `first_category` varchar(40) DEFAULT NULL COMMENT '一级分类',
-  `second_category` varchar(40) DEFAULT NULL COMMENT '二级分类',
-  `remark` varchar(255) DEFAULT NULL COMMENT '分类说明',
-  `object_types` varchar(255) DEFAULT NULL COMMENT '关系两侧对象类别',
-  `creator` varchar(32) DEFAULT NULL COMMENT '创建人',
-  `creation_time` char(14) DEFAULT NULL COMMENT '创建时间',
-  `modifier` varchar(32) DEFAULT NULL COMMENT '最后修改人',
-  `modified_time` char(14) DEFAULT NULL COMMENT '最后修改时间',
-  `valid` tinyint(4) DEFAULT NULL COMMENT '合法标识',
-  `ts` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '乐观锁',
-  PRIMARY KEY (`id`) USING BTREE,
-  KEY `idx_code` (`code`) USING BTREE
-) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='图类型表';
-```
-

+ 0 - 244
docs/rwd/instance_object.md

@@ -1,244 +0,0 @@
-### 数据说明
-
-```
-1.对象数据,即类型定义的实例,表示现实世界中的一个具体的物体,比如一个具体的房间,一个具体的空调
-2.
-
-
-```
-
-### 数据结构
-
-| 字段           | 数据类型       | 查询字段 | 说明                       |
-| -------------- | -------------- | -------- | -------------------------- |
-| id             | String         | Y        | id,全局唯一               |
-| name           | String         | Y        |                            |
-| localId        | String         | Y        |                            |
-| localName      | String         | Y        |                            |
-| projectId      | String         | Y        |                            |
-| classCode      | String         | Y        |                            |
-| objType        | String         | Y        |                            |
-| valid          | Integer        | Y        |                            |
-| createTime     | Date           | Y        |                            |
-| createApp      | String         |          |                            |
-| updateTime     | Date           | Y        |                            |
-| updateApp      | String         |          |                            |
-| 其他信息点编码 | 根据信息点定义 | Y        | 参数不当会严重影响查询性能 |
-|                |                |          |                            |
-
-### 创建对象
-
-接口说明
-
-```
-1.集团编码,项目id,appId,userId不可为空
-2.
-3.该接口为批量接口,任一对象创建失败则全部失败
-
-```
-
-请求方式
-
-```
-POST /rwd/instance/object/create
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-[
-    {
-        "id": "对象id, 调用方传入,若为空则生成默认id",
-        "classCode": "类型编码,不可为空",
-        "信息点编码": "信息点值"
-    }
-]
-
-```
-
-返回数据
-
-```
-{
-    "result": "success"
-}
-
-```
-
-### 更新对象
-
-接口说明
-
-```
-1.集团编码,项目id,appId,userId不可为空
-2.
-3.该接口为批量接口,任一对象更新失败则全部失败
-4.classCode不可修改
-
-```
-
-请求方式
-
-```
-POST /rwd/instance/object/update
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-[
-    {
-        "id": "对象id, 调用方传入,若为空则生成默认id,目前默认id为uuid",
-        "信息点编码": "信息点值",
-        "$remove": [ "要清除的信息点编码" ]
-    }
-]
-
-```
-
-返回数据
-
-```
-{
-    "result": "success"
-}
-
-```
-
-### 删除对象
-
-接口说明
-
-```
-1.集团编码,项目id,appId,userId不可为空
-2.
-3.该接口为批量接口
-4.对象删除后与该对象相关的关系数据也会被删除(异步,未实现)
-
-```
-
-请求方式
-
-```
-POST /rwd/instance/object/delete
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-[ "id1", "id2", "id3" ]
-```
-
-返回数据
-
-```
-{
-    "result": "success"
-}
-
-```
-
-### 查询对象
-
-请求方式
-
-```
-POST /rwd/instance/object/query
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id            |
-
-请求体
-
-```
-{
-    "criteria":{
-        "localId": [ "ATAH-20", "ATAH-21" ],
-        "classCode": "ACATAH",
-        "relationFrom": {
-            "graphId": "",
-            "graphCode": "",
-            "relCode": "",
-            "objTo": ""
-        },
-        "relationTo": {
-            "graphId": "",
-            "graphCode": "",
-            "relCode": "",
-            "objFrom": ""
-        },
-    },
-    "withColumns": [ "信息点1", "信息点2" ]
-}
-```
-
-请求参数说明
-
-```
-1.relationFrom和relationTo表示查询存在参数对应的关系数据的对象
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "count": 4,
-    "data": [
-        {
-            "id": "Eq1101050029022eb5d30eff4d33b42f246874650da8",
-            "classCode": "ACATAH",
-            "projectId": "Pj1101050029",
-            "grouping": 1,
-            "objType": "equipment",
-            "valid": 1,
-            "name": "设备-UYLQY",
-            "localId": "ATAH-20",
-            "localName": "吊顶式空气处理机组-F3公共通道-36",
-            "createTime": 1601511294000,
-            "createApp": "datautils",
-            "updateTime": 1602384680000,
-            "virtualInfoCodes": []
-        }
-    ]
-}
-
-```

+ 0 - 245
docs/rwd/instance_relation.md

@@ -1,245 +0,0 @@
-### 数据说明
-
-```
-1.关系数据描述具体的对象之间的关系
-2.
-
-```
-
-### 数据结构
-
-| 字段      | 数据类型 | 说明       |
-| --------- | -------- | ---------- |
-| graphId   | String   | 图实例 id  |
-| graphCode | String   | 图类型编码 |
-| relCode   | String   | 边类型     |
-| objFrom   | String   | 对象 id    |
-| objTo     | String   | 对象 id    |
-
-### 创建关系
-
-接口说明
-
-```
-1.项目ID不可为空
-2.appId不可为空(目前未校验)
-3.该接口为批量接口,任一关系创建失败则全部失败
-4.图类型编码和图实例id传入一个即可,graphId优先级高,如果传入graphId则忽略graphCode,如果传入graphCode未传入graphId,则默认取响应图类型的第一个图实例(按图实例id排序)
-
-```
-
-请求方式
-
-```
-POST /instance/relation/create?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-[
-    {
-        "graphCode": "图类型编码",
-        "graphId": "图类型Id",
-        "relCode": "边类型编码",
-        "objFrom": "",
-        "objTo": ""
-    }
-]
-
-```
-
-返回数据
-
-```
-{
-    "result": "success"
-}
-
-```
-
-### 删除关系
-
-接口说明
-
-```
-1.入参为JacksonCriteria, 先按参数查询数据, 然后将查询到的数据删除
-2.
-
-```
-
-请求方式
-
-```
-POST /rwd/instance/relation/delete?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-{
-    "criteria": {
-        "graphCode": "图类型编码",
-        "graphId": "图类型Id",
-        "relCode": "边类型编码",
-        "objFrom": "",
-        "objTo": ""
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success"
-}
-
-```
-
-### 查询关系
-
-请求方式
-
-```
-POST /rwd/instance/relation/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-{
-    "criteria": {
-        "graphCode": "图类型编码",
-        "graphId": "图类型Id",
-        "relCode": "边类型编码",
-        "objFrom": "",
-        "objTo": ""
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "9b88fb9496c94713ba41e2dc45861e89",
-            "projectId": "Pj1101050029",
-            "graphId": "GtArchSubset001",
-            "graphCode": "ArchSubset",
-            "relCode": "Fl2Sp",
-            "objFrom": "Fl11010500296bc7ca3a0d5d41419cf95c5b45116400",
-            "objTo": "Sp1101050029f79243a7cef34ffda9a09401274717b7",
-            "status": 1,
-            "createTime": 1601527142000,
-            "updateTime": 1601527142000
-        }
-    ],
-    "count": 1
-}
-
-```
-
-### 查询关系关联的对象
-
-接口说明
-
-```
-1.不支持分页
-2.objFrom和objTo两个字段必须且只能传入一个
-3.objectCriteria中可以传入多个查询参数
-4.
-```
-
-请求方式
-
-```
-POST /rwd/instance/relation/object/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| schemeId  | String   | 方案 id            |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-| userId    | String   | 用户 id, 不可为空  |
-
-请求体
-
-```
-{
-    "criteria": {
-        "graphCode": "图类型编码",
-        "graphId": "图类型Id",
-        "relCode": "边类型编码",
-        "objFrom": "",
-        "objTo": "",
-        "objectCriteria": {
-            "classCode": "ACATAH"
-        }
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "9b88fb9496c94713ba41e2dc45861e89",
-            "projectId": "Pj1101050029",
-            "graphId": "GtArchSubset001",
-            "graphCode": "ArchSubset",
-            "relCode": "Fl2Sp",
-            "objFrom": "Fl11010500296bc7ca3a0d5d41419cf95c5b45116400",
-            "objTo": "Sp1101050029f79243a7cef34ffda9a09401274717b7",
-            "status": 1,
-            "createTime": 1601527142000,
-            "updateTime": 1601527142000
-        }
-    ],
-    "count": 1
-}
-
-```

+ 0 - 275
docs/rwd/iot.md

@@ -1,275 +0,0 @@
-### 通用参数说明
-
-以下参数放在 url 后
-
-| 字段      | 数据类型 | 说明               |
-| --------- | -------- | ------------------ |
-| groupCode | String   | 集团编码, 不可为空 |
-| projectId | String   | 项目 id, 不可为空  |
-| appId     | String   | 应用 id, 不可为空  |
-
-### 基础接口: 查询实时数据
-
-接口说明
-
-```
-查询对象绑点信息点的实时数据
-```
-
-请求地址
-
-```
-POST: /rwd/iot/data/current
-```
-
-请求参数
-
-```
-[
-    { "objectId": "Eqxxxxx", "infoCode": "tdb" },
-    { "objectId": "Eqxxxxx", "infoCode": "co2" },
-    { "objectId": "Eqxxxxx", "infoCode": "hcho" }
-]
-```
-
-返回内容
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "tdb",
-            "infoValue": "8000-123",
-            "data": 25.6,
-            "time": "20200512172435"
-        },
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "tdb",
-            "infoValue": "8000-123",
-            "data": 25.6,
-            "time": "20200512172435"
-        },
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "tdb",
-            "error": "错误信息:信息点不存在,表号功能号配置错误,断数等"
-        }
-    ]
-}
-```
-
-返回内容说明
-
-```
-    infoValue: 信息点配置的内容即绑定的表号功能号
-    time: 实时数据的采集时间
-    data: 实时数据的值
-
-```
-
-### 基础接口: 查询历史数据/分精度数据
-
-接口说明
-
-```
-查询对象绑点信息点的历史数据
-1. 多点位个数最多支持50个
-2. 分钟级数据,单点位支持最大7天数据查询,多点位支持最大1天数据查询;
-3. 小时级数据,单点支持最大30天数据查询,多点位支持最大3天数据查询;
-4. 日级数据,单点支持最大1年数据查询,多点位支持最大30天数据查询;
-```
-
-请求地址
-
-```
-POST: /rwd/iot/data/history
-```
-
-请求参数
-
-```
-{
-    "startTime": "20200415120000",
-    "endTime": "20200501120000",
-    "period": "分精度类型,支持 1min、5min、15min、1h、1d",
-    "params": [
-        {
-            "objectId": "对象id",
-            "infoCode": "信息点编码",
-        },
-        {
-            "objectId": "对象id",
-            "infoCode": "信息点编码",
-        }
-    ]
-}
-```
-
-参数说明
-
-```
-
-    startTime:
-    period: 必填,间隔
-    objectId: 必填,对象id
-    infoCode: 必填,信息点ID
-```
-
-返回内容
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "objectId": "对象id",
-            "infoCode": "信息点编码",
-            "data": [
-                {
-                    "time": "20200415120000"
-                    "data": 25.6,
-                },
-                {
-                    "time": "20200415120500"
-                    "data": 25.6,
-                }
-            ]
-        },
-        {
-            "objectId": "对象id",
-            "infoCode": "信息点编码",
-            "data": [
-                {
-                    "time": "20200415120000"
-                    "data": 25.6,
-                },
-                {
-                    "time": "20200415120500"
-                    "data": 25.6,
-                }
-            ]
-        }
-    ]
-}
-```
-
-返回内容说明
-
-```
-返回数据的time可能是不连续的
-
-```
-
-### 基础接口: 发送控制指令/设定动态参数
-
-接口说明
-
-```
-该接口为异步方式
-
-```
-
-请求地址
-
-```
-POST: /rwd/iot/funcid/setting
-```
-
-请求参数
-
-```
-[
-    { "objectId": "Eqxxxxx", "infoCode": "FanFreqSet", value: 24 },
-    { "objectId": "Eqxxxxx", "infoCode": "InValveSwitchSet", value: "a" },
-    { "objectId": "Eqxxxxx", "infoCode": "WaterInOutDetaTempSet", value: 10 }
-]
-```
-
-请求参数说明
-
-```
-value要严格匹配信息点定义的数据类型
-```
-
-返回内容
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "FanFreqSet",
-            "exeCode":"sfge131v4t2vs3423rbsb3"
-        },
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "InValveSwitchSet",
-            "exeCode":"sfge131v4t2vs3423rbsb3"
-        },
-        {
-            "objectId": "Eqxxxxx",
-            "infoCode": "InValveSwitchSet",
-            "exeCode":"sfge131v4t2vs3423rbsb3"
-        }
-    ]
-}
-```
-
-返回内容说明
-
-```
-    exeCode: 指令查询码,用于查询指令执行结果
-```
-
-### 基础接口: 查询指令执行结果
-
-请求地址
-
-```
-POST: /iot/funcid/settingQuery
-```
-
-请求参数
-
-```
-[ "sfge131v4t2vs3423rbqb3", "e1ge131v4t2vs3423rbsb3", "eaqge131v4t2vs3423rger" ]
-```
-
-返回内容
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "exeCode": "sfge131v4t2vs3423rbqb3",
-            "exeResult": "timeout",
-        },
-        {
-            "exeCode": "e1ge131v4t2vs3423rbsb3",
-            "exeResult": "running",
-        },
-        {
-            "exeCode": "eaqge131v4t2vs3423rger",
-            "exeResult": "failed",
-        }
-    ]
-}
-```
-
-控制指令执行结果说明(待定)
-
-```
-
-控制指令执行结果为一个字符串,其可能值有以下几种:
-- finish:success,执行完成
-- timeout,表示控制指令已下发但超过了合理响应时间(默认1minute,系统可配置)至今一直为得到反馈
-- running,表示控制指令已下发在合理响应时间内还未得到反馈
-- failed,指令未下发出去
-- success-offline,指令已下发出去,并得到了反馈,'success-'后面的字符为反馈的信息
-
-```

+ 38 - 34
docs/rwd/rwd_api.md

@@ -2,9 +2,11 @@ dmp-rwd接口
 
 ## 物理世界对象接口
 
-### 21001 查询物理世界对象
+### 21001 查询物理世界对象(Deprecated)
 
-接口:`http://localhost:8831/dmp-rwd/rwd/instance/object/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
 #### 请求方式
 
@@ -116,7 +118,7 @@ POST请求
 
 
 
-### 21002 新增物理世界对象-单个新增
+### 21002 新增物理世界对象-单个新增(Deprecated)
 
 #### 接口
 
@@ -185,7 +187,7 @@ POST请求
 
 
 
-### 21003 新增物理世界对象-批量新增
+### 21003 新增物理世界对象-批量新增(Deprecated)
 
 #### 接口
 
@@ -258,7 +260,7 @@ POST请求
 
 
 
-### 21004 更新物理世界对象数据-单个更新
+### 21004 更新物理世界对象数据-单个更新(Deprecated)
 
 #### 接口
 
@@ -322,7 +324,7 @@ POST请求
 
 
 
-### 21005 更新物理世界对象数据-批量更新
+### 21005 更新物理世界对象数据-批量更新(Deprecated)
 
 #### 接口
 
@@ -390,7 +392,7 @@ POST请求
 
 
 
-### 21006 删除物理世界对象数据-单个删除
+### 21006 删除物理世界对象数据-单个删除(Deprecated)
 
 #### 接口
 
@@ -441,7 +443,7 @@ POST请求
 
 
 
-### 21007 删除物理世界对象数据-批量删除
+### 21007 删除物理世界对象数据-批量删除(Deprecated)
 
 #### 接口
 
@@ -492,9 +494,11 @@ POST请求
 
 
 
-### 22001 查询物理世界对象关系
+### 22001 查询物理世界对象关系(Deprecated)
+
+#### 接口
 
-接口:`http://localhost:8831/dmp-rwd/rwd/instance/relation/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+`http://localhost:8831/dmp-rwd/rwd/instance/relation/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
 #### 请求方式
 
@@ -582,7 +586,7 @@ POST请求
 
 
 
-### 22002 新增物理世界对象关系-单个新增
+### 22002 新增物理世界对象关系-单个新增(Deprecated)
 
 #### 接口
 
@@ -672,7 +676,7 @@ POST请求
 
 
 
-### 22003 新增物理世界对象关系-批量新增
+### 22003 新增物理世界对象关系-批量新增(Deprecated)
 
 #### 接口
 
@@ -768,7 +772,7 @@ POST请求
 
 ## 图类型接口
 
-### 23001 查询图类型
+### 23001 查询图类型(Deprecated)
 
 接口:`http://localhost:8831/dmp-rwd/rwd/def/graph/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
@@ -873,7 +877,7 @@ POST请求
 
 
 
-### 23002 新增图类型
+### 23002 新增图类型(Deprecated)
 
 #### 接口
 
@@ -966,7 +970,7 @@ POST请求
 
 
 
-### 23003 更新图类型
+### 23003 更新图类型(Deprecated)
 
 #### 接口
 
@@ -1061,7 +1065,7 @@ POST请求
 
 
 
-### 23004 删除图类型
+### 23004 删除图类型(Deprecated)
 
 #### 接口
 
@@ -1114,7 +1118,7 @@ POST请求
 
 ## 边类型接口
 
-### 24001 查询边类型
+### 24001 查询边类型(Deprecated)
 
 接口:`http://localhost:8831/dmp-rwd/rwd/def/rel/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
@@ -1223,7 +1227,7 @@ POST请求
 
 
 
-### 24002 新增边类型
+### 24002 新增边类型(Deprecated)
 
 #### 接口
 
@@ -1320,7 +1324,7 @@ POST请求
 
 
 
-### 24003 更新边类型
+### 24003 更新边类型(Deprecated)
 
 #### 接口
 
@@ -1429,7 +1433,7 @@ POST请求
 
 
 
-### 24004 删除边类型
+### 24004 删除边类型(Deprecated)
 
 #### 接口
 
@@ -1516,7 +1520,7 @@ Tree、Topology、Route、Function四种类型不再支持(有需求再加回来
 布尔值BOOLEAN只允许0或1, 其中0表示false,1表示true.
 ```
 
-### 25001 查询对象信息点
+### 25001 查询对象信息点(Deprecated)
 
 接口:`http://localhost:8831/dmp-rwd/rwd/def/funcid?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
@@ -1689,7 +1693,7 @@ POST请求
 
 
 
-### 25002 新增对象信息点
+### 25002 新增对象信息点(Deprecated)
 
 #### 接口
 
@@ -1850,7 +1854,7 @@ POST请求
 
 
 
-### 25003 新增对象信息点-批量新增
+### 25003 新增对象信息点-批量新增(Deprecated)
 
 #### 接口
 
@@ -2015,7 +2019,7 @@ POST请求
 
 
 
-### 25004 更新对象信息点
+### 25004 更新对象信息点(Deprecated)
 
 #### 接口
 
@@ -2188,7 +2192,7 @@ POST请求
 
 
 
-### 25005 更新对象信息点-批量更新
+### 25005 更新对象信息点-批量更新(Deprecated)
 
 #### 接口
 
@@ -2365,7 +2369,7 @@ POST请求
 
 
 
-### 25006 删除对象信息点
+### 25006 删除对象信息点(Deprecated)
 
 #### 接口
 
@@ -2416,7 +2420,7 @@ POST请求
 
 
 
-### 25007 删除对象信息点-批量删除
+### 25007 删除对象信息点-批量删除(Deprecated)
 
 #### 接口
 
@@ -2469,7 +2473,7 @@ POST请求
 
 ## 对象类型定义接口
 
-### 26001 查询对象类型定义
+### 26001 查询对象类型定义(Deprecated)
 
 接口:`http://localhost:8831/dmp-rwd/rwd/def/class?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
 
@@ -2600,7 +2604,7 @@ POST请求
 
 
 
-### 26002 新增对象类型定义
+### 26002 新增对象类型定义(Deprecated)
 
 #### 接口
 
@@ -2721,7 +2725,7 @@ POST请求
 
 
 
-### 26003 新增对象类型定义-批量新增
+### 26003 新增对象类型定义-批量新增(Deprecated)
 
 #### 接口
 
@@ -2846,7 +2850,7 @@ POST请求
 
 
 
-### 26004 更新对象类型定义
+### 26004 更新对象类型定义(Deprecated)
 
 #### 接口
 
@@ -2979,7 +2983,7 @@ POST请求
 
 
 
-### 26005 更新对象类型定义-批量更新
+### 26005 更新对象类型定义-批量更新(Deprecated)
 
 #### 接口
 
@@ -3116,7 +3120,7 @@ POST请求
 
 
 
-### 26006 删除对象类型定义
+### 26006 删除对象类型定义(Deprecated)
 
 #### 接口
 
@@ -3167,7 +3171,7 @@ POST请求
 
 
 
-### 26007 删除对象类型定义-批量删除
+### 26007 删除对象类型定义-批量删除(Deprecated)
 
 #### 接口
 

+ 0 - 225
docs/rwd/schema.md

@@ -1,225 +0,0 @@
-### 字典订阅
-
-#### 集团方案
-
-```
-目前只提供集团方案的创建、编辑和查询接口
-
-```
-
-数据结构
-| 字段 | 数据类型 | 查询字段 | 说明 |
-| ------------- | -------- | -------- | --------------------------------------------------------------- |
-| id | String | Y | 全局唯一 |
-| name | String | Y | 名称,不可为空 |
-| groupCode | String | Y | 集团编码, 不可为空 |
-| remark | String | Y | 备注 |
-| status | String | Y | 状态 |
-
-###### 查询
-
-请求方式
-
-```
-POST /rwd/schema/query?groupCode=集团编码
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码,不可为空 |
-
-请求体
-
-```
-{
-    "criteria": {
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "ZS-BUSI",
-            "name": "商业",
-            "groupCode": "ZS",
-            "status": 1
-        }
-    ],
-    "count": 1
-}
-
-```
-
-###### 创建
-
-请求方式
-
-```
-POST /rwd/schema/create?groupCode=集团编码
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码,不可为空 |
-
-请求体
-
-```
-{
-    "id": "ZS-BUSI2",
-    "name": "商业2"
-}
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": {
-        "id": "ZS-BUSI2"
-    }
-}
-
-```
-
-###### 编辑
-
-```
-只能更新name和remark字段
-```
-
-请求方式
-
-```
-POST /rwd/schema/update?groupCode=集团编码
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码,不可为空 |
-
-请求体
-
-```
-{
-    "id": "ZS-BUSI2",
-    "name": "商业3"
-}
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": {
-        "id": "ZS-BUSI2"
-    }
-}
-
-```
-
-#### 配置项目方案
-
-```
-项目必须配置一个集团方案,且配置后不允许修改
-```
-
-数据结构
-| 字段 | 数据类型 | 查询字段 | 说明 |
-| ------------- | -------- | -------- | --------------------------------------------------------------- |
-| groupCode | String | Y | 集团编码, 不可为空 |
-| schemaId | String | Y | 集团方案 ID, 不可为空 |
-| projectId | String | Y | 项目 Id, 不可为空 |
-
-###### 查询
-
-请求方式
-
-```
-POST /rwd/schema/project/query?groupCode=集团编码
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码,不可为空 |
-
-请求体
-
-```
-{
-    "criteria": {
-    }
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": [
-        {
-            "id": "ZS-BUSI-Pj4403050019",
-            "schemaId": "ZS-BUSI",
-            "groupCode": "ZS",
-            "projectId": "Pj4403050019"
-        }
-    ],
-    "count": 1
-}
-
-```
-
-###### 创建
-
-请求方式
-
-```
-POST /rwd/schema/project/create?groupCode=集团编码
-```
-
-路径参数说明
-
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码,不可为空 |
-
-请求体
-
-```
-{
-    "id": "ZS-BUSI-Pj4403050019",
-    "schemaId": "ZS-BUSI",
-    "projectId": "Pj4403050019"
-}
-
-```
-
-返回数据
-
-```
-{
-    "result": "success",
-    "data": {
-        "id": "ZS-BUSI-Pj4403050019"
-    }
-}
-
-```