作者:钟剑华 历史版本:1 更新时间:2024-09-20 15:13
跳转到终止流程界面
简述:
- 跳转到终止流程界面
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/toEndProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/toEndProcess?taskId=681867142668222465
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"defaultCommonStatment": null,
"taskId": "681867142668222465"
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Map<String,Object> | 数据集合 |
终止流程
简述:
- 终止流程操作
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/doEndProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
messageType | String | 否 | 通知类型 | 如果传入了通知类型,那么就是用传入的通知类型,如果没有则获取节点的通知类型 | |
endReason | String | 否 | 原因 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/doEndProcess?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "终止流程成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程图
简述:
- 流程图
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/flowImage
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/flowImage?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"instId": "681867141829361664",
"bpmDefLayout": {
"defId": "655117127337902080",
"name": "启动直接会签并行",
"width": 678,
"height": 348,
"listLayout": [
{
"nodeId": "StartEvent_1okfb8p",
"name": "开始",
"nodeType": {
"key": "start",
"value": "开始节点"
},
"parentNodeId": "",
"x": 5,
"y": 27,
"width": 36,
"height": 36
},
{
"nodeId": "UserTask_09qxbcz",
"name": "发起人填写",
"nodeType": {
"key": "userTask",
"value": "用户任务节点"
},
"parentNodeId": "",
"x": 95,
"y": 5,
"width": 100,
"height": 80
},
{
"nodeId": "UserTask_1nidqrg",
"name": "会签",
"nodeType": {
"key": "signTask",
"value": "会签任务节点"
},
"parentNodeId": "",
"x": 255,
"y": 5,
"width": 100,
"height": 80
},
{
"nodeId": "EndEvent_06mxo2t",
"name": "结束",
"nodeType": {
"key": "end",
"value": "结束节点"
},
"parentNodeId": "",
"x": 417,
"y": 27,
"width": 36,
"height": 36
}
]
},
"statusColorList": [
{
"key": "pending",
"value": "待审批",
"color": "#e21100",
"order": 1
},
{
"key": "submit",
"value": "提交",
"color": "#4283fd",
"order": 2
},
{
"key": "resubmit",
"value": "重新提交",
"color": "#f7ac3d",
"order": 3
},
{
"key": "agree",
"value": "同意",
"color": "#04B913",
"order": 4
},
{
"key": "oppose",
"value": "反对",
"color": "#5c3219",
"order": 5
},
{
"key": "reject",
"value": "驳回",
"color": "#bcc330",
"order": 6
},
{
"key": "rejectToStart",
"value": "驳回到发起人",
"color": "#e46b22",
"order": 7
},
{
"key": "rejectToPrevious",
"value": "驳回上一步",
"color": "#ff32ca",
"order": 8
},
{
"key": "revoke",
"value": "撤销",
"color": "#007db9",
"order": 9
},
{
"key": "recoverToStart",
"value": "撤销到发起人",
"color": "#b022ae",
"order": 10
},
{
"key": "sign_pass",
"value": "会签通过",
"color": "#007747",
"order": 11
},
{
"key": "sign_no_pass",
"value": "会签不通过",
"color": "#23ebb9",
"order": 12
},
{
"key": "abandon",
"value": "弃权",
"color": "#6910d2",
"order": 13
},
{
"key": "manual_end",
"value": "人工终止",
"color": "#c7008b",
"order": 14
},
{
"key": "complete",
"value": "完成",
"color": "#fafe61",
"order": 15
},
{
"key": "suspend",
"value": "挂起",
"color": "#9f4e3c",
"order": 16
},
{
"key": "signBackCancel",
"value": "驳回取消",
"color": "#009ea8",
"order": 17
},
{
"key": "signRecoverCancel",
"value": "撤销取消",
"color": "#8d8502",
"order": 18
},
{
"key": "passCancel",
"value": "通过取消",
"color": "#545a26",
"order": 19
},
{
"key": "notPassCancel",
"value": "不通过取消",
"color": "#b5fe3d",
"order": 20
},
{
"key": "transforming",
"value": "流转中",
"color": "#fe4367",
"order": 21
},
{
"key": "transAgree",
"value": "流转同意",
"color": "#839287",
"order": 22
},
{
"key": "transOppose",
"value": "流转反对",
"color": "#ef9193",
"order": 23
},
{
"key": "skip",
"value": "跳过执行",
"color": "#8f92c9",
"order": 24
},
{
"key": "callSubProc",
"value": "外部子流程",
"color": "#033651",
"order": 25
},
{
"key": "autoTask",
"value": "自动节点",
"color": "#2ec5ea",
"order": 26
}
],
"bpmProcInst": {
"pk": "",
"name": null,
"ip": null,
"createBy": "1",
"createTime": "2020-02-25 14:16:35",
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "681867141829361664",
"subject": "管理员在2020-02-25 14:15:03发起子流程并行不直接结束",
"procDefId": "655117127337902080",
"bpmnDefId": "655117127560200192",
"procDefKey": "Process_0svo0ps_UserTask_0ky8mm1_Process_0hwv6vc",
"procDefName": "启动直接会签并行",
"bizKey": "681866759921205248",
"formType": null,
"formKey": null,
"status": "running",
"endTime": null,
"duration": null,
"typeId": null,
"resultType": null,
"bpmnInstId": "681867141795807232",
"isFormmal": "N",
"parentInstId": "681866758260260864",
"isForbidden": 0,
"dataMode": "table",
"creator": null,
"updator": null,
"forbidden": "未禁止",
"authorizeRight": null,
"taskEndTime": null,
"taskId": null,
"myNode": null,
"curNode": null
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data.bpmProcInst | IBpmProcInst | 流程数据对象 |
data.instId | String | 实例ID |
data.bpmDefLayout | BpmDefLayout | 流程定义布局 |
data.statusColorList | List< BpmProcessStatusColor > | 流程图颜色列表 |
获取流程实例中指定节点的审批意见
简述:
- 获取流程实例中指定节点的审批意见
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/nodeApproval
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 否 | 任务ID | ||
instId | String | 否 | 实例ID | ||
bizKey | String | 否 | 业务ID | ||
nodeId | String | 是 | 节点ID |
- Body:
暂无
请求参数示例:
http://192.168.3.220:5100/ibps/business/v3/bpm/task/nodeApproval?nodeId=UserTask_09qxbcz&taskId=681867142668222465
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"instId": "681867141829361664",
"data": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1582611395000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "681867145545515008",
"procDefId": "655117127560200192",
"supInstId": "681866758260260864",
"procInstId": "681867141829361664",
"taskKey": "UserTask_09qxbcz",
"taskId": "681867142668222465",
"taskName": "发起人填写",
"token": null,
"qualfieds": "[{\"type\":\"employee\",\"executId\":\"655072460911149056\",\"executor\":\"流程测试01\"},{\"type\":\"employee\",\"executId\":\"655072634219790336\",\"executor\":\"流程测试02\"},{\"type\":\"employee\",\"executId\":\"655072778055057408\",\"executor\":\"流程测试负责人\"}]",
"auditor": null,
"opinion": "",
"status": "pending",
"assignTime": null,
"completeTime": null,
"durMs": null,
"interpose": null,
"qualifiedExecutor": [
{
"type": "employee",
"executId": "655072460911149056",
"executor": "流程测试01"
},
{
"type": "employee",
"executId": "655072634219790336",
"executor": "流程测试02"
},
{
"type": "employee",
"executId": "655072778055057408",
"executor": "流程测试负责人"
}
],
"userImg": null,
"statusName": "待审批",
"auditorName": null,
"subject": null,
"batch": null,
"nodeColor": "#e21100",
"callSub": false
}
],
"bpmNodeUserShowCount": 3,
"hasApproval": true,
"nodeId": "UserTask_09qxbcz"
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data.data | List | 审批意见列表 |
data.instId | String | 实例ID |
data.nodeId | BpmDefLayout | 流程定义布局 |
data.bpmNodeUserShowCount | Integer | 数量 |
获取流程实例中指定节点的审批人
简述:
- 获取流程实例中指定节点的审批人
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/nodeExecutor
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
instId | String | 是 | 实例ID | ||
nodeId | String | 是 | 节点ID | ||
approvalId | String | 否 | 审批意见ID |
- Body:
暂无
请求参数示例:
http://192.168.3.220:5100/ibps/business/v3/bpm/task/nodeExecutor?instId=681867141829361664&nodeId=UserTask_09qxbcz
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"data": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1582611395000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "681867145545515008",
"procDefId": "655117127560200192",
"supInstId": "681866758260260864",
"procInstId": "681867141829361664",
"taskKey": "UserTask_09qxbcz",
"taskId": "681867142668222465",
"taskName": "发起人填写",
"token": null,
"qualfieds": "[{id:\"655072460911149056\",type:\"employee\"},{id:\"655072634219790336\",type:\"employee\"},{id:\"655072778055057408\",type:\"employee\"}]",
"auditor": null,
"opinion": null,
"status": "pending",
"assignTime": null,
"completeTime": null,
"durMs": null,
"interpose": null,
"qualifiedExecutor": [
{
"type": "employee",
"executId": "655072460911149056",
"executor": "655072460911149056"
},
{
"type": "employee",
"executId": "655072634219790336",
"executor": "655072634219790336"
},
{
"type": "employee",
"executId": "655072778055057408",
"executor": "655072778055057408"
}
],
"userImg": null,
"statusName": "待审批",
"auditorName": null,
"subject": null,
"batch": null,
"nodeColor": null,
"callSub": false
}
],
"hasApproval": false
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data.data | List | 候选人列表 |
data.hasApproval | String | 是否有审批意见 |
流程任务-指定执行人
简述:
- 流程任务-指定执行人
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/assignee
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID,多个逗号分隔 | ||
userId | String | 是 | 用户ID,多个逗号分隔 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/assignee?taskId=626866373389189120&userId=626866373389189121
返回示例:
{
"state": 200,
"request": null,
"message": "指定执行人成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-锁定
简述:
- 流程任务-锁定
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/lock
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/lock?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "锁定任务成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-解锁
简述:
- 流程任务-解锁
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/unlock
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/unlock?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "解锁任务成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-挂起
简述:
- 流程任务-挂起
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/suspendProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/suspendProcess?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程实例挂起成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-恢复
简述:
- 流程任务-恢复
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/recoverProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/recoverProcess?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程实例恢复成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-批量挂起
简述:
- 流程任务-批量挂起
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/batchSuspendProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskIds | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/batchSuspendProcess?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程实例挂起成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程任务-批量恢复
简述:
- 流程任务-批量恢复
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/batchRecoverProcess
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskIds | String | 是 | 任务ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/task/batchRecoverProcess?taskId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程实例恢复成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
任务办理数据(同意、反对、弃权)
简述:
- 任务办理数据(同意、反对、弃权)
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/agreeData/vo
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 是 | 流程任务动作 | ||
busData | String | 否 | 表单数据 |
请求参数示例:
{
"actionName": "agree",
"busData": "表单数据,省略",
"taskId": "681867142668222465"
}
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {
"success":1
},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data.taskId | String | 任务ID |
data.actionName | String | 任务ID |
data.jumpTypeCommon | String | 是否正常流转 |
data.jumpTypeSelect | String | 是否选择跳转 |
data.jumpTypeFree | String | 是否自由跳转 |
data.jumpType | String | 跳转方式 |
data.hidePath | boolean | 是否隐藏路径 |
data.hideOpinion | boolean | 是否隐藏意见 |
data.success | boolean | 是否成功,1-成功、0-不成功 |