增加字段枚举值选项

对于当前已有的所有自定义枚举字段，以及部分系统预置枚举字段，通过本接口可在字段中批量新增可选项

Tip: 本接口当前允许修改的系统预置字段如下：

• person（个人信息）：gender（性别）、marital_status（婚姻状态）
• address（地址）：address_type（地址类型）
• national_id（证件）：national_id_type（证件类型）
• education（教育经历）：degree（学位）、level_of_education（学历）
• person_info_chn (个人附加信息) ： hukou_type（户口类型）
• emergency_contact（紧急联系人）：relationship（关系）
• dependent（家庭成员）：relationship_with_dependent（关系）
• job_data （任职信息）：employee_type (人员类型)
• probation （试用期对象）：final_assessment_grade （试用期最终考核等级）
• department（部门）：subtype（部门类型）

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v1/common_data/meta_data/add_enum_option
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:common_data.meta_data:write 读写元数据信息

请求头

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

查询参数

名称	类型	必填	描述
client_token	string	否	用户若希望避免重试导致多次重复请求，可填写随机字符串，系统根据 client_token 是否一致来判断是否为同一请求 示例值：6727817538283013641

请求体

名称	类型	必填	描述
object_api_name	string	是	所属对象 API name，可通过获取飞书人事对象列表接口中返回的 object_api_name 字段获取 示例值："probation_management"
enum_field_api_name	string	是	枚举字段 API name，可通过获取自定义字段列表接口中返回的 custom_api_name 字段获取 示例值："final_assessment_grade"
enum_field_options	enum_field_option\[\]	是	新增枚举选项列表 数据校验规则： - 最小长度：1
└ option_api_name	string	是	枚举值选项 API Name，即选项的唯一标识，创建后无法修改。由用户自拟，需以英文字母开头，并仅允许包含小写英文字母、数字和下划线 示例值："grade_e" 数据校验规则： - 长度范围：1 ～ 100 字符
└ name	name	是	选项名称（需填写至少一个语种）
└ zh_cn	string	否	中文 示例值："cn"
└ en_us	string	否	英文 示例值："en"

请求体示例

{
    "object_api_name": "probation_management",
    "enum_field_api_name": "final_assessment_grade",
    "enum_field_options": [
        {
            "option_api_name": "grade_e",
            "name": {
                "zh_cn": "cn",
                "en_us": "en"
            }
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ enum_field_api_name	string	枚举字段 API name
└ enum_field_options	enum_field_option\[\]	枚举全部选项列表
└ option_api_name	string	枚举值选项 API Name，即选项的唯一标识
└ active	boolean	是否启用
└ name	name	选项名称（需填写至少一个语种）
└ zh_cn	string	中文
└ en_us	string	英文

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "enum_field_api_name": "final_assessment_grade",
        "enum_field_options": [
            {
                "option_api_name": "grade_e",
                "active": true,
                "name": {
                    "zh_cn": "cn",
                    "en_us": "en"
                }
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1161999	System error. Please try again later or contact technical support.	服务内部错误，请稍后重试。如有问题请联系技术支持
400	1160004	client_token repeat	入参中的 client_token 重复，请检查是否有异常并发重试
400	1162010	object does not exist	对象不存在，请检查 object_api_name 入参是否正确
400	1162020	field does not exist	字段不存在，请检查 enum_field_api_name 入参是否正确
500	1162030	enum set does not exist	枚举常量集不存在，请联系技术支持处理
400	1162032	the enum option api name already exists	枚举选项的 API name 已存在，无法创建同名的新选项，请检查入参
400	1162041	invalid enum option api name	枚举选项的 API name 不合法，请确认 API name 长度不超过 63 个字符，以英文字母开头，且仅包含小写英文字母、数字和下划线
400	1162034	the associated enum set does not support changes yet	所修改的系统预置枚举常量集不在系统允许的范围内。请参考文档开头说明的允许范围