@alanwang-merit/meritdata-platform-skill-package 1.0.0

package/skills/meritdata-dev-docs-file-finder/references/dev-docs//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20212_/344/270/252/344/272/272/345/276/205/345/212/236.md

@@ -0,0 +1,261 @@
+---
+name: 攻略-01-流程API-章节12_个人待办
+description: 个人待办 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 个人待办]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 11. 个人待办
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 11. 个人待办
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "undoPage",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/undoPage",
+  "signature": "UndoDTO对象 undoPage(page: 否, rows: 否, subject: 否, dealStatus: 否, isContainsDrafter: 否, drafterName: 否, procDefKey: 否, taskName: 否, createTimeSort: 否, userName: 否)",
+  "functionDesc": "获取当前登录用户的待办列表",
+  "module": "bpm.process",
+  "pathParameters": [],
+  "requestParameters": [
+    {
+      "name": "page",
+      "type": "否",
+      "required": false,
+      "desc": "默认 1",
+      "constraint": "≥ 1"
+    },
+    {
+      "name": "rows",
+      "type": "否",
+      "required": false,
+      "desc": "默认 10",
+      "constraint": "≥ 1"
+    },
+    {
+      "name": "subject",
+      "type": "否",
+      "required": false,
+      "desc": "",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "dealStatus",
+      "type": "否",
+      "required": false,
+      "desc": "默认是 2  ,未办理0、已办理1、 全部2",
+      "constraint": ""
+    },
+    {
+      "name": "isContainsDrafter",
+      "type": "否",
+      "required": false,
+      "desc": "默认 0  包含",
+      "constraint": ""
+    },
+    {
+      "name": "drafterName",
+      "type": "否",
+      "required": false,
+      "desc": "",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "procDefKey",
+      "type": "否",
+      "required": false,
+      "desc": "多值，按逗号拼接",
+      "constraint": "非空"
+    },
+    {
+      "name": "taskName",
+      "type": "否",
+      "required": false,
+      "desc": "过滤该任务名称",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "createTimeSort",
+      "type": "否",
+      "required": false,
+      "desc": "默认是根据处理时间倒序",
+      "constraint": ""
+    },
+    {
+      "name": "userName",
+      "type": "否",
+      "required": false,
+      "desc": "不传查询当前登录用户",
+      "constraint": "非空字符串"
+    }
+  ],
+  "returnType": "UndoDTO对象",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.getUndoPage(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+说明：获取当前登录用户的待办列表
+
+* method : `POST`
+* url : `http://IP:端口号/gateway/服务名/api/bpm/core/undoPage`
+* RequestParams：
+
+| 参数        | 是否必须 | 释义       | 备注 |
+| ----------- | -------- | ---------- | ---- |
+| page | 否       | 页数 |  默认 1    |
+| rows | 否       | 行数 |  默认 10    |
+|subject|否|标题||
+|dealStatus|否|处理状态|默认是 2  ,未办理0、已办理1、 全部2|
+|isContainsDrafter|否|是否包含起草状态|默认 0  包含|
+|drafterName|否|拟稿人||
+|procDefKey|否|流程定义key|多值，按逗号拼接|
+|taskName|否|任务名称|过滤该任务名称|
+|createTimeSort|否|是否根据申请时间倒序|默认是根据处理时间倒序|
+|userName|否|用户名|不传查询当前登录用户|
+
+* PathVariables
+
+```json
+无
+```
+
+* RequestBody
+
+```json
+无
+```
+
+* ResponseBody
+  返回数据类型：UndoDTO对象
+
+<b>Postman测试样例：</b>
+适用于前端直接调用
+
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/undoPage
+
+```json
+    "page":"1"
+    "rows":"10"
+```
+返回数据如下:
+```json
+{
+    "timestamp": 1615173114083,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/undoPage",
+    "data": {
+        "rows": [
+            {
+                "id": "3f28824f780fcfe701780fd192bf0002",
+                //应用模块名称
+                "appModuleName": "差旅费",
+                // 应用模块编码
+                "appModuleId": "报销",
+                //所属系统id
+                "appSystemId": "BPM",
+                //业务id
+                "businessId": "3f28824f780fcff601780fd185b50000",
+                //所属系统名称
+                "appSystemName": "BPM系统",
+                //表单链接名称
+                "formName": "总监审批",
+                //表单链接地址
+                "formLink": "/bpm-demo/example/index.html#/formRead?id=3f28824f780fcff601780fd185b50000",
+                //密级
+                "secret": "高级",
+                //待办标题
+                "subject": "测试1_2021-03-08 11:11_出差报销",
+                //紧急程度
+                "urgent": "普通",
+                //任务id
+                "taskId": "fdf4e8cd-7fbb-11eb-ad25-00d861edd189",
+                //任务名称
+                "taskName": "总监审批",
+                //任务编码
+                "taskDefKey": "Activity_0vjczzn",
+                //流程定义id
+                "procDefId": "Process_Demo1:14:400be900-7d9a-11eb-85a6-00d861edd189",
+                //流程定义Key
+                "procDefKey": "Process_Demo1",
+                //流程实例Id
+                "procInstId": "fc0f1229-7fbb-11eb-ad25-00d861edd189",
+                //待办发送人
+                "senderId": "test1",
+                //待办发送人
+                "senderName": "测试1",
+                //接收人id
+                "receiverId": "test1",
+                //接收人名字
+                "receiverName": "测试1",
+                //待办已处理人(接收人和处理人不一定相同，比例任意一人审批)
+                "dealerId": null,
+                //待办已处理人
+                "dealerName": null,
+                //流程中处理1，流程外阅知2,外出代理3
+                "undoType": "1",
+                //被代理人用户（单值）
+                "principalUserName": null,
+                //被代理人用户id（单值）
+                "principalUserId": null,
+                //处理状态：未办理0、已办理1
+                "dealStatus": "0",
+                "synStatus": null,
+                "synRTXStatus": null,
+                "isRead": null,
+                //拟稿人
+                "drafterName": "测试1",
+                //创建时间
+                "createTime": 1615456366000,
+                //审批时间
+                "updateTime": 1615456366000,
+                // 申请时间
+                "mainFormCreateTime": 1615864071000,
+                //操作类型 1 表示驳回
+                "operationType":"1"
+            }
+        ],
+        "total": 1,
+        "pageSize": 0,
+        "pageNumber": 0,
+        "totalPages": 0,
+        "records": 0
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+<b>java测试样例:</b>
+适用于后端调用
+ 注入com.meritdata.cloud.bpm.core.BpmEngine类
+ ```java
+
+    @Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "个人待办列表", notes = "个人待办列表")
+    @RequestMapping(value = "/undoPage", method = RequestMethod.POST)
+    public @ResponseBody
+    ResultBody<GridView<UndoDTO>> getUndoPage(){
+        Map variables = new HashMap();
+        variables.put("rows","10");
+        variables.put("page","1");
+        return bpmEngine.getUndoPage(variables);
+    }
+
+ ```

package/skills/meritdata-dev-docs-file-finder/references/dev-docs//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20213_/351/230/205/347/237/245.md

@@ -0,0 +1,306 @@
+---
+name: 攻略-01-流程API-章节13_阅知
+description: 阅知 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 阅知]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 12. 阅知
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 12. 阅知
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "getSendReadUsers",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/process/getSendReadUsers/{taskId}",
+  "signature": "Result getSendReadUsers()",
+  "functionDesc": "获取当前任务节点送阅知候选人列表",
+  "module": "bpm.process",
+  "pathParameters": [
+    {
+      "name": "taskId",
+      "type": "String",
+      "required": true,
+      "desc": "任务id",
+      "constraint": "非空字符串"
+    }
+  ],
+  "requestParameters": [
+    {
+      "name": "procInstId",
+      "type": "String",
+      "required": true,
+      "desc": "流程实例id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmDrafterId",
+      "type": "String",
+      "required": false,
+      "desc": "起草人id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "runtime\\[mainForm\\]\\[procInstId\\]",
+      "type": "String",
+      "required": false,
+      "desc": "主流程实例id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "businessId",
+      "type": "String",
+      "required": false,
+      "desc": "业务Id",
+      "constraint": "非空字符串"
+    }
+  ],
+  "returnType": "List<BpmUser>",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.getSendReadUsers(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+
+### 12.1 获取送阅知候选人列表
+
+说明：获取当前任务节点送阅知候选人列表
+
+* method : `POST`
+
+* url : `http://IP:端口号/gateway/服务名/api/bpm/core/process/getSendReadUsers/{taskId}`
+
+* PathVariables
+
+  | 参数   | 参数类型 | 是否必须 | 释义   | 备注 |
+  | ------ | -------- | -------- | ------ | ---- |
+  | taskId | String   | 是       | 任务id |      |
+
+* RequestParams
+
+  | 参数                              | 参数类型 | 是否必须 | 释义         | 备注                                                         |
+  | --------------------------------- | -------- | -------- | ------------ | ------------------------------------------------------------ |
+  | procInstId                        | String   | 是       | 流程实例id   |                                                              |
+  | bpmDrafterId                      | String   | 否       | 起草人id     |                                                              |
+  | runtime\[mainForm\]\[procInstId\] | String   | 否       | 主流程实例id | 当前流程为子流程时，procInstId 为子流程实例id，需取runtime\[mainForm\]\[procInstId\]获取主流程id,所以当前为子流程的任务节点时需要传此参数 |
+  | businessId                        | String   | 否       | 业务Id       |                                                              |
+
+RequestBody
+
+返回数据类型：List<BpmUser>
+
+<b>Postman测试样例：</b>
+适用于前端直接调用
+
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/process/getSendReadUsers/2d9ad75d-99d8-11eb-9638-70b5e84e90b6?procInstId=2b722b36-99d8-11eb-9638-70b5e84e90b6
+
+返回数据如下：
+
+```json
+{
+    "timestamp": 1618046381953,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/process/getSendReadUsers/2d9ad75d-99d8-11eb-9638-70b5e84e90b6",
+    "data": [
+        {
+            "code": "testUserCode",
+            "name": "testUserName",
+            "sex": null,
+            "email": null,
+            "telPhone": null,
+            "deptCode": "merit",
+            "deptName": "美林数据",
+            "dLevel": null,
+            "hSort": 0,
+            "mSort": 0,
+            "lSort": 0,
+            "isMainDept": 0,
+            "workGroupId": null,
+            "workGroupName": null,
+            "roleId": null,
+            "roleName": null
+        },
+        {
+            "code": "test1",
+            "name": "测试1",
+            "sex": null,
+            "email": null,
+            "telPhone": null,
+            "deptCode": "merit",
+            "deptName": "美林数据",
+            "dLevel": null,
+            "hSort": 0,
+            "mSort": 0,
+            "lSort": 0,
+            "isMainDept": 0,
+            "workGroupId": null,
+            "workGroupName": null,
+            "roleId": null,
+            "roleName": null
+        }
+    ],
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java测试样例:</b>
+    适用于后端调用
+    注入com.meritdata.cloud.bpm.core.BpmEngine类
+
+- ```java
+  	@Autowired
+      BpmEngine bpmEngine;
+  
+      @ApiOperation(value = "获取送阅知候选人", notes = "获取送阅知候选人")
+      @RequestMapping(value = "/process/getSendReadUsers/{taskId}", method = RequestMethod.POST)
+      public @ResponseBody
+      ResultBody<List<BpmUser>> getSendReadUsers() {
+          String taskId = "2d9ad75d-99d8-11eb-9638-70b5e84e90b6";
+          Map variables = new HashMap();
+          variables.put("procInstId","2b722b36-99d8-11eb-9638-70b5e84e90b6");
+          ResultBody<List<BpmUser>> sendReadUsers = (List<BpmUser>) bpmEngine.getSendReadUsers(taskId, 		variables).getData.get("sendReadUsers");
+          return sendReadUsers;
+      }
+  ```
+
+
+### 12.2 发送阅知
+
+说明：发送阅知
+
+- method : `POST`
+
+- url : `http://IP:端口号/gateway/服务名/api/bpm/core/process/sendingRead/{procInstId}`
+
+- PathVariables
+
+
+| 参数       | 参数类型 | 是否必须 | 释义   | 备注 |
+| ---------- | -------- | -------- | ------ | ---- |
+| procInstId | String   | 是       | 实例id |      |
+
+- RequestParams
+
+
+| 参数      | 参数类型           | 是否必须 | 释义                                                         | 备注 |
+| --------- | ------------------ | -------- | ------------------------------------------------------------ | ---- |
+| userCodes | Map<String,Object> | 是       | {用户编码：用户名 }  （key为用户编码，value为用户名的map集合） |      |
+
+- RequestBody
+
+返回数据类型：String
+
+<b>Postman测试样例：</b>
+适用于前端直接调用
+
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/process/sendingRead/6a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6?testUserCode=testUserName
+
+返回数据如下：
+
+```json
+{
+    "timestamp": 1618194127989,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/process/sendingRead/6a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6",
+    "data": "发送阅知成功",
+    "extraInfo": {},
+    "success": true
+}
+```
+
+**java测试样例:**
+    适用于后端调用
+    注入com.meritdata.cloud.bpm.core.BpmEngine类
+
+```java
+	@Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "发送阅知", notes = "发送阅知")
+    @RequestMapping(value = "/process/sendingRead/{procInstId}", method = RequestMethod.POST)
+    public @ResponseBody
+    ResultBody<String> getSendReadUsers() {
+        String procInstId = "a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6";
+        Map userCodes = new HashMap();
+        userCodes.put("testUserCode","testUserName");
+        userCodes.put("testUserCode1","testUserName2");
+        ResultBody<String> result = bpmEngine.sendingRead(procInstId, userCodes);
+        return result;
+    }
+```
+
+### 12.3 阅知完毕
+
+说明：阅知完毕 
+
+- method: `POST`
+
+- url: `http://IP:端口/gateway/服务名/api/bpm/core/process/sendReadEnd/{procInstId}`
+
+- PathVariables
+
+| 参数       | 参数类型 | 是否必须 | 释义       | 备注 |
+| ---------- | -------- | -------- | ---------- | ---- |
+| procInstId | String   | 是       | 流程实例id |      |
+
+- RequestParams
+
+```
+无
+```
+
+- ResponseBody
+  返回数据类型：String
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/process/sendReadEnd/6a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6
+
+```json
+{
+    "timestamp": 1618196627424,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/process/sendReadEnd/6a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6",
+    "data": "阅知完毕",
+    "extraInfo": {},
+    "success": true
+}
+```
+
+**java测试样例:**
+    适用于后端调用
+    注入com.meritdata.cloud.bpm.core.BpmEngine类
+
+```java
+@Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "阅知完毕", notes = "阅知完毕")
+    @RequestMapping(value = "/process/sendReadEnd/{procInstId}", method = RequestMethod.POST)
+    public @ResponseBody
+    ResultBody<String>> sendReadEnd() {
+        String procInstId = "a27d1d1-9b2d-11eb-bc6b-70b5e84e90b6";
+        ResultBody<String> result = bpmEngine.sendReadEnd(procInstId);
+        return result;
+    }
+```

package/skills/meritdata-dev-docs-file-finder/references/dev-docs//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20214_/346/265/201/347/250/213/346/234/200/346/226/260/345/256/232/344/271/211ID.md

@@ -0,0 +1,100 @@
+---
+name: 攻略-01-流程API-章节14_流程最新定义ID
+description: 流程最新定义ID — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 流程最新定义ID]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 13. 流程最新定义ID
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 13. 流程最新定义ID
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "",
+  "method": "POST",
+  "urlPattern": null,
+  "signature": "Result getLatestProcDefId(@PathVariable(\"procDefKey\")",
+  "functionDesc": "查询流程分类编码",
+  "module": "bpm.process",
+  "pathParameters": [],
+  "requestParameters": [],
+  "returnType": "String对象     流程定义ID",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.getLatestProcDefId(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+
+说明: 查询流程分类编码
+
+- method : POST
+
+- url : `http://IP:端口/gateway/服务名/api/bpm/core/ruleengine/{procDefKey}`
+
+- RequestParams：
+
+  无
+
+- PathVariables
+
+| 参数       | 参数类型 | 是否必须 | 释义    | 备注 |
+| ---------- | -------- | -------- | ------- | ---- |
+| procDefKey | String   | 是       | 流程key |      |
+
+- RequestBody
+
+```json
+无
+```
+
+- ResponseBody
+
+返回数据类型：String对象     流程定义ID
+
+Postman测试样例：
+
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/ruleengine/Process_Demo1
+
+```json
+{
+    "timestamp": 1630131273084,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/ruleengine/Process_Demo1",
+    "data": "Process_Demo1:63:067e2222-0720-11ec-846e-70b5e84e90b6",
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java样例</b>
+适用于后端调用,结合业务数据筛选使用
+ 注入com.meritdata.cloud.bpm.core.BpmEngine类
+
+```java
+@Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "获取流程最新定义ID", notes = "根据流程定义Key查询最新的流程定义ID")
+    @RequestMapping(value = "/get/{procDefKey}", method = RequestMethod.POST)
+    public @ResponseBody ResultBody<String> getLatestProcDefId(@PathVariable("procDefKey") String procDefKey) {
+
+        // 调用查询流程实例
+        ResultBody<String> procDefId = bpmEngine.getLatestProcDefId(procDefKey);
+        return procDefId.getData();
+    }
+```