增量查询员工列表

接口描述

此接口为增量接口，用于按照员工最后变更日期查询员工。

接口权限

本接口需要集团权限

请求URI

/api/openapi/users

请求方式

GET

请求参数示例

/api/openapi/users?startTime=2020-02-01 00:00:00&endTime=2020-05-25 00:00:00&baseDate=xxxx&page=1&size=10

请求参数说明

参数名	类型	是否必填	说明
startTime	String	是	查询开始时间。格式: yyyy-MM-dd HH:mm:ss
endTime	String	是	查询结束时间。格式: yyyy-MM-dd HH:mm:ss
page	int	是	页码, 第一页的page为1
size	int	是	每页结果数。最大50
baseDate	String	否	日期格式：yyyy-MM-dd
companyOID	UUID	否	公司OID

接口返回示例

{
    "total": 1,
    "current": 1,
    "pageSize": 10,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
            "userOID": "cbd0bf2f-b355-4c2b-818b-6811d683ed40",
            "employeeId": "EMP-001",
            "fullName": "张三",
            "email": "san.zhang@spendia.jp",
            "company": {
                "oid": "8825b490-4454-4cdb-b061-7a440187e0f6",
                "code": "JP002"
            },
            "department": {
                "oid": "747cd010-073f-49f4-b44e-f8cd7e71f047",
                "code": "D1"
            },
            "onboardDate": "2019-12-27",
            "birthday": "1989-12-27",
            "gender": "2",
            "staffType": "01",
            "staffLevel": "3",
            "job": "1231",
            "position": "111",
            "loginCode": "A_001",
            "managerEmployeeId": "admin",
            "notificationStrategyCode": "policy_strategy_code",
            "status": "NORMAL",
            "isMFAEnabled": false,
            "customFields": [
                {
                    "fieldCode": "date",
                    "value": "2020-03-21T00:00:00.000Z"
                },
                {
                    "fieldCode": "time",
                    "value": "23:56"
                },
                {
                    "fieldCode": "country",
                    "value": "AE"
                }
            ],
            "postCustomFields": [
                {
                    "fieldCode": "order",
                    "value": "15"
                }
            ]
        }
    ]
}

接口返回字段

PageResposne

参数名	类型	说明
total	int	查询结果总个数
current	int	当前页数
pageSize	int	每页结果计
pages	int	查询结果总分页数
hasPrevious	boolean	是否有上一页
hasNext	boolean	是否有下一页
data	Employee[]	员工列表

Employee

字段名	类型	规则	说明
userOID	UUID	长度 36	员工OID
employeeId	String	最大长度 32	员工工号
fullName	String	最大长度 100	员工姓名
email	String	最大长度 255	邮件地址
company	EntitySummary	oid和code	员工归属公司
department	EntitySummary	oid和code	员工归属部门
onboardDate	Date	日期格式：yyyy-MM-dd	入职时间
birthday	String	日期格式：yyyy-MM-dd	员工生日
gender	String	值列表:性别,最大长度 50	员工性别
staffType	String	值列表:人员类型,最大长度 50	人员类型
job	String	值列表:职务,最大长度 50	职务
approvalLevel	String	值列表:审批级别,最大长度 10	审批级别
staffLevel	String	值列表:级别,最大长度 100	员工级别
loginCode	String	最大长度20	企业登录的员工ID
managerEmployeeId	String	最大长度 32	直属经理
customFields	CustomField[]	最多10个	员工扩展字段列表
postCustomFields	CustomField[]	最多10个	岗位扩展字段列表
notificationStrategyCode	String	最多20个	收信策略编码
fromDate	String	日期格式：yyyy-MM-dd	主岗开始日期
status	String		NORMAL-在职 LEAVING-待离职 RESIGNED-已离职
isMFAEnabled	Boolean		二次认证登录 true：有效 false：无效

EntitySummary

字段名	类型	必填	约束	说明
oid	UUID	否	长度 36	实体OID
code	String	否	长度 50	实体Code

CustomField

参数名	类型	约束	说明
fieldCode	String	最大长度 50	自定义字段编码
value	String	最大长度 200	自定义字段值，如果自定义字段设定为必填，则该值不可为空

失败示例

{
    "message": "当前操作需要租户权限",
    "errorCode": "120001"
}

字段说明

字段名称	类型	说明
message	String	返回信息说明
errorCode	String	返回错误码

错误代码

errorCode	message	说明
120001	当前操作需要租户权限
4003	时间格式为:{0}
6013009	日期格式为:yyyy-MM-dd

← 恢复离职员工根据工号查询员工 →