管理接口
工作移交
服务描述
| 方法名称 | handOverWork | 中文名称 | 工作移交 |
|---|---|---|---|
| 功能描述 | 此服务用于将自己的待办工作移交给其他人员办理 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult handOverWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| trackId | String | √ | 路径id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
| selectAuthorMap | Map | √ | 接收人信息Map |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setTrackId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
Map<String, String> selectAuthorMap = new LinkedHashMap<String, String>();
selectAuthorMap.put("Author", "U_user1");
inparam.setSelectAuthorMap(selectAuthorMap);
IWorkResult result = mgr.handOverWork(inparam);接收工作移交
服务描述
| 方法名称 | receiveHandOverWork | 中文名称 | 接收工作移交 |
|---|---|---|---|
| 功能描述 | 此服务用于接收其他人移交的工作 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult receiveHandOverWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| trackId | String | √ | 路径id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setTrackId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.receiveHandOverWork(inparam);激活实例路径
服务描述
| 方法名称 | activeTrack | 中文名称 | 激活实例路径 |
|---|---|---|---|
| 功能描述 | 此服务用于激活已挂起的实例路径 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult activeTrack(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| trackId | String | √ | 路径id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setTrackId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.activeTrack(inparam);恢复实例到指定版本
服务描述
| 方法名称 | recoverWork | 中文名称 | 恢复实例到指定版本 |
|---|---|---|---|
| 功能描述 | 此服务用于将实例恢复到指定的历史版本 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult recoverWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
| recoverVersion | String | √ | 恢复到的版本号 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
inparam.setRecoverVersion("V1.0");
IWorkResult result = mgr.recoverWork(inparam);暂停实例
服务描述
| 方法名称 | pauseWork | 中文名称 | 暂停实例 |
|---|---|---|---|
| 功能描述 | 此服务用于暂停流程实例 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult pauseWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.pauseWork(inparam);恢复实例
服务描述
| 方法名称 | resumeWork | 中文名称 | 恢复实例 |
|---|---|---|---|
| 功能描述 | 此服务用于恢复已暂停的流程实例 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult resumeWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.resumeWork(inparam);结束实例
服务描述
| 方法名称 | endWork | 中文名称 | 结束实例 |
|---|---|---|---|
| 功能描述 | 此服务用于强制结束流程实例 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult endWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.endWork(inparam);替换办理人
服务描述
| 方法名称 | replaceOperator | 中文名称 | 替换办理人 |
|---|---|---|---|
| 功能描述 | 此服务用于替换当前节点的办理人 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult replaceOperator(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| trackId | String | √ | 路径id |
| nodeId | String | √ | 当前节点id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
| selectAuthorMap | Map | √ | 新办理人信息Map |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setTrackId("xxx");
inparam.setNodeId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
Map<String, String> selectAuthorMap = new LinkedHashMap<String, String>();
selectAuthorMap.put("Author", "U_newUser");
inparam.setSelectAuthorMap(selectAuthorMap);
IWorkResult result = mgr.replaceOperator(inparam);删除实例
服务描述
| 方法名称 | deleteWork | 中文名称 | 删除实例 |
|---|---|---|---|
| 功能描述 | 此服务用于删除流程实例 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult deleteWork(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
IWorkResult result = mgr.deleteWork(inparam);更新实例定义数据
服务描述
| 方法名称 | updateWorkFlowData | 中文名称 | 更新实例定义数据 |
|---|---|---|---|
| 功能描述 | 此服务用于更新流程实例的定义数据 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | IWorkResult updateWorkFlowData(WorkParaBean workParaBean) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| workId | String | √ | 实例id |
| userId | String | √ | 当前操作人id |
| tenantCode | String | √ | 当前租户id |
| dataIdentifier | String | √ | 业务数据的数据源 |
| flowIdentifier | String | √ | 流程数据的数据源 |
| flowVarMap | Map | √ | 更新的流程变量Map |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
WorkParaBean inparam = new WorkParaBean();
inparam.setWorkId("xxx");
inparam.setUserId("xxx");
inparam.setTenantCode("xxx");
inparam.setDataIdentifier("xxx");
inparam.setFlowIdentifier("xxx");
Map<String, String> flowVarMap = new HashMap<String, String>();
flowVarMap.put("var1", "value1");
inparam.setFlowVarMap(flowVarMap);
IWorkResult result = mgr.updateWorkFlowData(inparam);查询待办
服务描述
| 方法名称 | queryTodoList | 中文名称 | 查询待办 |
|---|---|---|---|
| 功能描述 | 此服务用于查询用户的待办列表 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | List<TodoItem> queryTodoList(String userId, String tenantCode, String identifier) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| userId | String | √ | 用户id |
| tenantCode | String | √ | 租户id |
| identifier | String | √ | 数据库标识 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
List<TodoItem> todoList = mgr.queryTodoList("U_user1", "tenant001", "dataSource");查询已办
服务描述
| 方法名称 | queryDoneList | 中文名称 | 查询已办 |
|---|---|---|---|
| 功能描述 | 此服务用于查询用户的已办列表 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | List<DoneItem> queryDoneList(String userId, String tenantCode, String identifier) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| userId | String | √ | 用户id |
| tenantCode | String | √ | 租户id |
| identifier | String | √ | 数据库标识 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
List<DoneItem> doneList = mgr.queryDoneList("U_user1", "tenant001", "dataSource");查询待阅
服务描述
| 方法名称 | queryReadList | 中文名称 | 查询待阅 |
|---|---|---|---|
| 功能描述 | 此服务用于查询用户的待阅列表 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | List<ReadItem> queryReadList(String userId, String tenantCode, String identifier) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| userId | String | √ | 用户id |
| tenantCode | String | √ | 租户id |
| identifier | String | √ | 数据库标识 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
List<ReadItem> readList = mgr.queryReadList("U_user1", "tenant001", "dataSource");查询已阅
服务描述
| 方法名称 | queryReadDoneList | 中文名称 | 查询已阅 |
|---|---|---|---|
| 功能描述 | 此服务用于查询用户的已阅列表 | ||
| 接口类型 | api | 交互频度 | 非周期 |
| 接口协议 | 直接方法调用 | 响应时间 | |
| 备注 | List<ReadDoneItem> queryReadDoneList(String userId, String tenantCode, String identifier) |
参数说明
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| userId | String | √ | 用户id |
| tenantCode | String | √ | 租户id |
| identifier | String | √ | 数据库标识 |
调用示例
java
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();
List<ReadDoneItem> readDoneList = mgr.queryReadDoneList("U_user1", "tenant001", "dataSource");