获取工作日历信息

获取工作日历信息，如名称，状态等

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v1/leaves/work_calendar
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	corehr:common_data.basic_data:read 获取基础数据信息 corehr:corehr:readonly 获取核心人事信息 corehr:work_calendar:read 查询工作日历 corehr:employee:read 获取员工信息

请求头

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

请求体

名称	类型	必填	描述
wk_calendar_ids	string\[\]	是	工作日历ID列表，第一次传入时可以传入空数组，形如[] 示例值：["71369144159575915967136914415957591596"]
wk_calendar_id_gt	string	否	工作日历ID大于 示例值："7136914415957591596"
wk_option	wk_option	否	分页、排序等选项，如未填写将赋默认值
└ count	boolean	否	是否返回符合条件的工作日历总数，默认值为true 示例值：false
└ offset	int	否	分页查询的位移，从0开始，默认值为0 示例值：0
└ limit	int	是	分页查询单次查询数量，默认值为2000 示例值：20 数据校验规则： - 取值范围：1 ～ 2000
└ sort_options	sort_option\[\]	否	排序 数据校验规则： - 长度范围：0 ～ 50
└ sort_field	string	否	排序字段 示例值："wk_id"
└ sort_order	int	否	排序顺序 示例值：0 可选值有： - 0: 升序 - 1: 降序 数据校验规则： - 取值范围：0 ～ 1
└ sort_i18n	int	否	0=中文关键字;1=英文关键字;2=拼音 示例值：1 可选值有： - 0: 中文关键字 - 1: 英文关键字 - 2: 拼音 数据校验规则： - 取值范围：0 ～ 2
└ sort_by_strand_length	boolean	否	按某个字段的层级深度排序 示例值：false
└ sort_by_pinyin	boolean	否	是否按照拼音排序 示例值：false
└ sort_by_enum_value_order	boolean	否	是否按照枚举类型 value_order 排序 示例值：true
only_enable	boolean	否	是否只返回启用的工作日历。（暂不支持，目前只返回启用状态的工作日历） 示例值：true 默认值：true

请求体示例

{
    "wk_calendar_ids": [
        "71369144159575915967136914415957591596"
    ],
    "wk_calendar_id_gt": "7136914415957591596",
    "wk_option": {
        "count": false,
        "offset": 0,
        "limit": 20,
        "sort_options": [
            {
                "sort_field": "wk_id",
                "sort_order": 0,
                "sort_i18n": 1,
                "sort_by_strand_length": false,
                "sort_by_pinyin": false,
                "sort_by_enum_value_order": true
            }
        ]
    },
    "only_enable": true
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ work_calendars	work_calendar_detail\[\]	工作日历列表，对应入参的wk_calendar_ids
└ calendar_id	string	工作日历ID
└ calendar_name	wk_calendar_i18n	工作日历名称
└ zh_cn	string	中文值
└ en_us	string	英文值
└ enable	boolean	工作日历是否启用
└ count	int	入参count=true，则返回符合条件的工作日历总数

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "work_calendars": [
            {
                "calendar_id": "7136914415957591596",
                "calendar_name": {
                    "zh_cn": "日历1",
                    "en_us": "calendar1"
                },
                "enable": true
            }
        ],
        "count": 20
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
200	1160501	内部错误	内部错误，请联系开发人员；开放平台技术支持入口 技术支持