查询所有归档规则
查询所有归档规则,对应后台假勤管理-考勤统计-报表-归档报表功能
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/archive_rule |
| HTTP Method | GET |
| 接口频率限制 | 50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | attendance:task:readonly 导出打卡数据 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小,必填参数 示例值:10 数据校验规则: - 取值范围: 1 ~ 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:xxx |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | archive_report_meta\[\] | 分页查询结果项 |
└ report_id | string | 引用报表 ID,暂时无用 |
└ report_name | i18n_map | 引用报表name |
└ zh | string | 中文名称 |
└ en | string | 英文名称 |
└ ja | string | 日文名称 |
└ archive_rule_id | string | 归档报表规则ID,可用于查询归档报表表头 |
└ archive_rule_name | i18n_map | 归档报表name |
└ zh | string | 中文名称 |
└ en | string | 英文名称 |
└ ja | string | 日文名称 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"report_id": "7341290237441605652",
"report_name": {
"zh": "1",
"en": "alice",
"ja": "1"
},
"archive_rule_id": "7341290237441605652",
"archive_rule_name": {
"zh": "1",
"en": "alice",
"ja": "1"
}
}
],
"page_token": "xxx",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1220600 | 通用错误信息 | 通用错误信息包含多条,详细的错误信息以及处理建议可参见 错误信息 |
| 400 | 1220001 | "%v" | 入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持 |
| 500 | 1225000 | "%v" | 请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持 |
