实例列表查询

Error: 为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至新版本>>

该接口通过不同条件查询审批系统中符合条件的审批实例列表。

请求

项目	值
HTTP URL	https://www.feishu.cn/approval/openapi/v2/instance/search
HTTP Method	POST
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	approval:approval.list:readonly 查询审批列表

请求头

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

请求体

参数	类型	必须	说明
user_id	string	是	用户 id
approval_code	string	否	审批定义 code
instance_code	string	否	审批实例 code
instance_external_id	string	否	审批实例第三方 id 注：和 approval_code 取并集
group_external_id	string	否	审批定义分组第三方 id 注：和 instance_code 取并集
instance_title	string	否	审批实例标题（只有第三方审批有）
instance_status	string	否	审批实例状态 REJECT：拒绝 PENDING：审批中 RECALL：撤回 DELETED： 已删除 APPROVED：通过 注：若不设置，查询全部状态 若不在集合中，报错
instance_start_time_from	int	否	实例查询开始时间（unix毫秒时间戳）
instance_start_time_to	int	否	实例查询结束时间 (unix毫秒时间戳)
locale	string	否	地区 （zh-CN、en-US、ja-JP）
offset	int	否	查询偏移量 注：不得超过10000
limit	int	否	查询限制量 注：不得超过200 不设置默认查询10条数据

Tip: 注：

1. user_id、approval_code、instance_code、instance_external_id、group_external_id 不得均为空
2. approval_code 和 group_external_id 查询结果取并集，instance_code 和 instance_external_id 查询结果取并集，其他查询条件都对应取交集
3. 查询时间跨度不得大于30天，开始和结束时间必须都设置，或者都不设置

请求体示例

{
	"user_id": "lwiu098wj",
	"approval_code": "EB828003-9FFE-4B3F-AA50-2E199E2ED942",
	"instance_code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
	"instance_external_id": "xxxxx",
	"group_external_id": "xxxx",
	"instance_title": "xxx",
	"instance_status": "PENDING",
	"instance_start_time_from": 1547654251506,
	"instance_start_time_to": 1547654251506,
	"locale": "zh-CN",
	"offset": 0,
	"limit": 50
}

响应

响应体

|参数|类型|说明| |-|-|-|-| |code |int |错误码，非0表示失败 | |msg | string | 返回码的描述| |data | map | 返回业务信息 | | ∟count|int|查询返回条数 | ∟instance_list|list|审批实例列表 |  ∟approval|map|审批定义 |   ∟code|string|审批定义 code |   ∟name|string|审批定义名称 |   ∟is_external|bool|是否为第三方审批 |   ∟external|map|第三方审批信息 |    ∟batch_cc_read |bool|是否支持批量读 |  ∟group|map|审批定义分组 |    ∟external_id|string|审批定义分组外部 id |    ∟name|string|审批定义分组名称 |  ∟instance|map|审批实例信息 |   ∟code|string|审批实例 code |   ∟external_id|string|审批实例外部 id |   ∟user_id|string|审批实例发起人 id |   ∟start_time|int|审批实例开始时间 |   ∟end_time|int|审批实例结束时间 |   ∟status|string|审批实例状态 |   ∟title|string|审批实例名称（只有第三方审批有） |   ∟extra|string|审批实例扩展字段 |   ∟serial_id|string|审批流水号 |   ∟link|map|审批实例链接（只有第三方审批有） |    ∟pc_link|string|审批实例 pc 端链接 |    ∟mobile_link|string|审批实例移动端链接

响应体示例

{
	"code": 0,
	"msg": "success",
	"data": {
		"count": 10,
		"instance_list": [
			{
				"approval": {
					"code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
					"name": "approval",
					"is_external": true,
					"external": {
						 "batch_cc_read": false,
					}
				},
				"group": {
					 "external_id": "0004",
				 	"name": "groupA",
				},
				"instance": {
					"code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
					"external_id": "0004_3ED52DC1-AA6C",
					"user_id": "lwiu098wj",
					"start_time": 1547654251506,
					"end_time": 1547654251506,
					"status": "PENDING",
					"title": "",
					"extra": "{}",
					"serial_id": "201902020001",
			 		"link": {
						"pc_link": "",
						"mobile_link": "",
					}
				}
			}
		]
	}
}