# 流程OpenAPI接口说明
# 1. 流程实例
# 1.1 获取流程绑定表单
功能描述
发起表单
请求说明
请求方式:Get
请求URL :https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/workflow/{modelId}/form
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
modelId | 是 | string | 流程模型id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data":
{
"fields":[
{
"processInstanceId":"",
"processDeifinitionId":"",
"author":"",
"formFieldLayout":"",
"lastModifier":"",
"formTitle":"",
"lastModifier":"",
"version":"",
"layouts":[],
"operations":[],
"authorName":"",
"formDeifinitionId":"",
"id":"",
"fields":[],
"applicationId":"",
"lastModifyDate":123123,
"taskId":"",
"createDate":123123
}
]
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
processInstanceId | String | 流程实例id |
processDeifinitionId | String | 流程定义id |
author | String | 发起人id |
formFieldLayout | String | 表单字段布局 |
lastModifier | String | 最后修改人id |
version | String | 版本 |
layouts | list | 布局 |
operations | String | 操作 |
authorName | String | 发起人名称 |
formDefinitionId | String | 表单定义id |
id | String | id |
fields | list | 表单信息 |
applicationId | String | 应用id |
lastModifyDate | Date | 最后修改时间 |
taskId | String | 任务id |
createDate | Date | 创建时间 |
# 1.2 启动流程实例
功能描述
启动流程实例
调用说明
1、调用逻辑:先调用【获取下一节点参与人和指定节点】获取 nextNodesAndHandlers、designatedNodesAndHandlers数据信息
2、参数组装:指定nextNodesAndHandlers、designatedNodesAndHandlers中approvers数据
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
modelId | 是 | string | 流程模型id |
请求包体
{
"nextNodesAndHandlers": [{
"activityDefinitionId": "obj_03",
"approvers": ["123123123123123"]
}],
"designatedNodesAndHandlers": [{
"activityDefinitionId": "obj_0yegawo",
"activityName": "人工任务3",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "initiatorDesignatedUser",
"designateType": "USER",
"approvers": ["4564564564646"],
"success": true
}],
"variables": {
"单行文本1": "123"
},
"loginUserId":"355cfccf9bc63ce4282c0c437b71fdfb"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
nextNodesAndHandlers | 是 | List | 下个节点及处理人 |
designatedNodesAndHandlers | 否 | List | 指定节点及处理人 |
variables | 是 | object | 表单信息 |
loginUserId | 是 | String | 操作用户id |
nextNodesAndHandlers参数内容详细说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
activityDefinitionId | 是 | String | 下个节点定义id |
approvers | 否 | list | 下个节点处理人列表 |
designatedNodesAndHandlers参数内容详细说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
activityDefinitionId | 是 | list | 指定节点定义id |
activityName | 是 | list | 指定节点名称 |
activityType | 是 | list | 指定节点类型 |
designate | 是 | list | 指定节点是否允许调整 |
designateLimit | 是 | list | 指定节点调整限制 |
designateName | 是 | list | 指定节点路由规则名称 |
designateType | 是 | list | 指定节点路由规则类型 |
approvers | 是 | list | 指定节点处理人 |
success | 否 | list | 计算指定节点处理人是否成功 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data":
{
"id": ""
"processModelId":""
"processDefinitionId": ""
"processDefinitionKey": ""
"subject": ""
"initiator": ""
"initiatorDeptId": ""
"startTime": 12324123123
"endTime": 12324123123
"updateTime": 12324123123
"processState": ""
"existSubProcess": true
"completed": true
"suspended":true
"exception": true
"overTime": true
"costTime": 12324123123
"applicationId": ""
"processName": ""
"initiatorName": ""
"formInstanceId": ""
"formDefinitionId": ""
"parentInstanceId": ""
"parentProcessDefinitionId": ""
"parentActivityDefinitionId": ""
"revoked": true
"returned":true
"recover":true
"terminated": true
"tenantId": ""
"createTime": 123123
"createBy": ""
"updateBy": ""
"remarks": ""
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 流程实例id |
processModelId | string | 流程模型id |
processDefinitionId | string | 流程定义id |
processDefinitionKey | string | 流程定义key |
subject | string | 主题 |
initiator | string | 创建人id |
initiatorDeptId | string | 创建人部门id |
startTime | DATE | 开始时间 |
endTime | DATE | 结束时间 |
updateTime | DATE | 更新时间 |
processState | string | 流程状态 |
existSubProcess | boolean | 是否存在子流程 |
completed | boolean | 是否完成 |
suspended | boolean | 是否暂停 |
exception | boolean | 是否异常 |
overTime | boolean | 是否超时 |
costTime | long | 消耗时间 |
applicationId | string | 应用id |
processName | string | 流程名称 |
initiatorName | string | 创建人名称 |
formInstanceId | string | 表单id |
formDefinitionId | string | 表单定义id |
parentInstanceId | string | 父流程实例id |
parentProcessDefinitionId | string | 父流程定义id |
parentActivityDefinitionId | string | 父节点id |
revoked | boolean | 撤销标识 |
returned | boolean | 回退 |
recover | boolean | 单步回收 |
terminated | boolean | 终止 |
tenantId | string | 租户id |
createTime | date | 创建时间 |
createBy | string | 创建人 |
updateBy | string | 更新人 |
remarks | string | 备注 |
# 1.3 终止流程实例(终止任务)
功能描述
终止流程实例
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
taskId | 是 | string | 任务id |
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
请求包体
{
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"variables":{
"单行文本":""
"数字1":""
},
"loginUserId":"355cfccf9bc63ce4282c0c437b71fdfb"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
comment | 是 | string | 审批意见 |
variables | 否 | object | 表单信息 |
loginUserId | 是 | string | 操作用户id |
comment参数内容详细说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
content | 否 | string | 评论内容(纯文本) |
htmlContent | 否 | string | 评论内容(html文本) |
commentOpinionSource | 否 | string | 评论意见来源按钮名称 |
atUserIds | 否 | list | 被@用户id |
files | 否 | string | 文件信息 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": null
}
# 1.4 删除流程实例
功能描述
删除流程实例
请求说明
请求方式:DELETE
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": { }
}
# 1.5 根据流程实例id获取流程实例
功能描述
根据流程实例id获取流程实例
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
processInstanceId | 是 | string | 流程实例id |
applicationId | 是 | string | 应用id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": "",
"processModelId":"",
"processDefinitionId": "",
"processDefinitionKey": "",
"subject": "",
"initiator": "",
"initiatorDeptId": "",
"startTime": 12324123123,
"endTime": 12324123123,
"updateTime": 12324123123,
"processState": "",
"existSubProcess": true,
"completed": true,
"suspended":true,
"exception": true,
"overTime": true
"costTime": 12324123123,
"applicationId": "",
"processName": "",
"initiatorName": "",
"formInstanceId": "",
"formDefinitionId": "",
"parentInstanceId": "",
"parentProcessDefinitionId": "",
"parentActivityDefinitionId": "",
"revoked": true,
"returned":true,
"recover":true,
"terminated": true,
"tenantId": "",
"createTime": 123123,
"createBy": "",
"updateBy": "",
"remarks": ""
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 流程实例id |
processModelId | string | 流程模型id |
processDefinitionId | string | 流程定义id |
processDefinitionKey | string | 流程定义key |
subject | string | 主题 |
initiator | string | 创建人id |
initiatorDeptId | string | 创建人部门id |
startTime | DATE | 开始时间 |
endTime | DATE | 结束时间 |
updateTime | DATE | 更新时间 |
processState | string | 流程状态 |
existSubProcess | boolean | 是否存在子流程 |
completed | boolean | 是否完成 |
suspended | boolean | 是否暂停 |
exception | boolean | 是否异常 |
overTime | boolean | 是否超时 |
costTime | long | 消耗时间 |
applicationId | string | 应用id |
processName | string | 流程名称 |
initiatorName | string | 创建人名称 |
formInstanceId | string | 表单id |
formDefinitionId | string | 表单定义id |
parentInstanceId | string | 父流程实例id |
parentProcessDefinitionId | string | 父流程定义id |
parentActivityDefinitionId | string | 父节点id |
revoked | boolean | 撤销标识 |
returned | boolean | 回退 |
recover | boolean | 单步回收 |
terminated | boolean | 终止 |
tenantId | string | 租户id |
createTime | date | 创建时间 |
createBy | string | 创建人 |
updateBy | string | 更新人 |
remarks | string | 备注 |
# 1.6 新增相关人权限
功能描述
新增相关人权限
请求说明
请求方式:POST
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
请求包体
{
"userIdList": [
"userId1",
"userId2"
]
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
userIdList | 是 | array | 需要批量新增的用户ID列表 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": 2
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
data | string | 处理成功的人员数量(相关人已存在则自动跳过,不纳入数量中) |
# 1.7 通过流程标签名称与人员ID查询可发起流程信息接口
功能描述
新增通过流程标签名称与人员ID查询可发起流程信息接口
请求说明
请求方式:GET
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processLabelName | 是 | string | 流程标签名称 |
userId | 是 | string | 人员ID |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": [{
"id": "",
"name":"",
"applicationId":"",
"applicationName":""
}]
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 流程模板Id |
name | string | 流程名称 |
applicationId | string | 应用Id |
applicationName | int | 应用名称 |
# 2. 任务实例
# 2.1 查询任务实例(获取流程实例的当前任务集合)
功能描述
查询任务实例(获取流程实例的当前任务集合)
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": [
{
"id": "",
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1,
}
]
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 2.2 获取下一节点参与人和指定节点
功能描述
获取获取下一节点参与人和指定节点
调用场景
1、调用【启动流程实例接口】前:参数【processInstanceId】、参数【taskId】不需要传值
2、调用【完成任务接口】前:参数【processInstanceId】、参数【taskId】需要传值
请求说明
请求方式:Post
请求包体
{
"processInstanceId": "",
"taskId": "",
"variables": {
"单行文本1": "【获取下一节点参与人和指定节点】"
},
"loginUserId": "be1380b6ba74f8e6b0a1badc222222f"
}
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
processInstanceId | 否 | string | 流程实例id |
taskId | 否 | string | 任务id |
variables | 否 | object | 表单信息 |
loginUserId | 是 | String | 操作用户id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"designatedNodesAndHandlers": [
{
"activityDefinitionId": "obj_0yegawo",
"activityName": "人工任务2",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "initiatorDesignatedUser",
"designateType": "USER",
"handlers": [],
"success": true
},
{
"activityDefinitionId": "obj_14xiamq",
"activityName": "人工任务3",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "initiatorDesignatedUser",
"designateType": "USER",
"handlers": [{
"id": "111111",
"name": "处理人A"
}],
"success": true
}
],
"nextNodesAndHandlers": [
{
"activityDefinitionId": "obj_0yegawo",
"activityName": "人工任务2",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "initiatorDesignatedUser",
"designateType": "USER",
"handlers": [],
"success": true
}
]
}
}
返回参数
参数 | 数据类型 | 说明 |
---|---|---|
designatedNodesAndHandlers | list | 指定节点及处理人信息 |
nextNodesAndHandlers | list | 下一节点及处理人信息 |
activityDefinitionId | string | 活动节点ID |
activityName | string | 活动节点名称 |
activityType | string | 活动节点类型 |
designate | boolean | 节点是否允许指定 |
designateLimit | boolean | 节点调整限制 |
designateName | string | 节点路由规则名称 |
designateType | string | 节点路由规则类型 |
handlers | list | 节点处理数据(用户) |
success | boolean | 是否成功计算处理人结果 |
id | String | 节点处理人id |
name | String | 节点处理人名称 |
# 2.4 完成任务
功能描述
完成任务
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
请求包体
{
"designatedNodesAndHandlersList":[{
{
"activityDefinitionId": "obj_0yegawo",
"activityName": "人工任务2",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "specialTaskNodeDesignatedUser",
"designateType": "USER",
"approvers": ["1111111111","2222222"],
"success": true
},
{
"activityDefinitionId": "obj_14xiamq",
"activityName": "人工任务3",
"activityType": "userTask",
"designate": true,
"designateLimit": false,
"designateName": "specialTaskNodeDesignatedUser",
"designateType": "USER",
"approvers": ["333333","444444"],
"success": true
}
}],
"nextNodesAndHandlersList": [
{
"activityDefinitionId": "obj_0yegawo",
"approvers":["1111111111"]
}
]
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"variables":{
"单行文本1":""
},
"loginUserId":"a08bcb7e67a84cb08348884688aacd02"
}
参数解释
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
activityDefinitionId | 是 | String | 节点定义id |
approvers | 否 | list | 下个节点处理人列表 |
comment | 是 | string | 审批意见 |
variables | 否 | object | 表单信息 |
loginUserId | 是 | string | 操作用户id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": ""
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 2.4 回退任务
功能描述
回退任务
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
请求包体
{
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"nextNodeId": "",
"variables": {
"单行文本1": ""
},
"loginUserId": "a08bcb7e67a84cb08348884688aacd02"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
comment | 是 | string | 审批意见 |
nextNodeId | 是 | string | 回退节点id |
variables | 否 | object | 表单信息 |
loginUserId | 是 | string | 操作用户id |
comment参数详细内容说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
content | 否 | string | 评论内容(纯文本) |
htmlContent | 否 | string | 评论内容(html文本) |
commentOpinionSource | 否 | string | 评论意见来源按钮名称 |
atUserIds | 否 | list | 被@用户id |
files | 否 | string | 文件信息 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": "",
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 2.5 获取回退候选节点
功能描述
获取回退候选节点
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": [
{
"activityName": "",
"activityType": "",
"activityDefinitionId":""
}
]
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
activityName | string | 节点名称 |
activityType | string | 节点类型 |
activityDefinitionId | string | 节点id |
# 2.6 单步回收任务
功能描述
单步回收任务
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
请求包体
{
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"variables":{
"单行文本1":""
},
"loginUserId":"355cfccf9bc63ce4282c0c437b71fdfb"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
comment | 是 | string | 审批意见 |
variables | 否 | object | 表单信息 |
loginUserId | 是 | string | 操作用户id |
comment参数详细内容说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
content | 否 | string | 评论内容(纯文本) |
htmlContent | 否 | string | 评论内容(html文本) |
commentOpinionSource | 否 | string | 评论意见来源按钮名称 |
atUserIds | 否 | list | 被@用户id |
files | 否 | string | 文件信息 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": ""
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 2.7 传阅任务
功能描述
传阅任务
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
请求包体
{
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"circulatedUserIds": [],
"loginUserId":"355cfccf9bc63ce4282c0c437b71fdfb"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
comment | 是 | string | 审批意见 |
circulatedUserIds | 是 | list | 传阅用户IDs |
loginUserId | 是 | string | 操作用户id |
comment参数详细内容说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
content | 否 | string | 评论内容(纯文本) |
htmlContent | 否 | string | 评论内容(html文本) |
commentOpinionSource | 否 | string | 评论意见来源按钮名称 |
atUserIds | 否 | list | 被@用户id |
files | 否 | string | 文件信息 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": ""
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 2.8 委托任务
功能描述
完成任务
请求说明
请求方式:Post
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例ID |
taskId | 是 | string | 任务id |
请求包体
{
"comment": {
"content": "这是评论内容",
"htmlContent": "",
"commentOpinionSource": "",
"atUserIds": [""],
"files": ""
},
"entrustUserId": "",
"loginUserId":"355cfccf9bc63ce4282c0c437b71fdfb"
}
参数说明
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
comment | 是 | string | 审批意见 |
entrustUserId | 是 | string | 委托用户ID |
loginUserId | 是 | string | 操作用户id |
comment参数详细内容说明:
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
content | 否 | string | 评论内容(纯文本) |
htmlContent | 否 | string | 评论内容(html文本) |
commentOpinionSource | 否 | string | 评论意见来源按钮名称 |
atUserIds | 否 | list | 被@用户id |
files | 否 | string | 文件信息 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"id": ""
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
# 3. 流程历史
# 3.1根据流程实例id获取流程审批历史
功能描述
根据流程实例id获取流程审批历史
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processInstanceId | 是 | string | 流程实例id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": [
{
"id": "",
"taskId": "",
"activityName": "",
"activityType": "",
"activityDefinitionId": "",
"userId": "",
"userName": "",
"deptId": "",
"deptName": "",
"comment": "",
"createTime": 123123123,
"receiveTime": 123123123,
"compareTime": 123123123,
"type": "",
"read": true
}
]
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | id |
taskId | string | 任务id |
activityName | string | 节点名称 |
activityType | string | 节点类型 |
activityDefinitionId | string | 节点id |
userId | string | 用户id |
userName | string | 用户名称 |
deptId | string | 部门id |
deptName | string | 部门名称 |
comment | string | 评论内容 |
createTime | Date | 操作时间 |
receiveTime | Date | 接收时间 |
compareTime | Date | 排序比对时间 |
type | string | 样式 |
read | boolean | 是否已阅 |
# 4.流程定义
# 4.1 查询流程定义
功能描述
查询流程定义
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
version | 否 | string | 流程版本(形式:1或V1),默认为当前启用版本 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"applicationName": "",
"processDefinitionId": "123123123123123",
"processIcon": "",
"processModelId": "123123123123123123123",
"processName": "OpenApi启动流程完成任务",
"processTasks": [
{
"conditionAdjustable": false,
"id": "obj_0yegawo",
"nodeDesc": "",
"nodeName": "人工任务2",
"routeConditionConfig": "",
"timeoutHandler": "",
"timeoutReminder": ""
},
{
"conditionAdjustable": false,
"id": "obj_02",
"nodeDesc": "",
"nodeName": "人工任务1",
"routeConditionConfig": "",
"timeoutHandler": "",
"timeoutReminder": ""
}
],
"processTitle": "",
"relatedFormId": "111111111111112222",
"subProcessModelIds": [""],
"version": "V1"
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
applicationName | string | 应用民称 |
processDefinitionId | string | 流程定义id |
processIcon | string | 流程图标 |
processModelId | string | 流程模型id |
processName | string | 流程名称 |
processTasks | list | 流程人工任务节点集合 |
processTitle | string | 流程标题 |
relatedFormId | string | 关联表单id |
subProcessModelIds | set | 子流程模型id集合 |
version | string | 流程版本 |
processTasks参数详细内容说明:
字段 | 字段类型 | 字段说明 |
---|---|---|
conditionAdjustable | string | 节点是否允许手动调整处理人 |
id | string | 节点标识 |
nodeName | string | 节点名称 |
nodeDesc | string | 节点描述 |
routeConditionConfig | string | 节点路由策略配置 |
timeoutHandler | string | 节点超时处理配置 |
timeoutReminder | string | 节点超时提醒配置 |
# 4.2 查询流程图
功能描述
查询流程图
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
processInstanceId | 否 | string | 流程实例id |
version | 否 | string | 流程版本(形式:1或V1),默认为当前启用版本 |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"diagram": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><bpmn:definitions xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:bpmn=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" xmlns:bpmndi=\"http://www.omg.org/spec/BPMN/20100524/DI\" xmlns:dc=\"http://www.omg.org/spec/DD/20100524/DC\" xmlns:do1=\"http://do1.com.cn/bpmn\" xmlns:di=\"http://www.omg.org/spec/DD/20100524/DI\" targetNamespace=\"http://bpmn.io/schema/bpmn\"><bpmn:process id=\"process_01\"><bpmn:extensionElements></bpmn:extensionElements><bpmn:startEvent id=\"obj_01\" name=\"开始事件\"><bpmn:extensionElements /><bpmn:outgoing>obj_05</bpmn:outgoing></bpmn:startEvent><bpmn:userTask id=\"obj_02\" name=\"人工任务\"><bpmn:extensionElements></bpmn:extensionElements><bpmn:incoming>obj_05</bpmn:incoming><bpmn:outgoing>obj_06</bpmn:outgoing></bpmn:userTask><bpmn:userTask id=\"obj_03\" name=\"人工任务\"><bpmn:extensionElements></bpmn:extensionElements><bpmn:incoming>obj_06</bpmn:incoming><bpmn:outgoing>obj_07</bpmn:outgoing></bpmn:userTask><bpmn:endEvent id=\"obj_04\" name=\"结束事件\"><bpmn:extensionElements /><bpmn:incoming>obj_07</bpmn:incoming></bpmn:endEvent><bpmn:sequenceFlow id=\"obj_05\" name=\"\" sourceRef=\"obj_01\" targetRef=\"obj_02\"><bpmn:extensionElements /></bpmn:sequenceFlow><bpmn:sequenceFlow id=\"obj_06\" name=\"\" sourceRef=\"obj_02\" targetRef=\"obj_03\"><bpmn:extensionElements /></bpmn:sequenceFlow><bpmn:sequenceFlow id=\"obj_07\" name=\"\" sourceRef=\"obj_03\" targetRef=\"obj_04\"><bpmn:extensionElements /></bpmn:sequenceFlow></bpmn:process><bpmndi:BPMNDiagram id=\"process_01_di\"><bpmndi:BPMNPlane id=\"process_01_pl\"><bpmndi:BPMNShape id=\"obj_01_di\" bpmnElement=\"obj_01\"><dc:Bounds x=\"2500\" y=\"300\" width=\"40\" height=\"40\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_02_di\" bpmnElement=\"obj_02\"><dc:Bounds x=\"2465\" y=\"408\" width=\"110\" height=\"55\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_03_di\" bpmnElement=\"obj_03\"><dc:Bounds x=\"2465\" y=\"534\" width=\"110\" height=\"55\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_04_di\" bpmnElement=\"obj_04\"><dc:Bounds x=\"2500\" y=\"666\" width=\"40\" height=\"40\" /></bpmndi:BPMNShape><bpmndi:BPMNEdge id=\"obj_05_di\" bpmnElement=\"obj_05\"><di:waypoint x=\"2520\" y=\"340\" /><di:waypoint x=\"2520\" y=\"374\" /><di:waypoint x=\"2520\" y=\"374\" /><di:waypoint x=\"2520\" y=\"408\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\"obj_06_di\" bpmnElement=\"obj_06\"><di:waypoint x=\"2520\" y=\"463\" /><di:waypoint x=\"2520\" y=\"498.5\" /><di:waypoint x=\"2520\" y=\"498.5\" /><di:waypoint x=\"2520\" y=\"534\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\"obj_07_di\" bpmnElement=\"obj_07\"><di:waypoint x=\"2520\" y=\"589\" /><di:waypoint x=\"2520\" y=\"627.5\" /><di:waypoint x=\"2520\" y=\"627.5\" /><di:waypoint x=\"2520\" y=\"666\" /></bpmndi:BPMNEdge></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>",
"status": {
"0": [
"obj_01",
"obj_02"
],
"1": [
"obj_03"
],
"2": [
"obj_04"
]
},
"version": "V1"
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
diagram | string | 流程图XML信息 |
status | map | 流程节点状态 |
version | string | 流程版本 |
status参数详细内容说明:
字段 | 字段类型 | 字段说明 |
---|---|---|
0 | list | 已流转节点标识集合 |
1 | list | 正在流转节点标识集合 |
2 | list | 未流转节点标识集合 |
# 4.3 查询流程版本
功能描述
查询流程版本
请求说明
请求方式:Get
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
processInstanceId | 否 | string | 流程实例id |
返回结果
{
"msg": "执行成功",
"code": 0,
"data": {
"enableVersion": "V2",
"processInstanceVersion": "V1"
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
enableVersion | string | 流程当前启用版本 |
processInstanceVersion | string | 流程实例对应流程版本 |
# 5.流程预测
# 5.1.预测流程节点
# 功能描述
可根据当前字段内容,预测后续流程将会流转的节点
请求方式:POST
请求URL:https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/workflow/{processModelId}/prediction_nodes
# 请求包体
{
"processInstanceId": "",
"activityDefinitionIds":[],
"variables": {
"单行文本1": "1"
},
"loginUserId": "be1380b6ba74f8e6b0a1badc222222f"
}
# 请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
processInstanceId | 否 | string | 流程实例id(发起流程可不此参数) |
activityDefinitionIds | 否 | string[] | 节点定义id集合(发起流程可不传此参数) |
variables | 是 | object | 表单信息 |
loginUserId | 是 | String | 操作用户id |
返回参数示例:
{
"msg": "执行成功",
"traceId": null,
"code": 0,
"data": [
{
"activityDefinitionId": "obj_03jb1ay",
"activityName": "并行内嵌\n默认排它2",
"activityType": "userTask"
},
{
"activityDefinitionId": "obj_0x962gb",
"activityName": "并行4",
"activityType": "userTask"
}
}
响应参数说明:
参数 | 数据类型 | 说明 |
---|---|---|
activityDefinitionId | string | 活动节点ID |
activityName | string | 活动节点名称 |
activityType | string | 活动节点类型 |
# 5.2.预测流程节点处理人
# 功能描述
可根据当前字段内容,预测后续流程节点的处理人
请求方式:POST
请求URL:https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/workflow/{processModelId}/process_prediction
# 请求包体
{
"processInstanceId": "",
"activityDefinitionIds":["obj_03jb1ay","obj_0x962gb"],
"variables": {
"单行文本1": "1"
},
"loginUserId": "be1380b6ba74f8e6b0a1badc222222f"
}
# 请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
processInstanceId | 否 | string | 流程实例id(发起流程可不此参数) |
activityDefinitionIds | 是 | string[] | 要预测节点定义id集合 |
variables | 是 | object | 表单信息 |
loginUserId | 是 | String | 操作用户id |
返回参数示例:
{
"msg": "执行成功",
"traceId": null,
"code": 0,
"data": [
{
"activityDefinitionId": "obj_03jb1ay",
"activityName": "并行内嵌\n默认排它2",
"activityType": "userTask",
"description": "",
"designate": true,
"designateName": "initiatorDesignatedUser",
"designateType": "USER",
"handlerScope": true,
"handlers": [
{
"id": "fdf90a9e6826279a3f9166fd92f0ffeb",
"leave": false,
"name": "郑涛"
}
],
"showLeaf": false,
"success": true,
"taskTags": [],
"transfers": []
},
{
"activityDefinitionId": "obj_0x962gb",
"activityName": "并行4",
"activityType": "userTask",
"description": "",
"designate": false,
"designateName": "preTaskRelateDepartments",
"designateType": "DEPARTMENT",
"handlerScope": false,
"handlers": [
{
"id": "fdf90a9e6826279a3f9166fd92f0ffeb",
"leave": false,
"name": "郑涛"
}
],
"showLeaf": true,
"success": true,
"taskTags": [],
"transfers": []
}
]
}
响应参数说明:
参数 | 数据类型 | 说明 |
---|---|---|
activityDefinitionId | string | 活动节点ID |
activityName | string | 活动节点名称 |
activityType | string | 活动节点类型 |
designate | boolean | 节点是否允许指定 |
designateLimit | boolean | 节点调整限制 |
designateType | string | 节点路由规则名称 |
designateType | string | 节点路由规则类型 |
handlerScope | boolean | 是否已配置处理人范围 |
taskTags | string | 节点标签:逐级审批["recursion"] |
showLeaf | boolean | 判断组织选择器是否需要展示层级 |
handlers | list | 节点处理数据(用户) |
handlers.id | string | 用户id |
handlers.name | string | 用户名称 |
handlers.leave | boolean | 是否离职 |
transfers | list | 转交人数据 |
transfers.id | string | 转交用户id |
transfers.name | string | 转交用户名称 |
transfers.leave | boolean | 转交用户是否离职 |
order | int | 节点顺序 |
description | string | 节点描述 |
success | boolean | 是否成功计算处理人结果 |
# 5.3 查询流程图
功能描述
查询流程图
请求说明
请求方式:POST
请求URL :https://qiqiao.do1.com.cn/plus/cgi-bin/open/applications/{applicationId}/workflow/process_definition/{processModelId}/v2/diagram
请求参数
参数 | 必须 | 数据类型 | 说明 |
---|---|---|---|
applicationId | 是 | string | 应用id |
processModelId | 是 | string | 流程模型id |
请求包体
{
"processInstanceId":"",
"version":"1",
"variables": {
"单行文本1": "1"
},
"loginUserId":"fdf90a9e6826279a3f9166fd92f0ffeb"
}
返回结果
{
"msg": "执行成功",
"traceId": null,
"code": 0,
"data": {
"diagram": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<bpmn:definitions xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:bpmn=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" xmlns:bpmndi=\"http://www.omg.org/spec/BPMN/20100524/DI\" xmlns:dc=\"http://www.omg.org/spec/DD/20100524/DC\" xmlns:do1=\"http://do1.com.cn/bpmn\" xmlns:di=\"http://www.omg.org/spec/DD/20100524/DI\" targetNamespace=\"http://bpmn.io/schema/bpmn\"><bpmn:process id=\"process_01\"><bpmn:extensionElements><do1:recoverTask>[{\"recoverOperationName\":\"executeRecover\",\"enable\":true},{\"recoverOperationName\":\"signRecover\",\"enable\":false},{\"recoverOperationName\":\"entrustRecover\",\"enable\":false}]</do1:recoverTask><do1:cancelProcess>true</do1:cancelProcess><do1:urgeProcess>true</do1:urgeProcess><do1:urgeProcessLimit>{\"value\":\"unlimited\",\"unit\":\"NONE\"}</do1:urgeProcessLimit><do1:clearHistoryWhenCancelProcess>false</do1:clearHistoryWhenCancelProcess><do1:cancelProcessExclusiveNode></do1:cancelProcessExclusiveNode><do1:defaultTitle>false</do1:defaultTitle><do1:readSwitch>true</do1:readSwitch><do1:processComment>true</do1:processComment><do1:handleDynamics>true</do1:handleDynamics><do1:openChangeLog>false</do1:openChangeLog><do1:title></do1:title><do1:customTitle></do1:customTitle><do1:customTitleEcho></do1:customTitleEcho><do1:relatedFormId>64f1906c63229b196a6c4378</do1:relatedFormId><do1:formType>formds</do1:formType><do1:description></do1:description><do1:applicationId>cf7d4f1229194b94aabd71f7636b01fb</do1:applicationId><do1:autoCirculationConfig>{\"enable\":false,\"configType\":\"\",\"config\":{}}</do1:autoCirculationConfig><do1:customPrint></do1:customPrint><do1:customCssStyleProcess>{\"customCssStyleId\":\"\",\"openCustomCssStyleProcess\":false}</do1:customCssStyleProcess><do1:customJsConfig>{\"customJsId\":\"7899006673466449921\",\"enable\":false}</do1:customJsConfig></bpmn:extensionElements><bpmn:startEvent id=\"obj_01\" name=\"开始事件\"><bpmn:extensionElements /><bpmn:outgoing>obj_05</bpmn:outgoing></bpmn:startEvent><bpmn:userTask id=\"obj_02\" name=\"发起节点\"><bpmn:extensionElements><do1:description /><do1:showHistoricalRecord>false</do1:showHistoricalRecord><do1:batchApprove>false</do1:batchApprove><do1:operation>{\"executeOperation\":{\"enabled\":true,\"buttonLabel\":\"提交\",\"config\":{},\"order\":0,\"mainButton\":true}}</do1:operation><do1:multiInstanceControl>{\"method\":\"or\",\"enabled\":false,\"taskCompletionRate\":\"100\"}</do1:multiInstanceControl><do1:approvalOpinions>{\"approvalOpinionId\":\"\",\"enable\":false}</do1:approvalOpinions><do1:approvalOpinionRequired>{\"enable\":false}</do1:approvalOpinionRequired><do1:defaultCarbonCopy receiverType=\"\">{\"enabled\":false,\"triggerTime\":\"ACTIVITY_ARRIVE\",\"receiverConfig\":{}}</do1:defaultCarbonCopy><do1:condition type=\"initiatorRelateUsers\">{\"initiatorRelate\":\"0\",\"findUpperSuperiorWhenMissSuperior\":false,\"recursion\":{\"endByDepartmentIdEnable\":false,\"endByDepartmentId\":[],\"endByLevelFromLowToTopEnable\":false,\"endByLevelFromLowToTop\":\"0\",\"endByLevelFromTopToLowEnable\":false,\"endByLevelFromTopToLow\":\"0\",\"skipByDepartmentIdEnable\":false,\"skipByDepartmentId\":[],\"skipByLevelFromTopToLowEnable\":false,\"skipByLevelFromTopToLow\":\"\",\"approvalRules\":\"SIMULTANEOUS_APPROVAL\"}}</do1:condition><do1:notification>{\"channelList\":[\"wbg\",\"portal\"]}</do1:notification><do1:formEditPermissions>{\"formId\":\"64f1906c63229b196a6c4378\",\"web\":[],\"mobile\":[],\"webTemplateId\":\"NO_USE_TEMPLATE\",\"mobileTemplateId\":\"NO_USE_TEMPLATE\"}</do1:formEditPermissions><do1:actionWithoutHandler>{\"transferMode\":\"enterNextNode\",\"config\":{\"extras\":{\"selectUser\":[]},\"user\":[],\"userGroup\":[],\"department\":[],\"dynamicApprover\":[]}}</do1:actionWithoutHandler><do1:timeoutReminder>{\"schedulerDefinitionId\":\"\",\"enable\":false}</do1:timeoutReminder><do1:timeoutHandler>{\"schedulerDefinitionId\":\"\",\"enable\":false}</do1:timeoutHandler><do1:conditionAdjustable>false</do1:conditionAdjustable><do1:handlerScopeSetting>{\"users\":[],\"tags\":[],\"departments\":[],\"showLeaf\":false}</do1:handlerScopeSetting><do1:preInstallSetting>{\"type\":\"\",\"value\":[]}</do1:preInstallSetting><do1:handwritten /></bpmn:extensionElements><bpmn:incoming>obj_05</bpmn:incoming><bpmn:outgoing>obj_06</bpmn:outgoing></bpmn:userTask><bpmn:userTask id=\"obj_03\" name=\"审批节点\"><bpmn:extensionElements><do1:description /><do1:showHistoricalRecord>false</do1:showHistoricalRecord><do1:batchApprove>false</do1:batchApprove><do1:operation>{\"executeOperation\":{\"enabled\":true,\"buttonLabel\":\"办理\",\"config\":{},\"order\":0,\"mainButton\":true}}</do1:operation><do1:multiInstanceControl>{\"method\":\"or\",\"enabled\":false,\"taskCompletionRate\":\"100\"}</do1:multiInstanceControl><do1:approvalOpinions>{\"approvalOpinionId\":\"\",\"enable\":false}</do1:approvalOpinions><do1:approvalOpinionRequired>{\"enable\":false}</do1:approvalOpinionRequired><do1:defaultCarbonCopy receiverType=\"\">{\"enabled\":false,\"triggerTime\":\"ACTIVITY_ARRIVE\",\"receiverConfig\":{}}</do1:defaultCarbonCopy><do1:condition type=\"initiatorRelateUsers\">{\"initiatorRelate\":\"0\",\"findUpperSuperiorWhenMissSuperior\":false,\"recursion\":{\"endByDepartmentIdEnable\":false,\"endByDepartmentId\":[],\"endByLevelFromLowToTopEnable\":false,\"endByLevelFromLowToTop\":\"0\",\"endByLevelFromTopToLowEnable\":false,\"endByLevelFromTopToLow\":\"0\",\"skipByDepartmentIdEnable\":false,\"skipByDepartmentId\":[],\"skipByLevelFromTopToLowEnable\":false,\"skipByLevelFromTopToLow\":\"\",\"approvalRules\":\"SIMULTANEOUS_APPROVAL\"}}</do1:condition><do1:notification>{\"channelList\":[\"wbg\",\"portal\"]}</do1:notification><do1:formEditPermissions>{\"formId\":\"64f1906c63229b196a6c4378\",\"web\":[],\"mobile\":[],\"webTemplateId\":\"NO_USE_TEMPLATE\",\"mobileTemplateId\":\"NO_USE_TEMPLATE\"}</do1:formEditPermissions><do1:actionWithoutHandler>{\"transferMode\":\"enterNextNode\",\"config\":{\"extras\":{\"selectUser\":[]},\"user\":[],\"userGroup\":[],\"department\":[],\"dynamicApprover\":[]}}</do1:actionWithoutHandler><do1:timeoutReminder>{\"schedulerDefinitionId\":\"\",\"enable\":false}</do1:timeoutReminder><do1:timeoutHandler>{\"schedulerDefinitionId\":\"\",\"enable\":false}</do1:timeoutHandler><do1:conditionAdjustable>false</do1:conditionAdjustable><do1:handlerScopeSetting>{\"users\":[],\"tags\":[],\"departments\":[],\"showLeaf\":false}</do1:handlerScopeSetting><do1:preInstallSetting>{\"type\":\"\",\"value\":[]}</do1:preInstallSetting><do1:handwritten></do1:handwritten></bpmn:extensionElements><bpmn:incoming>obj_06</bpmn:incoming><bpmn:outgoing>obj_07</bpmn:outgoing></bpmn:userTask><bpmn:endEvent id=\"obj_04\" name=\"结束事件\"><bpmn:extensionElements /><bpmn:incoming>obj_07</bpmn:incoming></bpmn:endEvent><bpmn:sequenceFlow id=\"obj_05\" name=\"\" sourceRef=\"obj_01\" targetRef=\"obj_02\"><bpmn:extensionElements /></bpmn:sequenceFlow><bpmn:sequenceFlow id=\"obj_06\" name=\"\" sourceRef=\"obj_02\" targetRef=\"obj_03\"><bpmn:extensionElements /></bpmn:sequenceFlow><bpmn:sequenceFlow id=\"obj_07\" name=\"\" sourceRef=\"obj_03\" targetRef=\"obj_04\"><bpmn:extensionElements /></bpmn:sequenceFlow></bpmn:process><bpmndi:BPMNDiagram id=\"process_01_di\"><bpmndi:BPMNPlane id=\"process_01_pl\"><bpmndi:BPMNShape id=\"obj_01_di\" bpmnElement=\"obj_01\"><dc:Bounds x=\"2500\" y=\"300\" width=\"40\" height=\"40\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_02_di\" bpmnElement=\"obj_02\"><dc:Bounds x=\"2465\" y=\"408\" width=\"110\" height=\"55\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_03_di\" bpmnElement=\"obj_03\"><dc:Bounds x=\"2465\" y=\"534\" width=\"110\" height=\"55\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"obj_04_di\" bpmnElement=\"obj_04\"><dc:Bounds x=\"2500\" y=\"666\" width=\"40\" height=\"40\" /></bpmndi:BPMNShape><bpmndi:BPMNEdge id=\"obj_05_di\" bpmnElement=\"obj_05\"><di:waypoint x=\"2520\" y=\"340\" /><di:waypoint x=\"2520\" y=\"374\" /><di:waypoint x=\"2520\" y=\"374\" /><di:waypoint x=\"2520\" y=\"408\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\"obj_06_di\" bpmnElement=\"obj_06\"><di:waypoint x=\"2520\" y=\"463\" /><di:waypoint x=\"2520\" y=\"498.5\" /><di:waypoint x=\"2520\" y=\"498.5\" /><di:waypoint x=\"2520\" y=\"534\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\"obj_07_di\" bpmnElement=\"obj_07\"><di:waypoint x=\"2520\" y=\"589\" /><di:waypoint x=\"2520\" y=\"627.5\" /><di:waypoint x=\"2520\" y=\"627.5\" /><di:waypoint x=\"2520\" y=\"666\" /></bpmndi:BPMNEdge></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>",
"status": {
"transferred": [],
"predictionTransfer": [
"obj_01",
"obj_02",
"obj_03",
"obj_04",
"obj_05",
"obj_06",
"obj_07"
],
"transferring": []
},
"version": "V1"
}
}
返回参数
字段 | 字段类型 | 字段说明 |
---|---|---|
diagram | string | 流程图XML信息 |
status | Object | 流程节点状态: transferred:已流转元件id集合 transferring:正在流转元件id集合 predictionTransfer:预计流转元件id集合 示例: { "transferred":["obj_02"], "transferring":["obj_03"], "predictionTransfer":["obj_04"] } |
version | string | 流程版本 |
字段 | 字段类型 | 字段说明 |
---|---|---|
transferred | list | 已流转节点标识集合 |
transferring | list | 正在流转节点标识集合 |
predictionTransfer | list | 预计流转节点标识集合 |
# 6.数据对象结构说明
任务数据对象:
{
"id": "",
"processInstanceId":"",
"activityType": "",
"activityDefinitionId": 1,
"activityName": "",
"createTime": 123123123,
"applicationId": "",
"processDefinitionId":"",
"counts": 0,
"arrangement": 1
}
参数说明:
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 主键ID |
processInstanceId | string | 流程实例id |
activityType | string | 节点类型 |
activityDefinitionId | int | 节点定义id |
activityName | string | 节点名称 |
createTime | Date | 创建时间 |
applicationId | string | 应用id |
processDefinitionId | string | 流程定义id |
counts | int | 处理人总数 |
arrangement | int | 任务实例的执行顺序 |
流程实例数据对象:
{
"id": "",
"processDefinitionId": "",
"processDefinitionKey": "",
"subject": "",
"initiator": "",
"initiatorDeptId": "",
"startTime": 12324123123,
"endTime": 12324123123,
"updateTime": 12324123123
"processState": ""
"existSubProcess": true,
"completed": true,
"suspended":true,
"exception": true,
"overTime": true,
"costTime": 12324123123,
"applicationId": "",
"processName": "",
"initiatorName": "",
"formInstanceId": "",
"formDefinitionId": "",
"parentInstanceId": "",
"parentProcessDefinitionId": "",
"parentActivityDefinitionId": "",
"revoked": true,
"terminated": true
}
参数说明:
字段 | 字段类型 | 字段说明 |
---|---|---|
id | string | 流程实例id |
processDefinitionId | string | 流程定义id |
processDefinitionKey | string | 流程定义key |
subject | string | 主题 |
initiator | string | 创建人id |
initiatorDeptId | string | 创建人部门id |
startTime | DATE | 开始时间 |
endTime | DATE | 结束时间 |
updateTime | DATE | 更新时间 |
processState | string | 流程状态 |
existSubProcess | boolean | 是否存在子流程 |
completed | boolean | 是否完成 |
suspended | boolean | 是否暂停 |
exception | boolean | 是否异常 |
overTime | boolean | 是否超时 |
costTime | long | 消耗时间 |
applicationId | string | 应用id |
processName | string | 流程名称 |
initiatorName | string | 创建人名称 |
formInstanceId | string | 表单id |
formDefinitionId | string | 表单定义id |
parentInstanceId | string | 父流程实例id |
parentProcessDefinitionId | string | 父流程定义id |
parentActivityDefinitionId | string | 父节点id |
revoked | boolean | 撤销标识 |
terminated | boolean | 终止 |