创建实例
创建流程实例,实例不会保存到数据库中,只会驻留在内存中,只有对流程进行暂存或者在流程第一个点击进行提交时才会保存到数据库中。
接口调用说明
| 属性 | 值 |
|---|---|
| HTTP 方法 | POST |
| 请求地址 | http://127.0.0.1:8080/demo/horizon/workflow/rest/flow/support/open.wf |
请求参数
json
{
"accessToken": "",
"flowId": "test",
"title": "流程测试"
}| 参数 | 是否必须 | 描述 |
|---|---|---|
| accessToken | 是 | 调用接口凭证,唯一用户标识 |
| flowId | 是 | 流程 id |
| title | 否 | 流程实例标题 |
返回结果示例
json
{
"authorKey": "Author",
"flowButtons": [
{
"buttonClass": "com.horizon.wf.action.ActionSubmit",
"buttonFun": "",
"buttonId": "submit",
"buttonName": "提交",
"icon": ""
},
{
"buttonClass": "com.horizon.wf.action.ActionSave",
"buttonFun": "",
"buttonId": "save",
"buttonName": "暂存",
"icon": ""
},
{
"buttonClass": "com.horizon.wf.action.ActionReMsg",
"buttonFun": "",
"buttonId": "urge",
"buttonName": "催办",
"icon": ""
}
],
"flowForms": [
{
"formAuthId": "HZ28811c9813f6d5019835ee85620128",
"formBody": "",
"formButton": "",
"formDataId": "HZ28811c9e6811be019ef77ab0e60fca",
"formDatas": "",
"formFieldAuth": {
"authName": "申请",
"checkField": [
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_WORKID"
],
"editField": [
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_WORKID",
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_SENDNUM",
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_ACTIONNUM",
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_ACTIVE",
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_TRACKID",
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_SENDTIME"
],
"formId": "HZ28811c958485120195941e5b1855d8",
"hiddenField": [
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_SENDOBJ"
],
"readField": [
"HZ28811c958485120195941e5b1855d8_TW_HZ_TODO_SUCCESS_SENDTYPE"
]
},
"formFields": "",
"formId": "HZ28811c958485120195941e5b1855d8",
"formName": "默认表单",
"formType": "CUSTOM",
"isDef": "",
"isNewData": "true"
},
{
"formAuthId": "alleditable",
"formBody": "",
"formButton": "",
"formDataId": "FlowTrack",
"formDatas": "",
"formFieldAuth": "",
"formFields": "",
"formId": "FlowTrack",
"formName": "流程跟踪",
"formType": "",
"isDef": "true",
"isNewData": "false"
}
],
"flowId": "wen",
"flowMsg": "提交成功",
"flowName": "自定义表单流程",
"flowNode": {
"memo": "",
"nodeId": "Node1",
"nodeName": "任务1",
"nodeVars": "",
"trackId": "HZ28811c9e6811be019ef77ab0e20fc1"
},
"flowStatus": "110",
"flowStatusName": "正常",
"flowUser": {
"author": "Author;Creator",
"authorName": "主办;创建者",
"deptId": "HZ28821856ef63420156ef63429c0000",
"deptName": "科技公司",
"transactor": "U_admin;",
"transactorName": "管理员",
"userId": "admin",
"userName": "管理员"
},
"flowVars": {},
"hasForm": "true",
"openType": "true",
"selectNodes": "",
"subjectionId": "",
"workId": "HZ28811c9e6811be019ef77ab0e20fc0"
}参数详解
顶层参数
| 参数 | 类型 | 描述 |
|---|---|---|
| authorKey | String | 当前办理人身份 |
| flowButtons | List | 流程操作按钮信息 |
| flowForms | List | 流程表单信息 |
| flowId | String | 流程 id |
| flowMsg | String | 流程返回信息 |
| flowName | String | 流程名称 |
| flowNode | Object | 当前节点信息 |
| flowUser | Object | 流程执行的当前用户信息 |
| flowStatus | String | 流程状态:100(起草)、110(正常)、120(会签)、130(退回)、140(暂停)、150(撤办)、160(子流程)、170(结束)、180(终止)、190(拿回) |
| flowStatusName | String | 流程状态显示名称 |
| flowVars | Map | 流程变量,key 为变量名,value 为变量值 |
| hasForm | String | 是否含有业务表单 |
| openType | String | 流程打开状态 |
| selectNodes | List | 当前人处于多个活动节点时,需要选择节点打开实例 |
| workId | String | 流程实例 id |
| subjectionId | String | 办理人所属范围 |
flowButtons 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| buttonClass | String | 操作按钮实现类 |
| buttonFun | String | 按钮事件 |
| buttonId | String | 按钮 id |
| buttonName | String | 按钮名称 |
| icon | String | 按钮样式 |
flowForms 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| formAuthId | String | 字段权限 id |
| formBody | String | 自定义表单时返回表单URL地址 |
| formButton | List | 表单按钮 |
| formDataId | String | 表单数据 id |
| formDatas | Object | 表单数据(扩展字段,暂时用不到) |
| formFieldAuth | Object | 表单字段权限信息,拼接规则:字段ID_数据表名_字段名 |
| formFields | Object | 表单字段(扩展字段,暂时用不到) |
| formId | String | 表单 id |
| formName | String | 表单名称 |
| formType | String | 表单类型:外部表单、定制表单 |
| isDef | String | 是否是默认表单 |
| isNewData | String | 是否为新的表单数据 |
flowNode 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| memo | String | 节点描述信息 |
| nodeId | String | 节点 id |
| nodeName | String | 节点名称 |
| nodeVars | Map | 当前节点参数,key 为变量名,value 为变量值只在当前节点有效 |
| trackId | String | 流转实例路径 id |
flowUser 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| author | String | 用户身份 id:Author/SecondAuthor/Creator/Reader |
| authorName | String | 用户身份名称:主办/协办/创建者/读者 |
| deptId | String | 部门 id |
| deptName | String | 部门名称 |
| transactor | String | 正在办理人员 Id |
| transactorName | String | 正在办理人员名称 |
| userId | String | 用户 id |
| userName | String | 用户名称 |
formFieldAuth 参数
| 参数 | 类型 | 描述 |
|---|---|---|
| authName | String | 权限名 |
| formId | String | 表单 id |
| editField | List | 可编辑字段,每一项拼接规则:字段ID_数据表名_字段名 |
| checkField | List | 必填字段,每一项拼接规则:字段ID_数据表名_字段名 |
| hiddenField | List | 隐藏字段,每一项拼接规则:字段ID_数据表名_字段名 |
| readField | List | 只读字段,每一项拼接规则:字段ID_数据表名_字段名 |
