校验三方审批实例
调用该接口校验三方审批实例数据,用于判断服务端数据是否为最新的。请求时提交实例最新更新时间,如果服务端不存在该实例,或者服务端实例更新时间不是最新的,则返回对应实例 ID。
例如,设置定时任务每隔 5 分钟,将最近 5 分钟产生的实例使用该接口进行对比。如果数据在服务端不存在或者不是最新,则可以根据本接口返回的实例 ID、任务 ID,前往同步三方审批实例。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/approval/v4/external_instances/check |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | approval:approval 查看、创建、更新、删除审批应用相关信息 approval:approval:readonly 访问审批应用 approval:external_instance 查看、创建、更新、删除三方审批实例相关信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
instances | exteranl_instance_check\[\] | 是 | 校验的实例信息 |
└ instance_id | string | 是 | 审批实例 ID。自定义配置,需要确保当前企业、应用内唯一。 注意:调用本接口和同步三方审批实例接口操作同一个三方审批实例时,需要确保所用的实例 ID 一致。 示例值:"1234234234242423" |
└ update_time | string | 是 | 审批实例最近更新时间,Unix 毫秒时间戳。 示例值:"1591603040000" |
└ tasks | external_instance_task\[\] | 是 | 任务信息 |
└ task_id | string | 是 | 审批实例内的审批任务 ID。自定义配置,需要确保当前企业、应用内唯一。 注意:调用本接口和同步三方审批实例接口操作同一个三方审批实例内的任务时,需要确保所用的任务 ID 一致。 示例值:"112253" |
└ update_time | string | 是 | 任务最近更新时间,Unix 毫秒时间戳。 示例值:"1591603040000" |
请求体示例
json
{
"instances": [
{
"instance_id": "1234234234242423",
"update_time": "1591603040000",
"tasks": [
{
"task_id": "112253",
"update_time": "1591603040000"
}
]
}
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ diff_instances | exteranl_instance_check_response\[\] | 更新时间不一致的实例信息 |
└ instance_id | string | 审批实例 ID |
└ update_time | string | 任务最近更新时间,Unix 毫秒时间戳。 |
└ tasks | external_instance_task\[\] | 任务信息 |
└ task_id | string | 任务 ID |
└ update_time | string | 任务最近更新时间,Unix 毫秒时间戳。 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"diff_instances": [
{
"instance_id": "1234234234242423",
"update_time": "1591603040000",
"tasks": [
{
"task_id": "112253",
"update_time": "1591603040000"
}
]
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1390001 | param is invalid | 参数错误。排查方案: - 根据接口文档的参数说明,检查请求时传入的参数是否正确。 - 如果传入的有表单参数(form),则需要检查该参数内传入的表单控件数据是否正确。如果报错信息内包含控件 ID(如 控件= widget17261088448220001),可以调用查看指定审批定义或者获取单个审批实例详情接口,获取响应参数 form 值,检索有问题的控件 ID,然后检查该控件的配置是否正确。 |
| 400 | 1395001 | There have been some errors. Please try again later | 服务出现错误。排查方案: 1. 参考接口文档的参数说明,检查请求时传入的参数是否正确。如果传入的有表单参数(form),则需要检查传入的表单控件数据是否正确。 2. 降低请求频率,并重试。如果重试仍然报错,请联系技术支持。 |
更多错误码信息,参见通用错误码。
