更新地点

更新地点

Tip: - 如果传入生效时间当天不存在版本则会自动生成一个版本。

• 如果传入生效时间当天存在版本则会修改该版本。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/locations/:location_id
HTTP Method	PATCH
接口频率限制	5 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:locations:write 更新地点信息

请求头

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

路径参数

名称	类型	描述
location_id	string	地点ID。ID获取方式： - 调用【创建地点】【批量分页查询地点】等接口可以返回地点ID 示例值："1616161616"

查询参数

名称	类型	必填	描述
client_token	string	否	根据 client_token 是否一致来判断是否为同一请求 示例值：12454646

请求体

名称	类型	必填	描述
parent_id	string	否	上级地点，在创建场景下，该字段必填，枚举值及详细信息可通过【批量分页查询地点】查询获得 示例值："4719168654814483759"
names	i18n\[\]	否	地点名称 - 名称不能包含「/」「；」「;」「\」「'」字符 - 地点中英文名称会有全局唯一校验 数据校验规则： - 长度范围：0 ～ 5
└ lang	string	是	语言信息，中文用zh-CN，英文用en-US 示例值："zh-CN"
└ value	string	是	名称内容 示例值："中文示例"
active	boolean	否	地点启用/停用状态 - true 为启用 - false 为停用 示例值：true
effective_time	string	是	版本生效日期 - 填写格式：YYYY-MM-DD - 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日 - 日期范围要求:1900-01-01～9999-12-31 - 详情可以参考时间轴介绍 示例值："2020-05-02"
code	string	否	地点编码 (不能与其他记录的编码重复)，当开启自动编码时，该字段会失效 示例值："12456"
descriptions	i18n\[\]	否	地点描述 数据校验规则： - 长度范围：0 ～ 5
└ lang	string	是	语言信息，中文用zh-CN，英文用en-US 示例值："zh-CN"
└ value	string	是	描述内容 示例值："中文示例"
location_usages	enum\[\]	否	地点用途 ID，枚举值及详细信息可通过【批量查询地点用途】接口查询获得。 - 请求参数object_api_name=location；custom_api_name=location_usage 数据校验规则： - 长度范围：0 ～ 10
└ enum_name	string	是	枚举值 示例值："phone_type"
working_hours_type_id	string	否	工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 示例值："4690238309151997779"
locale	enum	否	区域设置 ID ，枚举值及详细信息可通过【批量查询枚举信息】接口查询获得。 - 请求参数object_api_name=location；custom_api_name=locale 示例值：zh_cn
└ enum_name	string	是	枚举值 示例值："phone_type"
time_zone_id	string	否	时区 ID 示例值："123456789"
display_language_id	string	否	默认显示语言 ID 示例值："123456789"

请求体示例

{
    "parent_id": "4719168654814483759",
    "names": [
        {
            "lang": "zh-CN",
            "value": "中文示例"
        }
    ],
    "active": true,
    "effective_time": "2020-05-02",
    "code": "12456",
    "descriptions": [
        {
            "lang": "zh-CN",
            "value": "中文示例"
        }
    ],
    "location_usages": [
        {
            "enum_name": "phone_type"
        }
    ],
    "working_hours_type_id": "4690238309151997779",
    "locale": {
        "enum_name": "phone_type"
    },
    "time_zone_id": "123456789",
    "display_language_id": "123456789"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

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