退回审批任务

从当前审批任务，退回到已审批的一个或多个任务节点。退回后，已审批节点重新生成审批任务。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/approval/v4/instances/specified_rollback
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	approval:approval 查看、创建、更新、删除审批应用相关信息 approval:approval:readonly 访问审批应用 approval:task 同意、拒绝、退回、加签等原生审批任务操作
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
user_id	string	是	当前审批任务的审批人的用户 ID，ID 类型与查询参数 user_id_type 取值一致。可调用获取单个审批实例详情，从返回结果的 task_list 参数中获取用户 ID 以及任务状态必须为 PENDING。 示例值："893g4c45"
task_id	string	是	当前需要回退的审批任务 ID。可调用获取单个审批实例详情，从返回结果的 task_list 参数中获取任务 ID 以及任务状态必须为 PENDING。 示例值："7026591166355210260"
reason	string	否	退回原因 示例值："申请事项填写不具体，请重新填写"
extra	string	否	扩展字段。 注意：灰度参数，暂未开放使用。 示例值："demo"
task_def_key_list	string\[\]	是	需要退回到的任务 node_key。可调用获取单个审批实例详情，从返回结果的 timeline 参数中获取，且动态类型 type 必须为 PASS。 示例值：["START","APPROVAL_27997_285502","APPROVAL_462205_2734554"] 数据校验规则： - 长度范围：1 ～ 100

请求体示例

{
    "user_id": "893g4c45",
    "task_id": "7026591166355210260",
    "reason": "申请事项填写不具体，请重新填写",
    "extra": "demo",
    "task_def_key_list": [
        "START",
        "APPROVAL_27997_285502",
        "APPROVAL_462205_2734554"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1390001	param is invalid	参数错误。排查方案： - 根据接口文档的参数说明，检查请求时传入的参数是否正确。 - 如果传入的有表单参数（form），则需要检查该参数内传入的表单控件数据是否正确。如果报错信息内包含控件 ID（如 控件= widget17261088448220001），可以调用查看指定审批定义或者获取单个审批实例详情接口，获取响应参数 form 值，检索有问题的控件 ID，然后检查该控件的配置是否正确。

更多错误码信息，参见通用错误码。