Skip to content

任务列表查询

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

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

请求

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

请求头

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

请求体

参数类型必须说明
user_idstring用户 id
approval_codestring审批定义 code
instance_codestring审批实例 code
instance_external_idstring审批实例第三方 id
注:和 approval_code 取并集
group_external_idstring审批定义分组第三方 id
注:和 instance_code 取并集
task_titlestring审批任务标题(只有第三方审批有)
task_statusstring审批任务状态
PENDING: 审批中
APPROVED: 通过
REJECTED: 拒绝
TRANSFERRED:转交
DONE: 已完成
RM_REPEAT: 去重
PROCESSED: 已处理
注:若不设置,查询全部状态
若不在集合中,报错
task_start_time_fromint任务查询开始时间 (unix毫秒时间戳)
task_start_time_toint任务查询结束时间 (unix毫秒时间戳)
localestring地区(zh-CN、en-US、ja-JP)
offsetint查询偏移量
注:不得超过10000
limitint查询限制量
注:不得超过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天,开始和结束时间必须都设置,或者都不设置

请求体示例

json
{
	"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",
	"task_status": "PENDING",
	"task_title": "xxx",
	"task_start_time_from": 1547654251506,
	"task_start_time_to": 1547654251506,
	"locale": "zh-CN",
	"offset": 0,
	"limit": 50,
}

响应

响应体

|参数|类型|说明| |-|-|-|-| |code |int |错误码,非0表示失败 | |msg | string | 返回码的描述| |data | map | 返回业务信息 | | ∟count|int|查询返回条数 | ∟task_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|审批实例移动端链接 |  ∟task|map|审批任务 |   ∟start_time|int|审批任务开始时间 |   ∟user_id|string|审批任务发起人 id |   ∟end_time|int|审批任务结束时间 |   ∟title|string|审批任务名称 |   ∟status|string|审批任务状态 |   ∟extra|string|审批任务扩展字段 |   ∟link|map|审批任务链接 |    ∟pc_link|string|审批任务 pc 端链接 |    ∟mobile_link|string|审批任务移动端链接

响应体示例

json
{
	"code": 0,
	"msg": "success",
	"data": {
		"count": 10,
		"task_list": [
			{
				"approval": {
					"code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
					"name": "qingjia",
					"is_external": true,
				 	"external": {
						"batch_cc_read": false,
					}
				},
				"group": {
					"external_id": "0004",
					"name": "approvalgroupA",
				},
				"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": "",
					}
				},
				"task": {
					"user_id": "lwiu098wj",
					"start_time": 1547654251506,
					"end_time": 1547654251506,
					"status": "PENDING",
					"title": "",
					"extra": "{}",
					"link": {
						"pc_link": "",
						"mobile_link": "",
					}
				}
			}
		]
	}
}

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