# 修改字段枚举值选项

对于当前已有的所有自定义枚举字段，以及部分系统预置枚举字段，通过本接口可修改字段中已有可选项的展示名称、停启用状态
**注意事项**：本接口当前允许修改的系统预置字段如下：
  - 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（部门类型）

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/common_data/meta_data/edit_enum_option
HTTP Method | POST
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 读写元数据信息(corehr:common_data.meta_data:write)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 查询参数

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

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
object_api_name | string | 是 | 所属对象 API name，可通过[获取飞书人事对象列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name)接口中返回的 `object_api_name` 字段获取<br>**示例值**："probation_management"
enum_field_api_name | string | 是 | 枚举字段 API name，可通过[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query)接口中返回的 `custom_api_name` 字段获取<br>**示例值**："final_assessment_grade"
enum_field_option | enum_field_option | 是 | 枚举选项
option_api_name | string | 是 | 枚举值选项 API Name，即选项的唯一标识<br>**示例值**："grade_e"<br>**数据校验规则**：<br>- 长度范围：`1` ～ `100` 字符
active | boolean | 是 | 是否启用<br>**示例值**：true
name | name | 是 | 选项名称（需填写至少一个语种）
zh_cn | string | 否 | 中文<br>**示例值**："cn"
en_us | string | 否 | 英文<br>**示例值**："en"

### 请求体示例
```json
{
    "object_api_name": "probation_management",
    "enum_field_api_name": "final_assessment_grade",
    "enum_field_option": {
        "option_api_name": "grade_e",
        "active": true,
        "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 | 英文

### 响应体示例
```json
{
    "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. | 服务内部错误，请稍后重试。如有问题请[联系技术支持]((https://applink.feishu.cn/TLJpeNdW))
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 入参是否正确
400 | 1162023 | the type of field does not match | 字段类型不匹配，请检查 enum_field_option 入参是否正确
500 | 1162030 | enum set does not exist | 枚举常量集不存在，请[联系技术支持]((https://applink.feishu.cn/TLJpeNdW))处理
400 | 1162032 | the enum option api name already exists | 枚举选项的 API name 已存在，无法创建同名的新选项，请检查入参
400 | 1162034 | the associated enum set does not support changes yet | 所修改的系统预置枚举常量集不在系统允许的范围内。请参考文档开头说明的允许范围
400 | 1162040 | enum option does not exist | 枚举选项不存在，请[联系技术支持]((https://applink.feishu.cn/TLJpeNdW))处理

