查询编制规划方案

根据传入的筛选项获取编制规划的方案列表

Tip: 该接口会按照应用拥有的「部门数据」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限」中有申请「部门资源」权限范围

• 请求体入参如果没有特殊说明，不填写默认为空，不参与筛选。
• 所有筛选项可一起使用，之间为 AND 关系。
• 延迟说明：数据库主从延迟 2s 以内，即：直接创建编制规划方案后 2s 内调用此接口可能查询不到数据。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/workforce_plans
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:workforce_plan:read 查看编制规划方案信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
get_all_plan	boolean	否	是否获取所有编制规划方案，默认为 false。 - true 所有编制规划方案列表。 - false 为仅获取当前生效的编制规划方案。 示例值：false
active	boolean	否	是否只获取已启用的方案，默认为 true。 - true 获取已启用编制规划方案 - false 获取所有编制规划方案， 示例值：false

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	workforce_plan\[\]	编制规划方案列表
└ workforce_plan_id	string	编制规划方案 ID
└ workforce_plan_name	i18n\[\]	编制规划方案名称
└ lang	string	语言信息，中文为 zh-CN，英文为 en-US
└ value	string	内容
└ start_date	string	开始日期 - 返回格式：YYYY-MM-DD（最小单位到日） - 日期范围:1900-01-01 ～ 9999-12-31
└ end_date	string	结束日期 - 返回格式：YYYY-MM-DD（最小单位到日） - 日期范围:1900-01-01 ～ 9999-12-31
└ active	boolean	是否启用 - true 表示启用 - false 表示停用
└ total	int	满足条件的方案总数

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "workforce_plan_id": "123456",
                "workforce_plan_name": [
                    {
                        "lang": "zh-CN",
                        "value": "张三"
                    }
                ],
                "start_date": "2020-10-01",
                "end_date": "2020-10-31",
                "active": true
            }
        ],
        "total": 100
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
503	1161204	Requset timeout	请求超时，请稍后重试。如无法解决可联系飞书开放平台技术支持。
429	1161604	QPS over limit	请求量过大，请稍后访问。如无法解决可联系飞书开放平台技术支持。
400	1160109	param is invalid	请检查是否传入了无效参数。如无法解决可联系飞书开放平台技术支持。
403	1160100	no permission	请检查是否申请对应权限。如无法解决可联系飞书开放平台技术支持。

其他错误码参考: 全量错误码详细描述