类名
接口清单
序号 | 接口名称 | 说明 |
1 | 添加一组工作项 | |
2 | 取消一个工作项 | |
3 | 根据ID获取一个工作项 | |
4 | 根据参与者和节点名称获取工作项 | |
5 | 转交一个工作项 | |
6 | 完成一个工作项 | |
7 | 将指定的传阅工作项标为已阅 | |
8 | 催办 |
基本用法
上述清单中的接口均归属在this.Engine.WorkItemManager
下,如要获取一个工作项,可使用如下代码形式:
H3.Workflow.WorkItem.WorkItem workItem = this.Engine.WorkItemManager.GetWorkItem("XXX");
其他接口使用方式与此类似。
接口说明
1. AddWorkItems(WorkItem[] workItems, bool isChildInstance = false)
1.1. 说明
添加一组工作项,这样可以保证事务化,以防有的工作项刚刚添加就被完成了。添加一个工作项的时候,需要在这里设置他的被添加时间,而不能以创建的时间为准,因为创建的时间可能来自于其他服务器或者客户端,这就有可能涉及时区的问题,如果以外部的时间为准就无法统一了。
1.2. 参数
参数名 | 说明 |
workItems | 新建的工作项数组,细节详见 |
isChildInstance | 是否子流程,默认为 |
1.3. 返回值
类型 | 说明 |
string[] | 添加的工作项ID |
2. CancelWorkItem(string workItemId)
2.1. 说明
取消一个工作项,相应的征询意见的工作项也会被取消。
2.2. 参数
参数名 | 说明 |
workItemId | 工作项ID |
2.3. 返回值
类型 | 说明 |
H3.ErrorCode | 错误代码 |
3. GetWorkItem(string workItemId)
3.1. 说明
根据ID获取一个工作项。
3.2. 参数
参数名 | 说明 |
workItemId | 工作项ID |
3.3. 返回值
类型 | 说明 |
工作项 |
4. GetWorkItems(string schemaCode, string[] participants, string[] activityNames)
4.1. 说明
根据参与者和节点名称获取工作项。
4.2. 参数
参数名 | 说明 |
schemaCode | 表单编码 |
participants | 参与者 |
activityNames | 节点名称 |
4.3. 返回值
类型 | 说明 |
工作项 |
5. ForwardWorkItem(string workItemId, string participant, string comment, string commentId = "", bool isNewComment = false, bool notify = true)
5.1. 说明
转交一个工作项。转交一个工作项给某人,不能创建新工作项,否则引用这些工作项的地方无法取消这个工作项,如果暂存后再转发,审批意见需要覆盖。
5.2. 参数
参数名 | 说明 |
workItemId | 工作项ID |
participant | 接收人 |
comment | 转交意见 |
commentId | 转交意见ID,可不传 |
isNewComment | 是否是新的转交意见,默认为 |
notify | 是否发送工作通知,默认为 |
5.3. 返回值
类型 | 说明 |
H3.ErrorCode | 错误代码 |
6. FinishWorkItem(string userId, string workItemId, AccessMethod finishAccessMethod, H3.Data.BoolValue approval, string comment, string actionName, ActionEventType actionEventType, bool isChildInstance = true)
6.1. 说明
完成一个工作项。
6.2. 参数
参数名 | 说明 |
userId | 提交人员 |
workItemId | 工作项ID |
finishAccessMethod | 提交人员的接入方式,详见 |
approval | 审批结果 |
comment | 审批意见 |
actionName | 操作名称 |
actionEventType | 操作的事件类型,详见 |
isChildInstance | 是否子流程 |
6.3. 返回值
类型 | 说明 |
H3.ErrorCode | 错误代码 |
7. FinishCirculateByIds(string userId, string[] workItemIds, AccessMethod finishAccessPoint, string comment, string actionName)
7.1. 说明
将指定的传阅工作项标为已阅。
7.2. 参数
参数名 | 说明 |
userId | 用户ID |
workItemIds | 工作项ID |
finishAccessPoint | 提交人员的接入方式,详见 |
comment | 评论 |
actionName | 操作名称 |
7.3. 返回值
类型 | 说明 |
H3.ErrorCode | 错误代码 |
8. Urge(string userId, string instanceId, string content)
8.1. 说明
催办。
8.2. 参数
参数名 | 说明 |
userId | 催办人ID |
instanceId | 催办的流程实例ID |
content | 催办的内容 |
8.3. 返回值
类型 | 说明 |
无 | 无 |
文章反馈
*请选择您遇到的问题类型?
*请描述问题详情
支持上传9张图片且单张大小不超过3M