Skip to content

查询所有归档规则

查询所有归档规则,对应后台假勤管理-考勤统计-报表-归档报表功能

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/attendance/v1/archive_rule
HTTP MethodGET
接口频率限制50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用attendance:task:readonly 导出打卡数据

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小,必填参数
示例值:10
数据校验规则
- 取值范围:150
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:xxx

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsarchive_report_meta\[\]分页查询结果项
    └ report_idstring引用报表 ID,暂时无用
    └ report_namei18n_map引用报表name
      └ zhstring中文名称
      └ enstring英文名称
      └ jastring日文名称
    └ archive_rule_idstring归档报表规则ID,可用于查询归档报表表头
    └ archive_rule_namei18n_map归档报表name
      └ zhstring中文名称
      └ enstring英文名称
      └ jastring日文名称
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

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状态码错误码描述排查建议
4001220600通用错误信息通用错误信息包含多条,详细的错误信息以及处理建议可参见 错误信息
4001220001"%v"入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持
5001225000"%v"请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持

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