Skip to content

批量获取审批实例 ID

根据审批定义的 approval_code 批量获取审批实例的 instance_code,用于拉取企业下某个审批定义的全部审批实例。默认以审批创建时间先后顺序排列。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/approval/v4/instances
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可approval:approval 查看、创建、更新、删除审批应用相关信息 approval:approval:readonly 访问审批应用 approval:instance 查看、创建、更新、删除原生审批实例相关信息

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
page_sizeint分页大小,用于指定一次请求所返回的数据量上限。
示例值:100
默认值100
数据校验规则
- 取值范围:1100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU
approval_codestring审批定义 Code。获取方式:
- 调用创建审批定义接口后,从响应参数 approval_code 获取。 - 登录审批管理后台,在指定审批定义的 URL 中获取,具体操作参见什么是 Approval Code
示例值:7C468A54-8745-2245-9675-08B7C63E7A85
start_timestring审批实例创建时间的开始区间,毫秒时间戳。
说明:start_time 与 end_time 组成时间区间查询条件,接口会返回在该时间区间内创建的审批实例数据。
> Warning: 单次查询时间范围不要超过10小时
示例值:1567690398020
end_timestring审批实例创建时间的结束区间,毫秒时间戳。
说明:start_time 与 end_time 组成时间区间查询条件,接口会返回在该时间区间内创建的审批实例的 Code。
> Warning: 单次查询时间范围不要超过10小时
示例值:1567690398020

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ instance_code_liststring\[\]审批实例 Code 列表,默认以审批实例创建时间的先后顺序排列。
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "instance_code_list": [
            "357C21A0-2069-4F6B-955F-1DFBE6710C51"
        ],
        "page_token": "nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU",
        "has_more": false
    }
}

错误码

HTTP状态码错误码描述排查建议
4001390001param is invalid参数错误。排查方案: - 根据接口文档的参数说明,检查请求时传入的参数是否正确。 - 如果传入的有表单参数(form),则需要检查该参数内传入的表单控件数据是否正确。如果报错信息内包含控件 ID(如 控件= widget17261088448220001),可以调用查看指定审批定义或者获取单个审批实例详情接口,获取响应参数 form 值,检索有问题的控件 ID,然后检查该控件的配置是否正确。
4001390002approval code not found找不到审批定义 Code,检查传入的审批定义 Code 是否正确。 审批定义 Code 获取方式: - 调用创建审批定义接口后,从响应参数 approval_code 获取。 - 登录审批管理后台,在指定审批定义的 URL 中获取,具体操作参见什么是 Approval Code
4001395001There have been some errors. Please try again later服务出现错误。排查方案: 1. 参考接口文档的参数说明,检查请求时传入的参数是否正确。如果传入的有表单参数(form),则需要检查传入的表单控件数据是否正确。 2. 降低请求频率,并重试。如果重试仍然报错,请联系技术支持

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理