用户查询
- 接口:common/users/v2/findByPage
- Method:GET
- 接口说明:根据其他查询条件查询(支持按照最后更新时间、部门编码、上级编码查询)查询用户信息
- 多语言环境:实现多语言环境方式是在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
请求参数
| 字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度 |
| bizId |
String |
业务唯一识别码 |
true |
255 |
| timestamp |
long |
时间戳 |
true |
无 |
| page_num |
Integer |
分页页数 (默认1,最小1) |
false |
|
| page_size |
Integer |
分页条数 (默认100,仅支持20,50,100) |
false |
|
| department_code |
String |
部门编码 |
false |
64 |
| parent_code |
String |
上级编码 |
false |
64 |
| start_datetime |
long |
最后更新时间-开始时间(13位数字时间戳) |
false |
13 |
| end_datetime |
long |
最后更新时间-结束时间(13位数字时间戳) |
false |
13 |
请求示例
/common/users/v2/findByPage?parent_code=yw1@qq.com&department_code=D1&start_datetime=1650407339000&end_datetime=1650580139000
返回参数
默认返参
| 字段名称 |
字段类型 |
字段描述 |
| resCode |
Integer |
状态码 |
| resMsg |
String |
描述 |
| data.page_num |
Integer |
分页数 |
| data.total_page |
Integer |
总页数 |
| data.page_size |
Integer |
分页大小 |
| data.total_count |
Integer |
总条数 |
| data.is_first_page |
boolean |
是否第一页 |
| data.is_last_page |
boolean |
是否最后一页 |
| data.page_info |
Array |
数据结果列表 |
| data.page_info.user_name |
String |
用户名 |
| data.page_info.code |
String |
编码( 即员工号) |
| data.page_info.full_name |
String |
全名 |
| data.page_info.email_address |
String |
邮箱 |
| data.page_info.gender |
String |
性别 |
| data.page_info.department.department.code |
String |
部门编码 |
| data.page_info.department.department_name |
String |
部门名称 |
| data.page_info.last_update_date |
long |
最后更新时间 |
| data.inactive_date |
long |
失效时间 |
| ####可配置返参 |
|
|
| 字段名称 |
字段类型 |
字段描述 |
| :----------------------------- |
:------- |
:----------- |
| data.full_name |
String |
全名 |
| data.user_name |
String |
用户名 |
| data.surname |
String |
姓 |
| data.given_name |
String |
名 |
| data.email_address |
String |
邮箱 |
| data.mobile |
String |
手机号 |
| data.description |
String |
描述 |
| data.dingtalk_name |
String |
钉钉号 |
| data.dingtalk_unionid |
String |
钉钉unionid |
| data.feishu_name |
String |
飞书号 |
| data.wechatqy_name |
String |
企业微信号 |
| data.sub_company |
String |
子公司 |
| data.inactive_date |
date |
失效日期 |
| data.parent.* |
JSONObject |
关联上级字段,相关表为fnd_user |
| data.approval_level |
int |
审批级别 |
| data.gender |
string |
性别 |
| data.employee_number |
string |
员工号 |
| data.base_city |
int |
所在城市 |
| data.base_city.* |
JSONObject |
关联的城市信息,相关表fnd_city,dic_city |
| data.birthday |
date |
生日 |
| data.profession |
string |
职业 |
| data.nationality |
string |
国籍 |
| data.telephone |
string |
电话 |
| data.address |
string |
地址 |
| data.postcode |
string |
邮政编码 |
| data.department.* |
JSONObject |
关联的部门信息,相关表fnd_department |
| data.cost_center.* |
JSONObject |
关联的部门信息,相关表fnd_department |
| data.branch.* |
JSONObject |
关联的部门信息,相关表fnd_department |
| data.position.* |
JSONObject |
关联的部门信息,fnd_position |
| data.level.* |
JSONObject |
关联的部门信息,fnd_level |
| data.date_of_joining |
date |
入职日期 |
| data.resignation_date |
date |
离职日期 |
| data.start_work_date |
date |
开始工作时间 |
| data.default_language |
String |
默认语言 |
| data.sub_account_name |
String |
子账号名称 |
| data.credit_score |
int |
信用分 |
| data.credit_level |
int |
信用等级 |
| data.point_balance |
decimal |
积分余额 |
| data.point_frozen |
decimal |
积分冻结 |
| data.column1-column50 |
string |
column字段对应的名称 |
| data.attribute1-attribute5 |
string |
attribute字段对应的名称 |
| data.creation_date |
date |
创建日期 |
| data.last_update_date |
date |
最后更新日期 |
返回示例
{
"resCode": 200000,
"resMsg": "success",
"data": {
"page_size": 100,
"page_num": 1,
"total_count": 1,
"total_page": 1,
"is_first_page": true,
"is_last_page": true,
"page_info": [
{
"code": "20220315",
"gender": "M",
"departmentVo": {
"code": "D1",
"department_name": "Tiny Ship",
"department_code": "D1"
},
"email_address": "20220315@qq.com",
"full_name": "outV2用户",
"employee_number": "20220315",
"user_name": "20220315@qq.com",
"last_update_date": 1650522539000,
"approval_level": 2
}
]
}
}