# 查询任务
查询任务。
**注意事项**：**注意**：
1. 请求参数 page_token 为必填字段，首次调用接口时必须传空值，表示从头开始遍历。
2. 当使用user access token访问时，表示获取当前用户发起以及收到的汇报，且结果不分页
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/report/v1/tasks/query
HTTP Method | POST
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看汇报任务(report:task:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
commit_start_time | int | 是 | 提交开始时间时间戳
**示例值**：1622427266
commit_end_time | int | 是 | 提交结束时间时间戳
**示例值**：1622427266
rule_id | string | 否 | 汇报规则ID
**示例值**："6894419345318182932"
user_id | string | 否 | 用户ID
**示例值**："ou_133f0b6d0f097cf7d7ba00b38fffb110"
page_token | string | 是 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**："6895699275733778451"
page_size | int | 是 | 单次分页返回的条数
**示例值**：10
**数据校验规则**：
- 取值范围：`0` ～ `20`
### 请求体示例
```json
{
"page_token": "6969507070261329948",
"commit_start_time":1618279343,
"commit_end_time":1623722543,
"page_size": 10,
"rule_id":6969410005221015580,
"user_id": "ou_c26134180ba2611aede183e5e3b531ed"
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | task\[\] | 任务列表
task_id | string | 汇报任务ID
rule_name | string | 规则名称
from_user_id | string | 汇报用户ID
from_user_name | string | 汇报用户名称
department_name | string | 汇报用户部门名称
commit_time | int | 提交时间时间戳
form_contents | form_content\[\] | 汇报表单内容
field_id | string | 表单字段ID
field_name | string | 表单字段名称
field_value | string | 表单字段值
**注意**：附件或图片该值为空，只返回 ID 与名称
rule_id | string | 汇报规则ID
department_ids | string\[\] | 汇报用户部门id
to_user_ids | string\[\] | 汇报给谁
to_user_names | string\[\] | 汇报给谁的名字
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
### 响应体示例
```json
{
"code": 0,
"data": {
"has_more": false,
"items": [
{
"commit_time": 1622714908,
"department_name": "",
"department_ids": [
"od-189f8c99b42d3e59e7a60eff213ca387"
],
"department_name": "测试部门",
"from_user_id": "ou_c26134180ba2611aede183e5e3b531ed",
"from_user_name": "hongyao",
"to_user_ids": [
"ou_e963cfd289ae7d3e21b11ae2d8c3c604",
],
"to_user_names": [
"gaojunqi"
],
"rule_name": "report test",
"task_id": "6969507459119693826"
"form_contents": [
{
"field_id": "6969506834487394305",
"field_name": "tset info",
"field_value": "4567"
},
{
"field_id": "6969506834487410689",
"field_name": "number",
"field_value": "789768"
},
],
}
]
},
"msg": ""
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1430001 | tenant key not exist | 确认参数正确性
400 | 1430002 | page size invalid | 确认参数正确性
400 | 1430003 | rule not exist | 确认参数正确性