获取员工花名册字段信息新版SDK
更新于 2024-06-11调用本接口，查询员工花名册指定字段的信息，支持明细分组字段。
花名册中的附件信息（如员工照片、身份证正面、反面等）不支持通过接口下载。如需获取请用户前往钉钉客户端，可以在花名册下载或者导出附件。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 智能人事个人信息读权限 | API Explorer |
| 第三方企业应用 | 支持 | 智能人事个人信息读权限 | API Explorer |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证：
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
userIdList | Array of String | 是 | 员工的 userId 列表，多个 userId 之间使用英文逗号分隔，一次最多支持传100个值。 |
fieldFilterList | Array of String | 否 | 需要获取的花名册字段field_code值列表，多个字段之间使用逗号分隔，一次最多支持传100个值。 说明
|
appAgentId | Long | 是 | 应用的AgentId，详情参考 AgentId。 |
text2SelectConvert | Boolean | 否 | 文本转选项字段处理标识。
Loading...
Loading... |
返回参数
名称 | 类型 | 描述 |
|---|---|---|
result | Array | 结果列表。 |
corpId | String | 企业的corpId。 |
userId | String | 员工的userId。 |
unionId | String | 暂未开放。 |
fieldDataList | Array | 返回的字段信息列表。 |
fieldCode | String | 字段标识。 |
fieldName | String | 字段名称。 |
groupId | String | 分组标识。 |
fieldValueList | Array | 字段值列表。 说明
|
value | String | 字段取值，选项类型字段对应选项的key。 |
label | String | 字段展示值，选项类型字段对应选项的value。 |
itemIndex | Integer | 第几条的明细标识，下标从0开始。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | noPermission | 无访问权限 | 无访问权限 |
400 | invalidParameter | 系统参数无效或者传入的微应用Id和员工userId有误 | 系统参数无效或者微应用Id和员工userId传入有误 |
500 | systemError | 系统异常 | 系统异常 |
