Skip to content

批量创建/更新明细行

批量创建/更新明细行后,可在【设置-编制规划设置-编制规划XXX-编辑数据】进行查看。

Warning: 批量创建/更新明细行说明:同批次操作场景下,禁止创建/更新重复行,与此同时,创建时若明细行已存在于系统中,则会在底层自动触发更新机制;建议不要录入编制规划值和预估在职人数均为零值的明细行,系统会对全0明细行进行过滤,从而在页面上不显示该行,可能会导致用户误以为该明细行不存在。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/workforce_plan_detail_row/batchSave
HTTP MethodPOST
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:workforce_detail:write 写入编制规划明细信息

请求头

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

请求体

名称类型必填描述
workforce_plan_idstring编制规划id,可在「设置-编制规划设置-编制规划XXX-页面URL」中解析到。
示例值:"7430330781544564268"
itemsworkforce_plan_detail_row\[\]编制规划的明细行数量应介于 1 至 5 个之间。
数据校验规则
- 长度范围:15
  └ dimensionsdimension_entity\[\]编制规划的维度信息要和用户创建的维度匹配,即传入除自动匹配维度外的所有维度,不多不少。
通过「设置-编制规划设置-编制规划XXX」查看该编制规划有哪些维度。
数据校验规则
- 长度范围:120
    └ dimension_keystring维度key,可从下面列表中进行选择: - "department":部门。 - "employee_type" :人员类型。 - "location":地点 - "position" :岗位。 - "cost_center" :成本中心/业务线。 - "job_family" :序列。 - "job_level" :职级。 - "job" :职务。 - "pathway":通道。
自定义组织: - "custom_org_01" - "custom_org_02" - "custom_org_03" - "custom_org_04" - "custom_org_05"
示例值:"department"
    └ dimension_valuestring维度value。 - department_id:可从查询部门获得。 - location_id:可从查询地点获得。 - cost_center_id:可从查询成本中心获得。 - job_id:可从查询职务获得。 - job_level_id:可从查询职级获得。 - job_family_id:可从查询序列获得。 - employee_type_id:可从查询人员类型获得。 - position_id:可从查询岗位获得。 - pathway_id: 可从查询通道获得。 - custom_org_01_id:可从查询自定义组织获得。 - custom_org_02_id:可从查询自定义组织获得。 - custom_org_03_id:可从查询自定义组织获得。 - custom_org_04_id:可从查询自定义组织获得。 - custom_org_05_id:可从查询自定义组织获得。
示例值:"7322790168290739756"
  └ eai_detailsworkforce_plan_eai_detail\[\]预估在职人数相关信息。可从「设置-编制规划设置-编辑编制规划XXX」查看预估在职人数的时间,如果不存在该字段说明用户创建时即没有允许填写该字段,批量创建/更新明细行时则无需给该字段,如果存在,用户需要查看预估在职人数的日期,使用示例值格式进行传参。 - 当编制规划方案的时间范围是“按自然周期选择”时无法使用,按“自定义日期”可以使用
数据校验规则
- 长度范围:015
    └ datestring预估在职人数的日期,和编制规划页面上显示的预估在职人数的日期一致,且格式要依照示例给定,若二者不匹配,则无法完成识别更新。
示例值:"2020-10-31"
    └ estimated_active_individualsstring预估在职人数应与创建编制规划时指定的小数位数相匹配,若不匹配,则无法更新。小数位查看方式:「设置-编制规划-编制规划XXX」查看预估在职人数的小数位数。
示例值:"10"
  └ plan_valuestring编制规划值。需与创建编制规划时指定的小数位数相匹配,若不匹配,则无法更新。小数位查看方式:「设置-编制规划-编制规划XXX」查看编制规划的小数位数。注意当编制规划方案是按自然周期选择时,该值必须为空,需要设置自然周期的编制规划信息multi_period_values。 - 当编制规划方案的时间范围是“按自然周期选择”时无法使用,按“自定义日期”可以使用
示例值:"12"
  └ multi_period_valuesworkforce_plan_multi_period_value\[\]自然周期的编制规划信息。当编制规划方案是按自然周期选择时,设置该字段。
数据校验规则
- 长度范围:015
    └ period_datestring周期的最后一天
示例值:"2022-10-31"
    └ workforce_planstring对应自然周期的编制规划值。编制规划值需与创建编制规划时指定的小数位数相匹配,若不匹配,则无法更新。小数位查看方式:「设置-编制规划-编制规划XXX」查看编制规划的小数位数。
示例值:"12.00"
    └ individuals_to_be_addedstring对应自然周期的预增员数量。批量创建更新时,无需写入此字段。
示例值:"10.00"
    └ individuals_to_be_removedstring对应自然周期的预减员数量。批量创建更新时,无需写入此字段。
示例值:"10.00"

请求体示例

json
{
    "workforce_plan_id": "7435976673130317356",
    "items": [
        {
            "dimensions": [
                {
                    "dimension_key": "department",
                    "dimension_value": "7371716294248908332"
                },
                {
                    "dimension_key": "location",
                    "dimension_value": "7312702817660487212"
                },
                {
                    "dimension_key": "cost_center",
                    "dimension_value": "7212847939319219756"
                },
                {
                    "dimension_key": "job_family",
                    "dimension_value": "7210959705752192556"
                },
                {
                    "dimension_key": "employee_type",
                    "dimension_value": "7210608964277601836"
                }
            ],
            "plan_value": "919",
            "eai_details": [
                {
                    "date": "2029-01-31",
                    "estimated_active_individuals": "9"
                },
                {
                    "date": "2029-02-28",
                    "estimated_active_individuals": "99"
                }
            ]
        }
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

下面是错误码的简单示例,详细描述可通过下面的链接查看。

错误码

HTTP状态码错误码描述排查建议
4001160001param is invalid请先参考全量错误码详细描述进行错误排查,如问题始终无法解决请联系技术支持

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

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