作者:钟剑华 历史版本:1 更新时间:2024-11-20 15:41
导入流程定义
简述:
- 导入流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/importBpm
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
multipartFile | MultipartFile | 是 | 流程定义文件压缩包 |
请求参数示例:
{
multipartFile: file //文件
}
返回示例:
{
"state": 200,
"request": null,
"message": "导入成功!",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
挂起流程定义
简述:
- 挂起流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/suspend
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defId | String | 是 | 流程定义ID | ||
cascade | Boolean | 是 | 是否级联处理 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/suspend?defId=626866373389189120&cascade=true
返回示例:
{
"state": 200,
"request": null,
"message": "挂起流程定义成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
恢复流程定义
简述:
- 恢复流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/recover
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defId | String | 是 | 流程定义ID | ||
cascade | Boolean | 是 | 是否级联处理 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/recover?defId=626866373389189120&cascade=true
返回示例:
{
"state": 200,
"request": null,
"message": "恢复流程定义成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
批量挂起流程定义
简述:
- 批量挂起流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/batchSuspend
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defIds | String | 是 | 流程定义ID | ||
cascade | Boolean | 是 | 是否级联处理 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/batchSuspend?defIds=626866373389189120&cascade=true
返回示例:
{
"state": 200,
"request": null,
"message": "挂起流程定义成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
批量恢复流程定义
简述:
- 批量恢复流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/batchRecover
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defIds | String | 是 | 流程定义ID | ||
cascade | Boolean | 是 | 是否级联处理 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/batchRecover?defIds=626866373389189120&cascade=true
返回示例:
{
"state": 200,
"request": null,
"message": "恢复流程定义成功",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程收藏
简述:
- 流程收藏
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/saveFavorites
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defIds | String | 是 | 流程定义ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/saveFavorites?defIds=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程收藏成功!",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
取消流程收藏
简述:
- 取消流程收藏
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/removeFavorites
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defIds | String | 是 | 流程定义ID |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/removeFavorites?defIds=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "取消流程收藏成功!",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
流程收藏排序
简述:
- 流程收藏排序
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/sortFavorites
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defIds | String | 是 | 流程定义ID | ||
sort | String | 否 | up | 排序方式 | up/first/down/last |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/sortFavorites?defIds=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程收藏排序成功!",
"cause": "",
"variables": {},
"data": {}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
检查流程定义是否存在
简述:
- 检查流程定义是否存在
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/checkExist
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
defId | String | 否 | 流程定义ID | ||
defKey | String | 否 | up | 流程定义key |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/bpm/definition/checkExist?defId=626866373389189120
返回示例:
{
"state": 200,
"request": null,
"message": "流程定义不存在",
"cause": "",
"variables": {},
"data": false
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
根据表单key查询流程定义
简述:
- 根据表单key查询流程定义
请求URL:
- http://ip:port/ibps/business/v3/bpm/definition/queryByFormKey
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
{
"parameters": [
{
formKey: 'apply'
}
],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}
返回示例:
{
"state": 200,
"request": null,
"message": "流程定义列表查询成功!",
"cause": "",
"variables": {},
"data": {
"dataResult": [{
"pk": "",
"name": "开发单表",
"ip": null,
"createBy": "654622686055497728",
"createTime": "2020-02-21 11:09:38",
"updateBy": "654622686055497728",
"updateTime": "2020-02-21 11:25:26",
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"defId": "680370541093191680",
"parentDefId": null,
"parentNodeId": null,
"srcDefId": null,
"defKey": "Process_0f8oaab",
"desc": "",
"typeId": null,
"status": "deploy",
"testStatus": "test",
"bpmnDefId": "Process_0f8oaab:1:680370541651034112",
"bpmnDeployId": "680370541353238528",
"version": 1,
"boCode": "kfdb",
"boVersion": 1,
"mainDefId": "680370541093191680",
"isMain": "Y",
"reason": null,
"bpmDefineXmlPo": {
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": null,
"defXml": null,
"bpmnXml": null
},
"primaryBpmnXml": null,
"designer": "web设计器",
"typeName": null,
"authorizeRight": {
"authType": "manage",
"defKey": null,
"managementEdit": "Y",
"managementDel": "Y",
"managementStart": "Y",
"managementSet": "Y",
"managementInternational": "Y",
"managementClean": "Y",
"managementGuideEdit": "Y",
"instanceDel": "N",
"instanceLog": "N",
"rightContent": "{\"m_edit\":\"Y\",\"m_del\":\"Y\",\"m_start\":\"Y\",\"m_set\":\"Y\",\"m_international\":\"Y\",\"m_clean\":\"Y\",\"m_guideEdit\":\"Y\"}",
"rightJsonObj": {
"m_edit": "Y",
"m_del": "Y",
"m_start": "Y",
"m_set": "Y",
"m_international": "Y",
"m_clean": "Y",
"m_guideEdit": "Y"
}
},
"reminders": null,
"trigerFlows": null,
"auths": null,
"sn": 0,
"favorites": false,
"hasGuide": false,
"id": "680370541093191680",
"main": false,
"bpmnXml": null,
"defXml": null
}],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 136,
"totalPages": 7
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | List< BpmDefinePo > | 流程定义列表 |
备注
- [1] : APIRequest为动态查询请求对象,详情请移步全局请求格式