作者:钟剑华 历史版本:1 更新时间:2024-09-20 15:13
流程动作-触发流程
简述:
- 流程动作-触发流程
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/trigger
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | custom | 流程任务动作 | |
actionAlias | String | 是 | 流程动作-自定义标识 | ||
data | String | 否 | 表单数据 | ||
triggerMultiInstance | String | 否 | 是否触发多实例 | Y/N | |
triggerUsers | String | 否 | 被触发流程第一节点执行人数据 | [{"nodeId":"userTask1", "executors":[{"id":"1", "name":"管理员", "type":"employee/party", "groupType":"org/role/position/group(当type值=party时必填)"}]}] | |
destination | String | 否 | 下一个节点ID |
请求参数示例:
{
"taskId": "655060479080660993"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务办理成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-异步触发流程
简述:
- 流程动作-异步触发流程
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/trigger/async
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | custom | 流程任务动作 | |
actionAlias | String | 是 | 流程动作-自定义标识 | ||
data | String | 否 | 表单数据 | ||
triggerMultiInstance | String | 否 | 是否触发多实例 | Y/N | |
triggerUsers | String | 否 | 被触发流程第一节点执行人数据 | [{"nodeId":"userTask1", "executors":[{"id":"1", "name":"管理员", "type":"employee/party", "groupType":"org/role/position/group(当type值=party时必填)"}]}] | |
destination | String | 否 | 下一个节点ID |
请求参数示例:
{
"taskId": "655060479080660993"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务提交成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-驳回
简述:
- 流程动作-驳回
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | reject | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 | |
backHandMode | String | 否 | 返回方式:direct/normal | ||
destination | String | 否 | 下一个节点ID |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务办理成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-异步驳回
简述:
- 流程动作-异步驳回
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject/async
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | reject | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 | |
backHandMode | String | 否 | 返回方式:direct/normal | ||
destination | String | 否 | 下一个节点ID |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务提交成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-驳回发起人
简述:
- 流程动作-驳回发起人
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject/starter
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | reject | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 | |
backHandMode | String | 否 | 返回方式:direct/normal |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回发起人"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务办理成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-异步驳回发起人
简述:
- 流程动作-异步驳回发起人
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject/starter/async
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | reject | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 | |
backHandMode | String | 否 | 返回方式:direct/normal |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回发起人"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务提交成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-驳回上一步
简述:
- 流程动作-驳回上一步
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject/previous
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | rejectToPrevious | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回上一步"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务办理成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程动作-异步驳回上一步
简述:
- 流程动作-异步驳回上一步
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/reject/previous/async
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
taskId | String | 是 | 任务ID | ||
actionName | String | 否 | rejectToPrevious | 流程任务动作 | |
opinion | String | 是 | 意见 | ||
data | String | 否 | 表单数据 | ||
version | Integer | 否 | 0 | 表单数据版本-乐观锁 |
请求参数示例:
{
"taskId": "655060479080660993",
"opinion": "驳回上一步"
}
返回示例:
{
"state": 200,
"request": null,
"message": "任务提交成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
根据用户查询任务
简述:
- 根据用户查询任务
请求URL:
- http://ip:port/ibps/business/v3/bpm/task/queryByUserId
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
{
"parameters": [
{"userId": "1"}
],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"dataResult": [{
"pk": "",
"name": "发起人填写",
"ip": null,
"createBy": null,
"createTime": "2020-02-25 14:16:36",
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "681867142668222465",
"subject": "管理员在2020-02-25 14:15:03发起子流程并行不直接结束",
"procInstId": "681867141829361664",
"taskId": "681867142668222465",
"execId": "681867141795807232",
"nodeId": "UserTask_09qxbcz",
"procDefId": "655117127337902080",
"procDefKey": "Process_0svo0ps_UserTask_0ky8mm1_Process_0hwv6vc",
"procDefName": "启动直接会签并行",
"status": "NORMAL",
"priority": 50,
"dueTime": null,
"suspendState": 1,
"parentId": null,
"bpmnInstId": "681867141795807232",
"bpmnDefId": "655117127560200192",
"typeId": "654756730873315328",
"lockState": 0,
"lockUser": "0",
"allowShfit": "N",
"authorizeRight": {
"authType": "task",
"defKey": null,
"managementEdit": "N",
"managementDel": "N",
"managementStart": "N",
"managementSet": "N",
"managementInternational": "N",
"managementClean": "N",
"managementGuideEdit": "N",
"instanceDel": "N",
"instanceLog": "N",
"rightContent": "{}",
"rightJsonObj": {}
},
"partyTypeName": "流程测试01,流程测试02,流程测试负责人",
"identityList": [{
"id": "655072460911149056",
"name": null,
"email": null,
"mobile": null,
"wcAccount": null,
"type": "employee",
"groupType": null,
"extractType": null,
"relType": null
}, {
"id": "655072634219790336",
"name": null,
"email": null,
"mobile": null,
"wcAccount": null,
"type": "employee",
"groupType": null,
"extractType": null,
"relType": null
}, {
"id": "655072778055057408",
"name": null,
"email": null,
"mobile": null,
"wcAccount": null,
"type": "employee",
"groupType": null,
"extractType": null,
"relType": null
}],
"skipResult": null,
"ownerName": "流程测试01,流程测试02,流程测试负责人",
"remindTimes": 0,
"ownerId": null,
"identityEmpty": false
}],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 201,
"totalPages": 11
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
dataResult | List< BpmTaskPo > | 任务列表数据 |
pageResult | Object | 分页数据 |
备注
- [1] : APIRequest为动态查询请求对象,详情请移步全局请求格式