获取自定义字段列表接口调试

1. 概述

1.1 接口简介

获取当前企业已启用的自定义成员信息字段的定义，包括成员信息字段的标识、名称、类型及下拉选项。

支持公共模式和集成模式。

1.2 接口版本

2. 接口调用

2.1 接口信息

2.2 请求参数

2.3 请求示例

{
    "locale": "zh_cn"
}

无需指定语言时，可以提交 {}。

3. 接口响应

3.1 响应内容

3.2 响应示例

{
    "fields": [
        {
            "widget_name": "_widget_0300000000013",
            "name": "工号",
            "type": "text",
            "source": "preset",
            "no_repeat": true
        },
        {
            "widget_name": "_widget_1800000000001",
            "name": "用工类型",
            "type": "combo",
            "source": "custom",
            "items": [
                {
                    "text": "全职",
                    "value": "全职",
                    "selected": true
                },
                {
                    "text": "兼职",
                    "value": "兼职",
                    "selected": false
                }
            ]
        },
        {
            "widget_name": "_widget_1800000000002",
            "name": "入职日期",
            "type": "datetime",
            "source": "custom"
        }
    ]
}

示例仅供参考，具体字段以企业配置为准。

3.3 错误返回示例

例如 API Key 未获得本接口权限时，返回：

{
    "code": 17054,
    "msg": "Not among the authorized APIs.",
    "meta": {
        "apiId": "corp.user_field.list"
    }
}

4. 自定义成员信息列表的读写格式

v6版本成员接口均支持读写自定义成员信息字段列表。详情请参见：

其中添加、修改和增量导入成员时，ext 以字段标识为键，每个字段使用 { "value": 值 } 格式；读取时，字段标识直接对应字段值。