Browse Source

调整接口文档

lijie 3 years ago
parent
commit
edcbacd278
1 changed files with 159 additions and 36 deletions
  1. 159 36
      docs/rwd/rwd_api.md

+ 159 - 36
docs/rwd/rwd_api.md

@@ -43,6 +43,66 @@ dmp-rwd接口
 
 
 
+## 特殊说明
+
+### 1.查询列表接口默认分页说明
+
+​	以下提供分页参数的接口如果没传分页参数dmp-rwd会默认分页,分页规则:优先取环境变量`persagy.bdtp.rwd.page.size`配置的分页条数,如果未配置会默认为500条数据
+
+
+
+### 2.信息点数据类型(dataType属性)
+
+| 数据类型   | 类型名称 | 信息点分类          | 是否复数   | 是否区间   | 数据源                           | 格式    |
+| ---------- | -------- | ------------------- | ---------- | ---------- | -------------------------------- | ------- |
+| 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.
+```
+
+### 3.信息点优先级说明
+
+| 枚举值 | 含义说明                     |
+| ------ | ---------------------------- |
+| S      | 对象类最核心的属性点         |
+| M      | 对象类一般重要的属性点       |
+| R      | 对象类不太重要的参考性属性点 |
+
+### 4.信息点输入方式说明(待补充)
+
+| 枚举值 | 含义说明 |
+| ------ | -------- |
+|        |          |
+
+
+
+
+
 ## 物理世界对象接口
 
 ### 21001 查询物理世界对象(Deprecated)
@@ -1612,8 +1672,8 @@ POST请求
 | relCode     |      | 是       | 关系类型编码                                                 |
 | graphCode   |      | 是       | 图类型编码                                                   |
 | relValue    |      | 否       | 关系值,一般空间关系会有,为空间的对象类型                     |
-| mainContent |      | 否       | 主对象的筛选关键字,筛选范围为id,name,local_id,local_name,cADID |
-| fromContent |      | 否       | 从对象的筛选关键字.objTo对应的对象,筛选范围为id,name,local_id,local_name |
+| mainContent |      | 否       | 主对象的筛选关键字,筛选范围为id,name,local_id,local_name,cADID.为关系左侧对象 |
+| fromContent |      | 否       | 从对象的筛选关键字.objTo对应的对象,筛选范围为id,name,local_id,local_name.为关系右侧对象 |
 | page        |      | 否       | 分页页数,从1开始                                             |
 | size        |      | 否       | 分页条数                                                     |
 
@@ -2785,40 +2845,6 @@ POST请求
 
 ## 对象信息点接口
 
-### 数据类型(dataType属性)
-
-| 数据类型   | 类型名称 | 信息点分类          | 是否复数   | 是否区间   | 数据源                           | 格式    |
-| ---------- | -------- | ------------------- | ---------- | ---------- | -------------------------------- | ------- |
-| 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.
-```
-
 ### 25001 查询对象信息点(Deprecated)
 
 接口:`http://localhost:8831/dmp-rwd/rwd/def/funcid?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
@@ -5060,3 +5086,100 @@ POST请求
 | -------------------- | ---- | -------- |
 | 2021年9月2日20:56:41 | 新增 | 新增接口 |
 
+
+
+### 29003 关系计算接口
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/compatible/calculatingObjRelation?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   |
+
+#### 参数例子
+
+```
+{
+    "graphCode":"****",
+	"relCode":"****",
+	"dependentRels":[
+		{
+            "graphCode":"***",
+            "relCode":"***"
+		}
+	]
+	"sign":["***"]
+}
+```
+
+| 字段          | 是否必须 | 字段说明                             |
+| ------------- | -------- | ------------------------------------ |
+| graphCode     | 是       | 图类型编码                           |
+| relCode       | 是       | 边类型编码                           |
+| dependentRels | 是       | 依赖的关系的图类型编码和边类型编码   |
+| filterSigns   | 否       | 过滤的计算标记,1-手动计算,2-自动计算 |
+
+#### 成功例子
+
+```
+{
+    "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年9月2日20:56:41 | 新增 | 新增接口 |
+
+
+