@alanwang-merit/meritdata-platform-skill-package 1.0.9 → 1.0.10

package/skills/meritdata-platform-bpm/references/api//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20202_/350/247/204/345/210/231/345/274/225/346/223/216/345/210/235/345/247/213/345/214/226/346/216/245/345/217/243.md

@@ -0,0 +1,263 @@
+---
+name: 攻略-01-流程API-章节02_规则引擎初始化接口
+description: 规则引擎初始化接口 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 规则引擎初始化接口]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 1. 规则引擎初始化接口
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 1. 规则引擎初始化接口
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "init",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/ruleengine/init/{procDefKey}",
+  "signature": "Result ruleEngineInit()",
+  "functionDesc": "根据流程定义key查询符合条件的最新的流程按钮配置信息",
+  "module": "bpm.process",
+  "pathParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    }
+  ],
+  "requestParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    },
+    {
+      "name": "自定义流程参数",
+      "type": "String",
+      "required": false,
+      "desc": "自定义流程参数",
+      "constraint": "字符串"
+    }
+  ],
+  "returnType": "RuleEngine对象",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.ruleEngineInit(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+ 说明：根据流程定义key查询符合条件的最新的流程按钮配置信息
+
+* method: `POST`
+* url: `http://IP:端口/gateway/服务名/api/bpm/core/ruleengine/init/{procDefKey}`
+* PathVariables
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | procDefKey | String |是| 流程key   |  |
+* RequestParams
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | procDefKey | String   | 是  |  流程key    ||
+    | 自定义流程参数|String | 否   | 自定义流程参数 | |
+
+* ResponseBody
+    返回数据类型：RuleEngine对象
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/ruleengine/init/Process_Demo1?procDefKey=Process_Demo1
+
+返回数据如下：
+```json
+{
+    "timestamp": 1614234886974,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/ruleengine/init/Process_Demo1",
+    "data": {
+        "runtime": {
+            "businessId": null,
+            "procDefKey": "Process_Demo1",
+            "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189",
+            "procInstId": null,
+            "taskId": null,
+            "taskDefKey": null,
+            "taskName": null,
+            "formLink": "/bpm-demo/example/index.html#/formEdit?id=businessId",
+            "selUserWin": "no",
+            "opinionWin": "no",
+            //获取按钮信息
+            "bpmBtns": [
+                {
+                    "name": "保存",
+                    "id": "bpmSaveOrUpdateBtn",
+                    "procInstId": "",
+                    "type": "primary"
+                },
+                {
+                    "name": "填写意见",
+                    "id": "bpmOpinionBtn",
+                    "procInstId": "",
+                    "type": ""
+                },
+                {
+                    "name": "发送",
+                    "id": "bpmSendBtn",
+                    "procInstId": "",
+                    "type": ""
+                },
+                {
+                    "name": "特送",
+                    "id": "bpmJumpBtn",
+                    "procInstId": "",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "管理特送",
+                    "id": "bpmJumpManagementBtn",
+                    "procInstId": "",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "查看追踪",
+                    "id": "bpmProcTrackBtn",
+                    "procInstId": "",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "关闭",
+                    "id": "bpmCloseBtn",
+                    "procInstId": "",
+                    "type": ""
+                }
+            ],
+            "nextNodes": null,
+            "mainForm": null
+        },
+        "formLink": {
+            "sort": "0",
+            "name": "部门审批",
+            "link": "/bpm-demo/example/index.html#/formEdit?id=businessId"
+        },
+        "actors": [
+            {
+                "type": "1",
+                "ids": "drafterCode",
+                "codes": null,
+                "names": null,
+                "level": null,
+                "duty": null,
+                "dutyName": null,
+                "dutyCode": null,
+                "condition": null,
+                "customControllerName": null,
+                "customMethodsName": null
+            }
+        ],
+        "approve": {
+            "type": "onlyApprove"
+        },
+        "route": {
+            "type": "1",
+            "name": null,
+            "value": null,
+            "returnName": null,
+            "returnValue": null,
+            "operName": "发送",
+            "operImgPath": null
+        },
+        "opinion": {
+            "display": "1",
+            "type": "1",
+            "must": "1",
+            "regionName": null,
+            "regionSort": "0",
+            "opinionField": null,
+            "opinionYesNo": null,
+            "opinionDeptStatus": null,
+            "opinionListStatus": null,
+            "routeName": null,
+            "routeValue": null,
+            "routeOpiMust": null,
+            "routeCommentMust": null,
+            "opinionUserImgStatus": null,
+            "autoOpinion": null,
+            "autoOpiContent": null,
+            "isOpiDisplay": null,
+            "isOpiMust": null
+        },
+        "seluserwin": {
+            "display": "yes@@@@@【本环节需要选人】",
+            "noseluser": "no@@@@@【本环节不需要自动选人】"
+        },
+        "editStatus": {
+            "type": "1"
+        },
+        "activity": {
+            "id": "Activity_1el7wyo",
+            "name": "部门审批"
+        },
+        "formVars": [],
+        "sendRead": {
+            "actor": [],
+            "isSendRead": {
+                "type": "0"
+            }
+        },
+        "regainStatus": {
+            "type": null
+        },
+        "isRetprenode": {
+            "type": null
+        },
+        "isRetfirnode": {
+            "type": null
+        },
+        "retRandomNodeStatus": {
+            "type": null
+        },
+        "sign": null,
+        "completionCondition": null
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java测试样例:</b>
+    适用于后端调用
+    注入com.meritdata.cloud.bpm.core.BpmEngine类
+```java
+    @Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "规则引擎初始化", notes = "根据流程定义Key查询符合条件的最新的流程按钮配置信息")
+    @RequestMapping(value = "/ruleengine/init/{procDefKey}", method = RequestMethod.POST)
+    public @ResponseBody
+    ResultBody<RuleEngine> ruleEngineInit() {
+        String procDefKey = "Process_Demo1";
+        Map variables = new HashMap();
+        variables.put("procDefkey","Process_Demo1");
+        ResultBody<RuleEngine> ruleEngine = bpmEngine.ruleEngineInit(procDefKey, variables);
+        return ruleEngine;
+    }
+
+```

package/skills/meritdata-platform-bpm/references/api//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20203_/345/220/257/345/212/250/346/265/201/347/250/213/345/256/236/344/276/213/346/216/245/345/217/243.md

@@ -0,0 +1,187 @@
+---
+name: 攻略-01-流程API-章节03_启动流程实例接口
+description: 启动流程实例接口 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 启动流程实例接口]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 2. 启动流程实例接口
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 2.  启动流程实例接口
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "startprocess",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/{procDefKey}/startprocess",
+  "signature": "Result startProcess()",
+  "functionDesc": "创建一个流程实例,前置条件是先把业务数据保存后，获取业务数据的id,当作businessId的值",
+  "module": "bpm.process",
+  "pathParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    }
+  ],
+  "requestParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    },
+    {
+      "name": "businessId",
+      "type": "String",
+      "required": true,
+      "desc": "业务id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmSubject",
+      "type": "String",
+      "required": false,
+      "desc": "待办标题",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmUrgent",
+      "type": "String",
+      "required": false,
+      "desc": "紧急程度",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmSecret",
+      "type": "String",
+      "required": false,
+      "desc": "密级程度",
+      "constraint": "非空，加密字符串"
+    }
+  ],
+  "returnType": "MainForm对象",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.startProcess(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+
+说明：创建一个流程实例,前置条件是先把业务数据保存后，获取业务数据的id,当作businessId的值
+
+* method: `POST`
+* url: `http://IP:端口/gateway/服务名/api/bpm/core/{procDefKey}/startprocess`
+* PathVariables
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | procDefKey | String   | 是  |  流程key    ||
+    
+* RequestParams
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | procDefKey | String      |是       | 流程key   |      |
+    | businessId | String      |是       | 业务id   |      |
+    | bpmSubject | String      |否       | 待办标题   |      |
+    | bpmUrgent | String      |否       | 紧急程度   |      |
+    | bpmSecret | String      |否       | 密级程度   |      |
+
+* ResponseBody
+    返回数据类型：MainForm对象
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/Process_Demo1/startprocess?procDefKey=Process_Demo1&businessId=3f28824f77d7e9a60177d806daab0001
+
+```json
+   {
+       "procDefKey":"Process_Demo1"
+       "businessId":"3f28824f77d7e9a60177d806daab0001"
+   }
+```
+
+返回数据如下：
+```json
+    {
+    "timestamp": 1614237113004,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/Process_Demo1/startprocess",
+    "data": {
+        "tenantId": "",
+        "createTime": 1614237112863,
+        "updateTime": 1614237112973,
+        "creatorId": null,
+        "reviserId": null,
+        "id": "3f28824f77d7e9980177d8079a8d0005",
+        "appModuleName": "差旅费",
+        "appModuleId": "报销",
+        "appSystemId": "BPM",
+        "appSystemName": "BPM系统",
+        "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189",
+        "procInstId": "bc6fcf47-7738-11eb-8728-00d861edd189",
+        "procDefKey": "Process_Demo1",
+        "flowReaderIds": ",test1,",
+        "flowReaderNames": "测试1",
+        "flowAuthorIds": ",test1,",
+        "flowAuthorNames": "测试1",
+        "procDealStatus": "draft",
+        "drafterName": "测试1",
+        "drafterId": "test1",
+        "drafterDeptId": "yanfa",
+        "drafterDeptName": "技术研发部",
+        "subject": "Process_Demo1",
+        "urgent": null,
+        "secret": null,
+        "formLink": "/bpm-demo/example/index.html#/formEdit?id=3f28824f77d7e9a60177d806daab0001",
+        "preActDealerId": "",
+        "preDealerId": "test1",
+        "preActId": "",
+        "nodeIds": "Activity_1el7wyo",
+        "nodeNames": "部门审批",
+        "lockUserId": null,
+        "lockUserName": null,
+        "lockStatus": null,
+        "bpmVersion": 0,
+        "businessId": "3f28824f77d7e9a60177d806daab0001",
+        "portalMode": "default",
+        "portalUrl": ""
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java测试样例:</b>
+适用于后端调用
+注入com.meritdata.cloud.bpm.core.BpmEngine类
+```java
+    @Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "启动流程", notes = "根据流程定义Key和需要的流程变量businessId来启动流程，启动成功之后返回procInstId流程实例Id")
+    @RequestMapping(value = "/{procDefKey}/startprocess", method = RequestMethod.POST)
+    public ResultBody<MainFormDTO> startProcess() throws Exception {
+        String procDefKey ="Process_Demo1";
+        Map variables = new HashMap();
+        variables.put("procDefkey","Process_Demo1");
+        variables.put("businessId","3f28824f77d7e9a60177d8110b670002");
+        ResultBody<MainFormDTO> mainForm = bpmEngine.startProcess(procDefKey, variables);
+        return mainForm;
+    }
+```