批量审批

爱搭贝
更新于2025-06-09

批量审批开放接口

批量审批一共涉及三个接口，校验批量审批支持、批量提交、进度查询共三个接口。

8.1、校验支持

  • 该接口用于查询用户可审批的任务是否允许批量审批
  • 接口地址：/batch_approvals/_check?user_id={user_id} 请求方式：POST

请求数据

参数类型必填param说明
user_idstring是url参数用户id信息
task_idsarry是request body需要检测的是否允许批量审批的的任务ids
  • 注意：task_ids每次最多200个

样例：

["f787e22d0b87420d8149bda63d708cc8","b57d38973ac94c01ac7d81187a7e1742"]

响应数据

  • 将根据请求的taskIds返回对应的支持状态以及是否支持情况
参数类型必填说明
supportedbool是如果true表示可进行批量审批，如果为false则不支持，会在下方的reason里给出说明
reasonstring是当supported为false时，将显示对应的不支持的原因

样例：

[
   {
      "supported": true
   },
   {
      "supported": false,
      "reason": "未开启reason"
   }
]


8.2、批量提交

  • 该接口用于将8.1中获取的可支持的taskId进行批量提交,注意，本接口为异步提交。可通过8.3进度查询获取执行状态
  • /batch_approvals/_submit?user_id={user_id} 请求方式：POST

请求参数

参数名类型必填param说明
user_idstring是url参数指定要进行提交任务的用户id
task_idsarry是request body需要进行批量审批的任务ids
  • 注意：task_ids每次最多200个

样例：

["f787e22d0b87420d8149bda63d708cc8","b57d38973ac94c01ac7d81187a7e1742"]

响应数据

  • 返回一个批量流水号，可通过该批次号进行查询进度
参数类型必填说明
batch_numberstring是每次批量提交，返回一个提交的批次号，根据该批次号可进行下方的进度查询

样例：

{
   "batch_number":"9dd6622a77a94542af73f9494d76d75b"
}

8.3、进度查询

  • 该接口用于对提交的批量审批流程的审批状态进行查询
  • /batch_approvals/_submit?user_id={user_id}&batch_number={batch_number}  请求方式：GET

请求参数

  • 注：除了uri外，这个参与与流程是完全一样的
参数类型必填param说明
user_idstring是url参数批次提交执时的用户id，注意必须和下方的batch_numer的提交人为一批次
batch_numberstring是url参数批量提交后，平台侧返回的批次号

响应数据

  • 返回一个批量流水号，可通过该批次号进行查询进度
参数类型必填说明
batch_numberstring是对应请求中的batch_number
totalnumber是batch_number时提交的总的任务数量
processednumber是这一批次已经处理完成的任务数据，注意：包括失败数量
failed_tasksarray/string是返回这一批次已经的任务id，失败原因包括：任务已经关闭或者删除。这种情况需要引导用户手工详情办理审批

样例：

{
   "batch_number":"5d8fcb6ee3e74503a524add03dfd90a3",
   "total":100,
   "processed":30,
   "failed_tasks":["d9d4873518a7493f9b1e4d98dd27266e","f5b43d57d330408a834b4edb9d86bf43"]
}