Browse Source

Merge branch 'master' of git.sagacloud.cn:persagy/persagy-dmp-server-doc

yaoll 4 years ago
parent
commit
18fb2d2d27

+ 33 - 1
docs/.vuepress/config.js

@@ -5,14 +5,36 @@ module.exports = {
     themeConfig: {
 
         nav: [{ text: '主页', link: '/' },
+            { text: '通用查询接口', link: '/utils/query' },
             { text: '物理世界', link: '/rwd/' },
             { text: '人员组织权限', link: '/org/' },
-            { text: '数据标准化', link: '/dic/'}
+            { text: '数据标准化', link: '/dic/'},
+            { text: '任务调度', link: '/dpt/' },
+            { text: '报警系统', link: '/alarm/'}
             ],
 
         sidebarDepth: 1,
         displayAllHeaders: true,
         sidebar: {
+            '/utils/query': [
+                {
+                    title: '通用查询接口',
+                    collapsable: false,
+                    children: [
+                        {title: '通用查询', path: '/utils/query'}
+                    ]
+                }
+            ],
+            '/alarm': [
+                {
+                    title: '报警系统',
+                    collapsable: false,
+                    children: [
+                        {title: '接口文档', path: '/alarm/alarm_api'},
+                        {title: '数据结构设计', path: '/alarm/alarm_design'}
+                    ]
+                }
+            ],
             '/org': [
                 {
                     title: '人员组织权限',
@@ -23,6 +45,16 @@ module.exports = {
                     ]
                 }
             ],
+            '/dpt': [
+                {
+                    title: '数据标准化',
+                    collapsable: false,
+                    children: [
+                        {title: '接口文档', path: '/dpt/dpt_api'},
+                        {title: '数据结构设计', path: '/dpt/dpt_design'}
+                    ]
+                }
+            ],
             '/dic': [
                 {
                     title: '数据标准化',

+ 237 - 0
docs/alarm/alarm_api.md

@@ -0,0 +1,237 @@
+# 报警系统接口文档
+
+## 系统接口
+
+### (注:condition 为 query,create,update,delete)
+
+### (注:为了读写分离,serviceid还会变动,请不要写死)
+
+### (注:userId、groupCode、projectId必须传值,appId可以为空)
+
+#### 请求方法:POST
+#### 查询
+
+[通用查询](/utils/query.md)
+
+#### 报警条目(注:condition 为 query)
+
+请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "code": "1033",
+  "name": "测试报警",
+  "category": "消防报警",
+  "level": "S",
+  "condition": {}, //额外写文档
+  "remark": "测试数据",
+  "dealFun": "test_deal_fun",
+  "createUser": "test",
+  "createTime": 1602962584000,
+  "updateUser": "test",
+  "updateTime": 1602962586000,
+  "valid": 1
+}
+```
+
+#### 报警匹配规则(注:condition 为 query,create,update,delete)
+
+请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "condition": {}, //额外写文档
+  "concern": 1,
+  "open": 2,
+  "createUser": "test",
+  "createTime": 1602963135000,
+  "updateUser": "test",
+  "updateTime": 1602963138000,
+  "valid": 1
+}
+新增:
+{
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "concern": 1,
+  "open": 2,
+  "condition": {}, //额外写文档
+  "valid": 1
+}
+更新:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "concern": 1,
+  "open": 2,
+  "condition": {}, //额外写文档
+  "valid": 1
+}
+删除:
+{
+  "id": "1"
+}
+```
+
+#### 报警定义(注:condition 为 query,update)
+
+请求路径:/alarm/config/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "objId": "OBJ_1",
+  "projectId": "PRJ_WD_001",
+  "itemCode": "1033",
+  "category": "消防报警",
+  "level": "S",
+  "condition": {}, //额外写文档
+  "remark": "测试数据",
+  "open": 1,
+  "concern": 1,
+  "userDefined": 1,
+  "createUser": "test",
+  "createTime": 1602962781000,
+  "updateUser": "test",
+  "updateTime": 1602962783000,
+  "valid": 1
+}
+更新:
+{
+  "id": "1",
+  "objId": "OBJ_1",
+  "projectId": "PRJ_WD_001",
+  "itemCode": "1033",
+  "category": "消防报警",
+  "level": "S",
+  "condition": {}, //额外写文档
+  "remark": "测试数据",
+  "open": 1,
+  "concern": 1,
+  "userDefined": 1,
+  "valid": 1
+}
+```
+
+####  报警记录(注:condition 为 query,create,update)
+
+请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "projectId": "PRJ_WD_001",
+  "objId": "OBJ_1",
+  "level": "S",
+  "remark": "测试数据",
+  "name": '报警名称',
+  "category": '报警分类',
+  "concern": 1,
+  "nature": "报警性质",
+  "treat_mode": "处理方式",
+  "treat_state": "处理状态",
+  "state": "报警状态",
+  "effectStartTime": 1602953256000 ,
+  "effectEndTime": 1602953256000 ,
+  "createUser": "test",
+  "createTime": 1602953249000,
+  "updateUser": "test",
+  "updateTime": 1602953256000,
+  "valid": 1
+}
+新增:
+{
+  "itemCode": "1033",
+  "projectId": "PRJ_WD_001",
+  "objId": "OBJ_1",
+  "level": "S",
+  "remark": "测试数据",
+  "name": '报警名称',
+  "category": '报警分类',
+  "concern": 1,
+  "nature": "报警性质",
+  "treat_mode": "处理方式",
+  "treat_state": "处理状态",
+  "state": "报警状态",
+  "effectStartTime": 1602953256000,
+  "effectEndTime": 1602953256000
+}
+更新:
+{
+  "id": "1",
+  "remark": "测试数据",
+  "name": '报警名称',
+  "state": "报警状态",
+  "nature": "报警性质",
+  "treat_mode": "处理方式",
+  "treat_state": "处理状态"
+}
+```
+
+#### 报警日志(注:condition 为 query,create)
+
+请求路径:/alarm/log/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "record_id": "1033",
+  "type": "报警类型",
+  "remark": "备注",
+  "create_time": 1602953249000,
+  "update_time": 1602953249000,
+  "valid": 1
+}
+新增:
+{
+  "record_id": "1033",
+  "type": "报警类型",
+  "remark": "备注"
+}
+```
+
+#### 报警批注(注:condition 为 query,create)
+
+请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "record_id": "1033",
+  "content": 1,
+  "createUser": "TEST",
+  "createTime": 1602953249000,
+  "updateTime": 1602953249000,
+  "updateUser": "TEST",
+  "valid": 1
+}
+新增:
+{
+  "record_id": "1033",
+  "content": "内容"
+}
+```

+ 73 - 0
docs/alarm/alarm_ddl_sql.md

@@ -0,0 +1,73 @@
+# 报警条目 alarm_item
+
+```sql
+CREATE TABLE alarm_item(
+    id VARCHAR(40) NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    code VARCHAR(40)    COMMENT '报警条目编码' ,
+    name VARCHAR(10)    COMMENT '报警条目名称' ,
+    category VARCHAR(10)    COMMENT '报警分类' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '备注' ,
+    condition TEXT    COMMENT '触发条件' ,
+    deal_fun VARCHAR(40)    COMMENT '处理算法' ,
+  	create_user VARCHAR(40) COMMENT '',
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警条目';
+```
+
+# 报警条目匹配对象 alarm_target
+
+```sql
+CREATE TABLE alarm_target(
+    id VARCHAR(40)  NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    item_id VARCHAR(40)    COMMENT '报警条目id' ,
+    class_code VARCHAR(40)    COMMENT '对象类型' ,
+    condition TEXT    COMMENT '触发条件' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警条目匹配对象';
+```
+
+# 报警定义 alarm_config
+
+```sql
+CREATE TABLE alarm_config(
+    id VARCHAR(40) NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    obj_id VARCHAR(50)    COMMENT '对象id' ,
+    project_id VARCHAR(50)    COMMENT '项目id' ,
+    item_code VARCHAR(40)    COMMENT '报警条目编码' ,
+    category VARCHAR(10)    COMMENT '报警分类' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '备注' ,
+    condition TEXT    COMMENT '触发条件' ,
+    open INT    COMMENT '屏蔽状态' ,
+    concern INT    COMMENT '是否重点关注' ,
+    user_defined INT    COMMENT '是否自定义' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警定义';
+```
+
+# 报警记录 alarm_record
+
+```sql
+CREATE TABLE alarm_record(
+    id VARCHAR(40)  NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    item_code VARCHAR(40)    COMMENT '报警条目编码' ,
+    project_id VARCHAR(40)    COMMENT '项目id' ,
+    obj_id VARCHAR(40)    COMMENT '对象id' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '报警描述' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警记录';
+```

+ 91 - 0
docs/alarm/alarm_design.md

@@ -0,0 +1,91 @@
+# 报警系统
+
+## 数据结构
+
+### 报警条目(alarm_item)
+
+|   字段    |      字段说明      |   数据类型   | 是否非空 |           备注           |
+| :-------: | :----------------: | :----------: | -------- | :----------------------: |
+|    id     | 主键(无业务含义) | varchar(80)  | Y        | 全局唯一,UUID无实际意义 |
+|   code    |    报警条目编码    | varchar(80)  | Y        |                          |
+|   name    |    报警条目名称    | varchar(40)  | Y        |                          |
+| category  |      报警分类      | varchar(200) |          |                          |
+|   level   |      严重程度      | varchar(10)  |          |                          |
+| deal_fun  |      处理算法      |   datetime   | Y        |                          |
+| condition |      触发条件      |     Json     |          |                          |
+|   valid   |      删除标记      | varchar(40)  | Y        |      1:true,0:false      |
+|  remark   |      备注信息      | varchar(200) |          |                          |
+
+### 报警匹配规则(alarm_target)
+
+用于保存 报警条目与对象信息点 的 匹配规则
+
+|    字段    |   字段说明   |   数据类型   | 是否非空 |           备注           |
+| :--------: | :----------: | :----------: | -------- | :----------------------: |
+|     id     |              | varchar(80)  | Y        | 全局唯一,UUID无实际意义 |
+| item_code  |  报警条目id  | varchar(80)  | Y        |                          |
+| class_code |   对象类型   | varchar(80)  | Y        |                          |
+|    open    | 是否屏蔽状态 |     int      |          |        默认不屏蔽        |
+|  concern   | 是否重点关注 |     int      |          |     默认不是重点关注     |
+| condition  |   触发条件   |     Json     | Y        |                          |
+|   valid    |   删除标记   |     int      | Y        |      1:true,0:false      |
+|   remark   |   备注信息   | varchar(200) |          |                          |
+
+### 报警定义(alarm_config)
+
+|     字段     |   字段说明   |   数据类型   |      |           备注           |
+| :----------: | :----------: | :----------: | ---- | :----------------------: |
+|      id      |     主键     | varchar(80)  | Y    | 全局唯一,UUID无实际意义 |
+|    obj_id    |    对象id    | varchar(80)  | Y    |                          |
+|  project_id  |    项目id    | varchar(80)  | Y    |                          |
+|  item_code   | 报警条目编码 | varchar(20)  | Y    |                          |
+|   category   |   报警类型   | varchar(80)  | Y    |                          |
+|    level     |   严重程度   | varchar(40)  | Y    |                          |
+|  condition   |   触发条件   |     json     | Y    |                          |
+|     open     |   屏蔽状态   |   datetime   |      |                          |
+|   concern    | 是否重点关注 |     int      |      |                          |
+| user_defined |  是否自定义  |     int      |      |                          |
+|    valid     |   删除标记   |     int      | Y    |      1:true,0:false      |
+|    remark    |     备注     | varchar(200) |      |                          |
+
+### 报警记录(alarm_record)
+
+|    字段     |      字段说明      |   数据类型   |      |           备注           |
+| :---------: | :----------------: | :----------: | ---- | :----------------------: |
+|     id      | 主键(无业务含义) | varchar(80)  | Y    | 全局唯一,UUID无实际意义 |
+|  item_code  |    报警条目编码    | varchar(20)  | Y    |      对应字典数据id      |
+| project_id  |       项目id       | varchar(40)  | Y    |       对应字典类型       |
+|   obj_id    |       对象id       | varchar(20)  | Y    |                          |
+|   nature    |      报警性质      | varchar(10)  |      |                          |
+| treat_mode  |      处理方式      | varchar(10)  |      |                          |
+| treat_state |      处理状态      | varchar(10)  |      |                          |
+|    level    |      严重程度      | varchar(20)  | Y    |            1             |
+|    valid    |      删除标记      |     int      | Y    |      1:true,0:false      |
+|   remark    |      报警描述      | varchar(200) |      |                          |
+
+### 报警日志(alarm_target)
+
+用于保存 报警条目与对象信息点 的 匹配规则
+
+|   字段    |  字段说明  |  数据类型   | 是否非空 |           备注           |
+| :-------: | :--------: | :---------: | -------- | :----------------------: |
+|    id     |            | varchar(80) | Y        | 全局唯一,UUID无实际意义 |
+| record_id | 报警记录id | varchar(80) | Y        |                          |
+|   type    |  报警类型  | varchar(80) |          |                          |
+|  userId   |            |             |          |                          |
+|  remark   |    备注    |   varchar   |          |                          |
+|   valid   |            |     int     |          |                          |
+
+### 报警批注(alarm_target)
+
+用于保存 报警条目与对象信息点 的 匹配规则
+
+|   字段    |   字段说明   |  数据类型   | 是否非空 |           备注           |
+| :-------: | :----------: | :---------: | -------- | :----------------------: |
+|    id     |              | varchar(80) | Y        | 全局唯一,UUID无实际意义 |
+| record_id |  报警记录id  | varchar(80) | Y        |                          |
+|  content  | 是否重点关注 |     int     |          |                          |
+|  userId   |              |             |          |                          |
+|   valid   | 是否屏蔽状态 |     int     |          |         删除标记         |
+
+### 

+ 8 - 0
docs/alarm/index.md

@@ -0,0 +1,8 @@
+## 报警系统
+
+#### [接口文档](/alarm/alarm_api.md)
+
+#### [数据结构设计](/alarm/alarm_design.md)
+
+
+

+ 0 - 10
docs/dic/dic_api.md

@@ -1,15 +1,5 @@
 # 数据标准化接口文档
 
-## 模板案例
-
-参考实体类 Example
-
-| 字段 | 类型   |
-| ---- | ------ |
-| id   | int    |
-| name | string |
-| age  | int    |
-
 ### 查询(请参考[通用查询](/utils/query.md))
 
 ### 新增

+ 102 - 0
docs/dpt/dpt_.md

@@ -0,0 +1,102 @@
+### 数据模型
+
+***
+
+1. 任务配置,用于描述一个具体的任务配置信息
+
+1. 执行记录,用于描述一个任务的具体的一次执行过程
+
+### 系统说明
+
+***
+
+1. 任务调度的最小时间间隔是5秒,暂不支持频率要求快于5秒的场景
+
+1. 任务配置完成后,满足以下条件的任务会被触发:
+
+    1. 状态为待执行且达到下次执行时间的
+
+    1. 状态为执行中且达到上次执行的过期时间的
+
+1. 任务触发后更新任务的下次执行时间、本次任务的过期时间,然后生成执行记录
+
+1. 根据执行方式的配置来调起相关的服务,同时会将集团编码、应用编码、项目ID、任务编码、调起参数,执行记录ID~~等~~作为参数
+
+1. 被调度方根据执行结果和执行记录ID来更新执行记录
+
+执行方式说明及对应的约束和配置参数说明:
+
+http方式的约束条件
+
+```text
+被调度方需保证url对应接口在200毫秒内执行完毕
+若不能保证,需要被调用方做异步处理,待异步执行完成后根据执行记录id更新执行记录结果
+```
+
+http方式的配置参数说明
+
+```json
+{
+	"url": "被调度方提供的访问地址,POST方式,参数会放在requestbody里面"
+}
+```
+
+jms方式说明
+
+```text
+根据配置信息,将参数封装为消息对象采用topic方式发送到rabitmq
+被调度方监听配置的rabitmq队列
+```
+
+jms方式的配置参数说明
+
+```json
+{
+	"exchange": "",
+	"routingKey": ""
+}
+```
+
+### 数据结构
+
+***
+
+| 任务配置        |             |              |     |                        |
+| ----------- | ----------- | ------------ | --- | ---------------------- |
+| 字段          | 字段名称        | 类型           | 非空  | 备注                     |
+| id          | ID          | varchar(40)  | Y   | 全局唯一                   |
+| group_code  | 所属集团编码      | varchar(20)  |     |                        |
+| app_code    | 应用编码        | varchar(40)  |     |                        |
+| project_id  | 项目ID        | varchar(40)  |     |                        |
+| code        | 任务编码        | varchar(20)  | Y   |                        |
+| name        | 任务名称        | varchar(40)  | Y   |                        |
+| remark      | 备注          | varchar(200) |     |                        |
+| status      | 状态          | bit          | Y   | 任务状态:0停用,1待执行,2执行中,3暂停 |
+| type        | 执行方式        | varchar(20)  | Y   | 调起方式:http,jms          |
+| config      | 执行方式配置参数    | json         | Y   |                        |
+| params      | 调起参数        | json         | Y   |                        |
+| cron        | cron表达式     | varchar(40)  | Y   |                        |
+| next_time   | 下次执行时间      | datetime     | Y   |                        |
+| time_out    | 超时时间(秒)     | int          | Y   |                        |
+| expire_time | 上次执行任务的过期时间 | datetime     |     |                        |
+|             |             |              |     |                        |
+
+| 任务执行记录     |        |             |     |                |
+| ---------- | ------ | ----------- | --- | -------------- |
+| 字段         | 字段名称   | 类型          | 非空  | 备注             |
+| id         | ID     | varchar(40) | Y   | 全局唯一           |
+| task_id    | 任务ID   | varchar(40) | Y   |                |
+| start_time | 开始时间   | datetime    |     |                |
+| end_time   | 结束时间   | datetime    |     |                |
+| success    | 是否正常结束 | bit         | Y   | 1是,0否,否表示发生了异常 |
+| error_info | 错误信息   | json        | Y   |                |
+|            |        |             |     |                |
+
+
+
+### 接口清单
+
+1.保存任务配置(创建、更新)
+
+2.保存执行记录(更新)
+

+ 226 - 0
docs/dpt/dpt_api.md

@@ -0,0 +1,226 @@
+# 任务调度接口文档
+
+## 系统接口
+
+#### 查询
+
+请参考[通用查询](/utils/query.md)
+
+### 任务配置
+
+#### 新增
+
+请求方法:POST
+
+请求路径:/task/cfg/create?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+{
+    "groupCode": "1",
+    "appCode": "2",
+    "projectId": "123",
+    "code": "456",
+    "name": "QKZZ",
+    "type": "JMS",
+    "config": {
+        "queue": "",
+        "exchange": "",
+        "routing": ""
+    },
+    "params": {
+        "test":"123"
+    },
+    "timeRule": {
+      "triggerStartTime":"任务通知的开始日期,格式:时间戳,当cron为空时,必须存在",
+      "triggerEndTime":"任务通知的结束日期,格式:时间戳",
+      "intervalTime":"数值型,任务上下两次通知的间隔时间,单位:秒",
+      "repeatCount":"数值型,任务通知次数(不包含任务启动的那一次)当其大于0时,intervalTime也必须大于0",
+      "cron":"cron表达式",
+      "alarmEmail":"报警邮箱"
+    },
+    "startTime": "1600167750640",
+    "endTime": "1600167750640",
+    "responseTime": 500,
+    "level": "10",
+    "remark": "测试"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "123456"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "fail",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+#### 更新
+
+请求方法:POST
+
+请求路径:/task/cfg/update?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+{
+    "id":"123456",
+    "groupCode": "1",
+    "appCode": "2",
+    "projectId": "123",
+    "code": "456",
+    "name": "QKZZ",
+    "type": "JMS",
+    "config": {
+        "queue": "",
+        "exchange": "",
+        "routing": ""
+    },
+    "params": {
+        "test":"123"
+    },
+    "timeRule": {
+      "triggerStartTime":"任务通知的开始日期,格式:时间戳,当cron为空时,必须存在",
+      "triggerEndTime":"任务通知的结束日期,格式:时间戳",
+      "intervalTime":"数值型,任务上下两次通知的间隔时间,单位:秒",
+      "repeatCount":"数值型,任务通知次数(不包含任务启动的那一次)当其大于0时,intervalTime也必须大于0",
+      "cron":"cron表达式",
+      "alarmEmail":"报警邮箱"
+    },
+    "startTime": "1600167750640",
+    "endTime": "1600167750640",
+    "responseTime": 500,
+    "level": "10",
+    "remark": "测试"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "c51a599e-e833-4088-911a-8b535bddfe0b"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "fail",
+    "message": ""
+}
+```
+
+#### 删除
+
+请求方法:POST
+
+请求路径:/task/cfg/delete?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+{
+    "id":"123456"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "c51a599e-e833-4088-911a-8b535bddfe0b"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "fail",
+    "message": ""
+}
+```
+
+#### 回调接口
+
+请求方法:POST
+
+请求路径:/task/cfg/receive?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+["1","2"]
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": null
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "fail",
+    "message": ""
+}
+```
+
+## 任务记录
+
+请求方法:POST
+
+请求路径:/task/record/query
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "taskId": "t1",
+  "startTime": 1602802722000,
+  "endTime": 1602802725000,
+  "success": 1
+}
+```
+

+ 37 - 0
docs/dpt/dpt_ddl_sql.md

@@ -0,0 +1,37 @@
+# 任务调度系统数据表
+
+## 任务配置
+
+DROP TABLE IF EXISTS `dpt_task_cfg`;
+
+CREATE TABLE dpt_task_cfg (
+    id varchar(40) NOT NULL PRIMARY KEY,
+    group_code varchar(20) NULL COMMENT '集团编码',
+    app_code varchar(40) NULL COMMENT '应用编码',
+    project_id varchar(40) NULL COMMENT '项目ID',
+    code varchar(20) NOT NULL COMMENT '任务编码',
+    name varchar(40) NOT NULL COMMENT '任务名称',
+    type varchar(20) NOT NULL COMMENT '执行方式:http、jms',
+    config json NOT NULL COMMENT '执行方式配置参数',
+    params json NOT NULL COMMENT '调起参数',
+    time_rule json NOT NULL COMMENT '调起频率',
+    start_time timestamp NULL COMMENT '开始时间',
+    end_time timestamp NULL COMMENT '结束时间',
+    response_time int NOT NULL COMMENT '任务接口的处理时长,用于任务启停消峰控制',
+    level varchar(20) NOT NULL COMMENT '优先级,用于任务启停消峰控制',
+    status int NOT NULL COMMENT '状态',
+    remark varchar(200) COMMENT '备注'
+) COMMENT '任务配置';
+
+## 任务执行记录
+
+DROP TABLE IF EXISTS `dpt_task_record`;
+
+CREATE TABLE dpt_task_record (
+    id varchar(40) NOT NULL PRIMARY KEY,
+    task_id varchar(40) NOT NULL COMMENT '任务配置ID',
+    start_time timestamp NULL COMMENT '开始时间',
+    end_time timestamp NULL COMMENT '结束时间',
+    success int NOT NULL COMMENT '1是,0否,否表示发生了异常',
+    error_info json NOT NULL COMMENT '错误信息'
+) COMMENT '任务执行记录';

+ 66 - 0
docs/dpt/dpt_design.md

@@ -0,0 +1,66 @@
+# 任务调度
+
+## 数据结构
+
+### 数据结构
+
+| 任务调度配置 |          |      |                                          |        |                                          |
+| ------------ | -------- | ---- | ---------------------------------------- | ------ | ---------------------------------------- |
+| 参数名       | 类型     | 必填 | 描述                                     | 默认值 | 备注                                     |
+| id           | String   | Y    |                                          | UUID   | 新建时如果为空,则默认为UUID             |
+| groupCode    | String   |      | 所属集团编码                             |        |                                          |
+| appCode      | String   |      | 应用编码                                 |        |                                          |
+| projectId    | String   |      | 项目ID                                   |        |                                          |
+| code         | String   | Y    | 任务编码                                 |        |                                          |
+| name         | String   | Y    | 任务名称                                 |        |                                          |
+| type         | String   | Y    | 执行方式                                 |        | http 或者 jms                            |
+| config       | Json     | Y    | 执行方式配置参数                         |        |                                          |
+| params       | Json     | Y    | 调起参数                                 |        |                                          |
+| timeRule     | Json     | Y    | 调起频率                                 |        |                                          |
+| startTime    | datetime |      | 开始时间                                 |        |                                          |
+| endTime      | datetime |      | 结束时间                                 |        |                                          |
+| responseTime | datetime | Y    | 任务接口的处理时长,用于任务启停消峰控制 |        | 任务接口的处理时长,用于任务启停消峰控制 |
+| level        | String   | Y    | 优先级                                   |        | 用于任务启停消峰控制                     |
+| remark       | String   |      | 备注                                     |        |                                          |
+
+##### 字段保存格式规则说明
+
+```json
+time_rule:cron表达式,和triggerStartTime必须存在其一
+{
+  "triggerStartTime":"任务通知的开始日期,格式:时间戳,当cron为空时,必须存在",
+  "triggerEndTime":"任务通知的结束日期,格式:时间戳",
+  "intervalTime":"数值型,任务上下两次通知的间隔时间,单位:秒",
+  "repeatCount":"数值型,任务通知次数(不包含任务启动的那一次)当其大于0时,intervalTime也必须大于0",
+  "cron":"cron表达式",
+  "alarmEmail":"报警邮箱"
+}
+
+config:
+{
+  "queue": "",
+  "exchange": "",
+  "routing": ""
+}
+
+params
+{
+  "": ""
+}
+```
+
+
+
+
+
+| 任务执行记录 |              |             |      |                            |
+| ------------ | ------------ | ----------- | ---- | -------------------------- |
+| 字段         | 字段名称     | 类型        | 非空 | 备注                       |
+| id           | ID           | varchar(40) | Y    | 全局唯一                   |
+| task_id      | 任务ID       | varchar(40) | Y    |                            |
+| start_time   | 开始时间     | datetime    |      |                            |
+| end_time     | 结束时间     | datetime    |      |                            |
+| success      | 是否正常结束 | bit         | Y    | 1是,0否,否表示发生了异常 |
+| error_info   | 错误信息     | json        | Y    |                            |
+|              |              |             |      |                            |
+

+ 8 - 0
docs/dpt/index.md

@@ -0,0 +1,8 @@
+## 数据标准化
+
+#### [接口文档](/dpt/dpt_api.md)
+
+#### [数据结构设计](/dpt/dpt_design.md)
+
+
+

+ 91 - 207
docs/org/org_api.md

@@ -1,144 +1,7 @@
 # 人员组织权限接口文档
 
-## 模板案例
-
-参考实体类 Example
-
-| 字段 | 类型   |
-| ---- | ------ |
-| id   | int    |
-| name | string |
-| age  | int    |
-
 ### 查询(请参考[通用查询](/utils/query.md))
 
-### 新增
-
-请求地址
-
-```text
-/example/create
-```
-
-请求参数
-
-```json
-{
-    "id": "1",
-    "name": "test",
-    "age": "23"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "1"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-
-
-### 更新
-
-请求地址
-
-```json
-POST: /example/update
-```
-
-请求参数
-
-```json
-{
-    "id": "1",
-    "name": "test",
-    "age": "23"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "123456"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-
-
-### 删除
-
-请求地址
-
-```json
-POST: /example/delete
-```
-
-请求参数
-
-```json
-{
-    "id": "1"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "1"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-### 
-
 ## 系统接口
 
 ### (注:condition 为 query,create,update,delete)
@@ -276,6 +139,7 @@ POST: /example/delete
   "otherAccount": "test_other",
   "userFrom": "test_0",
   "isAdmin": "0",
+  "groupCode": "集团code",
   "status": 1,
   "createUser": "test",
   "createTime": 1602635430000,
@@ -284,22 +148,25 @@ POST: /example/delete
   "remark": "测试数据"
 }
 "withColumns" 可用字段 "jobs"
-新增:
-{
-  "name": "King",
-  "username": "king",
-  "password": "123456",
-  "gender": 1,
-  "phone": "13399998888",
-  "mail": "test@p.com",
-  "birthday": 1602635405000,
-  "headPortrait": "test_url",
-  "otherAccount": "test_other",
-  "userFrom": "test_0",
-  "isAdmin": "0",
-  "remark": "测试数据"
-}
-更新(注:全量更新):
+新增:[{},{}]
+[
+  {
+    "name": "King",
+    "username": "king",
+    "password": "123456",
+    "gender": 1,
+    "phone": "13399998888",
+    "mail": "test@p.com",
+    "birthday": 1602635405000,
+    "headPortrait": "test_url",
+    "otherAccount": "test_other",
+    "userFrom": "test_0",
+    "groupCode": "集团code",
+    "isAdmin": "0",
+    "remark": "测试数据"
+  }
+]
+更新:[{},{}]
 {
   "id": "1",
   "name": "King",
@@ -312,13 +179,16 @@ POST: /example/delete
   "headPortrait": "test_url",
   "otherAccount": "test_other",
   "userFrom": "test_0",
+  "groupCode": "集团code",
   "isAdmin": "0",
   "remark": "测试数据"
 }
-删除:
-{
-  "id": "1"
-}
+删除:[{},{}]
+[
+  {
+ 		"id": "1"
+	}
+]
 ```
 #### 部门
 
@@ -345,33 +215,40 @@ POST: /example/delete
   "updateTime": 1602637875000,
   "remark": "测试数据"
 }
-新增:
-{
-  "deptClassifyCode": "DEV_DATA",//非空
-  "code": "DEV_DMP",//建议非空
-  "name": "数据中台",//非空
-  "companyId": "1",//非空
-  "parentId": "0",//“0”表示顶级部门,非空
-  "resourceFrom": "0",//非空
-  "manager": "admin",
-  "remark": "测试数据"
-}
-更新(注:全量更新):
-{
-  "id": "1",//非空
-  "deptClassifyCode": "DEV_DATA",//非空
-  "code": "DEV_DMP",//建议非空
-  "name": "数据中台",//非空
-  "companyId": "1",//非空
-  "parentId": "0",//非空
-  "resourceFrom": "0",//非空
-  "manager": "admin",
-  "remark": "测试数据"
-}
-删除:
-{
-  "id": "1"
-}
+新增:[{},{}]
+[
+  {
+    "deptClassifyCode": "DEV_DATA",//非空
+    "code": "DEV_DMP",//建议非空
+    "name": "数据中台",//非空
+    "companyId": "1",//非空
+    "parentId": "0",//“0”表示顶级部门,非空
+    "resourceFrom": "0",//非空
+    "manager": "admin",
+    "remark": "测试数据"
+  }
+]
+
+更新:[{},{}]
+[
+  {
+    "id": "1",//非空
+    "deptClassifyCode": "DEV_DATA",//非空
+    "code": "DEV_DMP",//建议非空
+    "name": "数据中台",//非空
+    "companyId": "1",//非空
+    "parentId": "0",//非空
+    "resourceFrom": "0",//非空
+    "manager": "admin",
+    "remark": "测试数据"
+  }
+]
+删除:[{},{}]
+[
+  {
+  	"id": "1"
+	}
+]
 ```
 
 #### 部门分类
@@ -387,7 +264,7 @@ POST: /example/delete
   "code": "DEV",
   "name": "开发",
   "parentId": "0",
-  "orderNum": "1",
+  "orderNum": 1,
   "groupCode": "WD",
   "status": 1,
   "createUser": "test",
@@ -401,7 +278,7 @@ POST: /example/delete
   "code": "DEV",//非空
   "name": "开发",//非空
   "parentId": "0",
-  "orderNum": "1",
+  "orderNum": 1,
   "remark": "测试数据"
 }
 更新(注:全量更新):
@@ -410,7 +287,7 @@ POST: /example/delete
   "code": "DEV",//非空
   "name": "开发",//非空
   "parentId": "0",
-  "orderNum": "1",
+  "orderNum": 1,
   "remark": "测试数据"
 }
 删除:
@@ -482,7 +359,7 @@ POST: /example/delete
   "code": "DEV_JAVA_CLASS",
   "name": "开发",
   "groupCode": "WD",
-  "orderNum": "1",
+  "orderNum": 1,
   "status": 1,
   "createUser": "test",
   "createTime": 1602637370000,
@@ -490,25 +367,32 @@ POST: /example/delete
   "updateTime": 1602637379000,
   "remark": "测试数据"
 }
-新增:
-{
-  "code": "DEV_JAVA_CLASS",//非空
-  "name": "开发",//非空
-  "orderNum": "1",
-  "remark": "测试数据"
-}
-更新(注:全量更新):
-{
-  "id": "1",//非空
-  "code": "DEV_JAVA_CLASS",//非空
-  "name": "开发",//非空
-  "orderNum": "1",
-  "remark": "测试数据"
-}
-删除:
-{
-  "id": "1"
-}
+新增:[{},{}]
+[
+  {
+    "code": "DEV_JAVA_CLASS",//非空
+    "name": "开发",//非空
+    "orderNum": 1,
+    "remark": "测试数据"
+	}
+]
+更新:[{},{}]
+[
+  {
+    "id": "1",//非空
+    "code": "DEV_JAVA_CLASS",//非空
+    "name": "开发",//非空
+    "orderNum": 1,
+    "remark": "测试数据"
+  }
+]
+删除:[{},{}]
+[
+  {
+    "id": "1"
+  }
+]
+
 ```
 
 #### 应用