查询归档报表表头

查询归档报表表头，对应后台假勤管理-考勤统计-报表-归档报表中一个归档报表的表头信息。归档报表支持引用系统报表，可设置归档时间和数据归档周期，并且支持根据部门/人员、国家/地区、人员类型、工作地点、职级、序列、职务进行人员圈选。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/attendance/v1/archive_rule/user_stats_fields_query
HTTP Method	POST
接口频率限制	50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	attendance:task 写入打卡数据

请求头

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

查询参数

名称	类型	必填	描述
employee_type	string	是	请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限，可使用通过手机号或邮箱获取用户 ID * employee_id ：员工 employee ID，即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID * employee_no：员工工号，即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 示例值：employee_id

请求体

名称	类型	必填	描述
locale	string	否	语言类型。默认为zh。 可选值有： * en：英语 * ja：日语 * zh：中文 示例值："zh"
month	string	是	月份，日期格式为yyyyMM 示例值："202409"
archive_rule_id	string	是	归档规则id，可根据查询所有归档规则获得 示例值："1"
operator_id	string	是	操作者id，对应employee_type 示例值："ax8ud"

请求体示例

{
    "locale": "zh",
    "month": "202409",
    "archive_rule_id": "1",
    "operator_id": "ax8ud"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ archive_report_fields	archive_field\[\]	统计数据表头
└ code	string	字段编号
└ title	string	字段名称
└ upper_titles	string\[\]	表头名称层级路径

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "archive_report_fields": [
            {
                "code": "1",
                "title": "工号",
                "upper_titles": [
                    "基本信息"
                ]
            }
        ]
    }
}

错误码

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