获取员工花名册字段信息旧版SDK

更新于 2024-05-22调用本接口，查询员工花名册指定字段的信息，支持明细分组字段。

重要

为提升接口使用体验，针对智能人事-花名册接口规范进行升级，从旧版升级到新版。本文旧版规范接口文档预计于 2024 年 6 月 22 日迁移至历史文档目录，且本接口仅保持现有功能，不再新增支持其他能力。

例如，张三个人档案如下图所示。调用本接口，可获取张三花名册指定字段的信息。

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

请求方式：POST

请求地址：https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list

名称

类型

是否必填

示例值

描述

access_token

String

是

af21xxx

调用该接口的应用凭证。

名称	类型	是否必填	示例值	描述
userid_list	String	是	user123,user456	员工的userid列表，多个userid之间使用逗号分隔，一次最多支持传100个值。
field_filter_list	String	否	sys01-positionLevel,sys05-nowContractEndTime	需要获取的花名册字段field_code值列表，多个字段之间使用逗号分隔，一次最多支持传100个值。说明该参数不传时，获取全部字段信息。查询字段越少，RT越低，建议按需查询。企业内部应用：查看花名册自定义字段业务code中field_code字段。调用获取花名册元数据接口获取field_code参数值。第三方企业应用，调用查询花名册中有权限的字段列表接口获取field_code参数值。
agentid	Number	是	1	应用的AgentId。企业内部应用，应用详情页获取应用 AgentId。第三方企业应用，通过获取企业授权信息接口获取agentid参数值。

名称	类型	示例值	描述
result	EmpRosterFieldVo[]		返回结果。
corp_id	String	ding20a11xxx	企业的corpid。
field_data_list	EmpFieldDataVo[]		返回的字段信息列表。
field_name	String	员工状态	字段名称。
field_code	String	sys01-employeeStatus	字段标识。
group_id	String	sys01	分组标识。
field_value_list	FieldValueVo[]		字段值列表。明细分组字段包含多条。非明细分组仅一条记录。
item_index	Number	0	第几条的明细标识，下标从0开始。
label	String	正式	字段展示值，选项类型字段对应选项的value。
value	String	3	字段取值，选项类型字段对应选项的key。
userid	String	042519	员工的userid。
success	Boolean	true	调用是否成功。 true：成功 false：失败
errcode	Number	0	返回码。
errmsg	String	ok	返回码描述。
request_id	String	8badquf9r90f	请求ID。

请求示例（HTTP）

请求正文

请求示例（JAVA SDK）

返回示例

这篇文档是否有帮助？

本页内容