流程业务接口说明

流程可以绑定业务事件，用来操作不同的按钮时，触发不同的按钮事件。

本文档是流程业务事件的接口说明。

流程提交操作

流程提交用于前端框架提交按钮调用逻辑,支持流程发起及流程审批,支持选人/选环节/选环节选人等操作。

• 请求URL

  /api/bfp/framework/actions/submit

• 请求方式

  POST

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  isSaveData	boolean	BODY参数	是	是否保存业务数据
  formData	List<Map<String, Object>>	BODY参数	是	业务表单数据
  activitys	ActivityAppointInfo[]	BODY参数	否	活动指派信息
  sendParticipants	WFParticipant[]	BODY参数	否	抄送参与者
  processContext	ProcessContext	BODY参数	是	流程上下文
  bfpContext	BfpContext	BODY参数	是	框架上下文

  • activitys活动指派信息结构示例：

        [
          {
            "appointedParticipants": [
              {
                "attributes": {},
                "id": "string",
                "name": "string",
                "typeCode": "string"
              }
            ],
            "id": "string",
            "isAppoint": true
          }
        ]
    

    • bfpContext框架上下文机构示例：

        {
          "actionCode": "操作编码",
          "draftId": 0,
          "formData": {},
          "opinions": "审批意见",
          "pageType": "页面类型",
          "pkId": "string"
        }
    

    • processContext流程上下文结构示例：

        {
          "actionURL": "string",
          "activityDefID": "string",
          "activityInstID": 0,
          "activityInstName": "string",
          "bizState": 0,
          "catalogName": "string",
          "catalogUUID": "string",
          "currentState": 0,
          "currentUser": "string",
          "isRollback": "string",
          "isTimeOut": "string",
          "previousActivityType": "string",
          "processChName": "string",
          "processCreateTime": "string",
          "processCreater": "string",
          "processCreaterName": "string",
          "processDefID": 0, 
          "processDefName": "string",
          "processInstID": 0,
          "processInstName": "string",
          "processVersion": "string",
          "tenantId": "string",
          "workItemID": 0,
          "workItemName": "string"
        }
    

    • sendParticipants抄送参与者结果示例：

        [
          {
            "attributes": {},
            "id": "string",
            "name": "string",
            "typeCode": "string"
          }
        ]
    

• 出参

  参数名	数据类型	说明
  BaseResult	BaseResult	响应结果信息

  • BaseResult响应结果结构示例：

        {
          "code": 0,
          "data": {},
          "message": "string",
          "total": 0
        }
    

• 错误编码

  错误编码	描述	语义
  400	Bad Request	请求参数异常
  401	Unauthorized	服务认证失败
  404	Not Found	服务不存在!
  500	Internal Server Error	服务调用失败!
  200	Ok	服务调用成功

流程回退操作

流程回退操作用于前端框架回退按钮调用逻辑,支持流程多种回退模式。

• 请求URL

  /api/bfp/framework/actions/rollback

• 请求方式

  POST

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  backType	String	BODY参数	是	回退类型
  backSubmitWay	String	BODY参数	是	回退后提交策略，默认default_submit
  targetActDefID	String	BODY参数	否	目标回退活动定义ID(当回退类型为any_manual或appoint_manual时需要传入此参数)
  isSaveData	boolean	BODY参数	是	是否保存业务数据
  formData	List<Map<String, Object>>	BODY参数	是	业务表单数据
  processContext	ProcessContext	BODY参数	是	流程上下文
  bfpContext	BfpContext	BODY参数	是	框架上下文

  • 回退类型类别：

    • recent_manual ： 回退到上一步人工环节
    • any_manual ： 回退到任一环节
    • apply_manual ： 回退到发起人
    • appoint_manual ： 回退到指定环节

  • bfpContext框架上下文机构示例：

    请参见流程提交操作bfpContext框架上下文机构示例。

  • processContext流程上下文结构示例：

    请参见流程提交操作processContext流程上下文结构示例。

• 出参

  参数名	数据类型	说明
  BaseResult	BaseResult	响应结果信息

  • BaseResult响应结果结构示例：

      {
        "code": 0,
        "data": {},
        "message": "string",
        "total": 0
      }
  

• 错误编码

  错误编码	描述	语义
  400	Bad Request	请求参数异常
  401	Unauthorized	服务认证失败
  404	Not Found	服务不存在!
  500	Internal Server Error	服务调用失败!
  200	Ok	服务调用成功

流程终止操作

流程终止操作用于前端框架终止按钮调用逻辑。

• 请求URL

  /api/bfp/framework/actions/terminate

• 请求方式

  POST

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  isSaveData	boolean	BODY参数	是	是否保存业务数据
  formData	List<Map<String, Object>>	BODY参数	是	业务表单数据
  processContext	ProcessContext	BODY参数	是	流程上下文
  bfpContext	BfpContext	BODY参数	是	框架上下文

  • bfpContext框架上下文机构示例：

    请参见流程提交操作bfpContext框架上下文机构示例。

  • processContext流程上下文结构示例：

    请参见流程提交操作processContext流程上下文结构示例。

• 出参

  参数名	数据类型	说明
  BaseResult	BaseResult	响应结果信息

  • BaseResult响应结果结构示例：

      {
        "code": 0,
        "data": {},
        "message": "string",
        "total": 0
      }
  

• 错误编码

  错误编码	描述	语义
  400	Bad Request	请求参数异常
  401	Unauthorized	服务认证失败
  404	Not Found	服务不存在!
  500	Internal Server Error	服务调用失败!
  200	Ok	服务调用成功

撤回工作任务

撤回工作任务用于我的已办页面工作任务撤回

• 请求URL

  /api/bfp/framework/workbench/back-task

• 请求方式

  POST

• Content-Type

  application/json

• 入参

  参数名	数据类型	参数类型	是否必选	说明
  workItemID	long	BODY参数	是	工作项ID

• 出参

  参数名	数据类型	说明
  BaseResult	BaseResult	响应结果信息

  • BaseResult响应结果结构示例：

      {
        "code": 0,
        "data": {},
        "message": "string",
        "total": 0
      }
  

• 错误编码

  错误编码	描述	语义
  400	Bad Request	请求参数异常
  401	Unauthorized	服务认证失败
  404	Not Found	服务不存在!
  500	Internal Server Error	服务调用失败!
  200	Ok	服务调用成功