dingtalk.oapi.hrm.employee.get (获取智能人事指定员工花名册详细数据)

获取智能人事指定员工花名册详细数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
userid String 必须 11111 查询用户userid

响应参数

名称 类型 示例值 描述
group_list FieldGroupVpo [] [{...},{...}] 花名册分组列表
  • field_list
  • SysCustomFieldVpo []
  • [{...},{...}]
  • 字段列表
  • └ hidden_from_employee_flag
  • Boolean
  • true
  • 员工查看个人档案时,该字段是否隐藏
  • └ contact_client_flag
  • Boolean
  • true
  • 手机端通讯录个人信息页,是否显示该字段
  • └ contact_system_flag
  • Boolean
  • true
  • 是否是通讯录系统字段
  • └ contact_flag
  • Boolean
  • true
  • 是否是通讯录字段,包括系统字段和扩展字段
  • └ system_flag
  • Boolean
  • true
  • 智能人事花名册默认的系统字段,包含通讯录的系统字段和花名册新增的字段
  • └ value
  • String
  • 字段的值
  • 字段的值
  • └ hint
  • String
  • 请选择
  • 花名册字段说明
  • └ option_text
  • String
  • ["女","男"]
  • 选项类花名册字段的选择内容,是一个json数组
  • └ type_name
  • String
  • -
  • 类型名,有文本,图片,选项,时间四种类型
  • └ field_type
  • String
  • -
  • 字段类型,有TEXT,IMAGE,SELECT,TIME四种类型,与type_name一一对应
  • └ required
  • Boolean
  • true
  • 是否必须
  • └ editable_by_hr
  • Boolean
  • true
  • HR是否可编辑该字段
  • └ deleted
  • Boolean
  • true
  • 是否已删除
  • └ editable_by_emp
  • Boolean
  • true
  • 员工是否可编辑
  • └ visible_by_emp
  • Boolean
  • true
  • 员工填写入职登记表的时候,该字段是否可见
  • └ field_name
  • String
  • 手机号码
  • 字段名称
  • └ field_code
  • String
  • d1f3
  • 字段code
  • └ corp_id
  • String
  • ding123123
  • corpId
  • └ no_watermark
  • Boolean
  • true
  • 是否无水印,仅针对图片类型的字段
  • └ confirm_entry_required
  • Boolean
  • true
  • 人事管理员确认员工入职的时候,是否必填该字段
  • └ group_name
  • String
  • 工作信息
  • 花名册分组名
  • └ group_id
  • String
  • sys02
  • 花名册分组id
errcode Number dingOpenErrcode
errmsg String 参数异常 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/hrm/employee/get");
OapiHrmEmployeeGetRequest req = new OapiHrmEmployeeGetRequest();
req.setUserid("11111");
OapiHrmEmployeeGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "group_list":[
        {
                "field_list":[
                    {
                            "hidden_from_employee_flag":true,
                            "contact_client_flag":true,
                            "contact_system_flag":true,
                            "contact_flag":true,
                            "system_flag":true,
                            "value":"字段的值",
                            "hint":"请选择",
                            "option_text":"[\"女\",\"男\"]",
                            "type_name":"-",
                            "field_type":"-",
                            "required":true,
                            "editable_by_hr":true,
                            "deleted":true,
                            "editable_by_emp":true,
                            "visible_by_emp":true,
                            "field_name":"手机号码",
                            "field_code":"d1f3",
                            "corp_id":"ding123123",
                            "no_watermark":true,
                            "confirm_entry_required":true
                    }
                ],
                "group_name":"工作信息",
                "group_id":"sys02"
        }
    ],
    "errcode":略,
    "errmsg":"参数异常"
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部