预览审批流程
在创建审批实例之前，可调用本接口预览审批流程数据。在创建审批实例之后，可调用本接口预览某一审批节点的后续流程数据。
使用说明
- 创建审批实例之前预览整个审批的流程数据，调用方式与创建审批实例接口类似，需要传入审批定义 Code（approval_code）、审批提交人信息（user_id、department_id）、审批表单数据（form）参数，进行预览。
- 创建审批实例之后预览审批实例内某一审批任务之后的流程数据，需要传入审批实例 Code（instance_code）、审批任务 ID（task_id）、审批任务的审批人 ID（user_id），进行预览。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/approval/v4/instances/preview |
| HTTP Method | POST |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | approval:approval:readonly 访问审批应用 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 以应用身份调用 API，可读写的数据范围由应用自身的 数据权限范围 决定。参考 自建应用获取 tenant_access_token 或 商店应用获取 tenant_access_token。 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" |
| 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 |
请求体
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| approval_code | string | 否 | 审批定义 Code。获取方式： - 调用创建审批定义接口后，从响应参数 approval_code 获取。 - 登录审批管理后台，在指定审批定义的 URL 中获取，具体操作参见什么是 Approval Code。 示例值："7C468A54-8745-2245-9675-08B7C63E7A85" |
| user_id | string | 是 | 用户 ID，ID 类型与查询参数 user_id_type 的取值一致。 - 在创建审批实例之前预览审批流程，此处需要传入审批发起人的用户 ID。 - 在创建审批实例之后预览某审批任务的后续流程，此处需要传入审批任务审批人 ID。 |
| department_id | string | 否 | 审批发起人所属的部门 ID。了解更多参见部门 ID。 注意：如果用户只属于一个部门，该参数选填。如果用户属于多个部门，则必须填其中一个部门 ID。 |
| form | string | 否 | 审批表单的控件 JSON 值。 注意：在创建审批实例之前预览审批流程，该参数必填。 示例值：[ {\"id\":\"widget16256287451710001\", \"type\": \"number\", \"value\":\"43\"}] |
| instance_code | string | 否 | 审批实例 Code。获取方式： - 创建审批实例 后，从返回结果中获取审批实例 Code。 - 调用批量获取审批实例 ID，获取指定审批定义内的审批实例 Code。 - 调用查询实例列表，设置过滤条件查询指定的审批实例 Code。 示例值："81D31358-93AF-92D6-7425-01A5D67C4E71" |
| task_id | string | 否 | 审批任务 ID。获取方式： - 调用获取单个审批实例详情接口，在响应结果的 task_list 参数内获取 id。 - 调用查询任务列表接口，在响应结果中获取 task_id。 注意：在创建审批实例之后预览某审批任务的后续流程，该参数必填，并且 user_id 需要传入任务的审批人 ID。 |
请求体示例
case1：创建审批实例之前预览审批流程
json
{
"approval_code":"C2CAAA90-70D9-3214-906B-B6FFF947F00D",
"user_id":"f7cb567e",
"department_id":"",
"form":"[{\"id\":\"widget16256287451710001\", \"type\": \"number\", \"value\":\"43\"}]"
}case2：创建审批实例之后预览某任务后的审批流程
json
{
"instance_code":"12345CA6-97AC-32BB-8231-47C33FFFCCFD",
"user_id":"f7cb567e",
"task_id": "6982332863116876308"
}响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码，非0表示失败 |
| msg | string | 返回码的描述 |
| data | json | 返回业务信息 |
| └ preview_nodes | list | 预览节点信息 |
| └ user_id_list | list | 审批人 ID 列表 |
| └ end_cc_id_list | list | 审批结束抄送人 ID 列表 |
| └ node_id | string | 审批节点 ID |
| └ node_name | string | 审批节点名称 |
| └ node_type | string | 审批节点类型。可能值有： - AND：会签 - OR：或签 - AUTO_PASS：自动通过 - AUTO_REJECT：自动拒绝 - SEQUENTIAL：按顺序 |
| └ custom_node_id | string | 用户自定义节点 ID |
| └ comments | list | 节点的说明信息 |
| └ is_empty_logic | boolean | 审批人是否为空，若为空，则 user_id_list 为兜底审批人 ID 列表。 |
| └ is_approver_type_free | boolean | 是否发起人自选节点 |
| └ has_cc_type_free | boolean | 节点是否支持抄送人自选 |
响应体示例
json
{
"code":0,
"msg":"success",
"data": {
"preview_nodes":[
{
"user_id_list":["ffffffff"],
"end_cc_id_list":[],
"node_id":"b078ffd28db767c502ac367053f6e0ac",
"node_name":"发起",
"node_type":"",
"comments":[],
"custom_node_id":""
},
{
"user_id_list":["ffffffff"],
"end_cc_id_list":[],
"node_id":"e6ce10282a3cc3bf4a408feffd678dcf",
"node_name":"审批",
"node_type":"AND",
"comments":[],
"custom_node_id":"",
"is_empty_logic":false,
"is_approver_type_free":false,
"has_cc_type_free":false
},
{
"user_id_list":[],
"end_cc_id_list":[],
"node_id":"b1a326c06d88bf042f73d70f50197905",
"node_name":"结束",
"node_type":"",
"comments":[],
"custom_node_id":""
}
]
}
}更多错误码信息，参见通用错误码。