创建员工

接口描述

此接口用于创建员工

限制・前提条件

关于和和部门间的关系、
所属部门必须在部门主数据中登录;
员工的主岗开始日需要在包含在部门的有效开始日和终了日之间;

接口权限

本接口需要集团权限

请求URI

/api/openapi/users

请求方式

POST

请求体示例

{
    "employeeId": "EMP-001",
    "fullName": "张三",
    "email": "san.zhang@spendia.jp",
    "onboardDate": "2020-01-01",
    "birthday": "1990-01-01",
    "gender": "0",
    "staffType": "01",
    "job": "01",
    "approvalLevel": "111",
    "staffLevel": "1",
    "loginCode": "A_001",
    "notificationStrategyCode": "policy_strategy_code",
    "mobile":"123456789",
    "countryCode":"JP",
    "company": {
        "oid": "051dbcbe-02d5-45b0-9159-1e28da3b0412",
        "code": "COM-1"
    },
    "department": {
        "oid": "051dbcbe-12d5-45b0-9159-1e28da3b0414",
        "code": "DEPT-1"
    },
    "managerEmployeeId": "EMP-2",
    "customFields": [
        {
            "fieldCode": "date",
            "value": "2020-3-21"
        }
    ],
    "postCustomFields": [
        {
            "fieldCode": "order",
            "value": "15"
        }
    ],
    "fromDate": "2021-04-07",
    "accountTypeCode": "1",
    "isMFAEnabled": false
}

请求体字段

Employee

字段名 类型 必填 主键 约束 说明
employeeId String 最大长度 32 员工工号
fullName String 最大长度 100 员工姓名
email String 最大长度 128 邮件地址
onboardDate String 日期格式:yyyy-MM-dd 入职时间
birthday String 日期格式:yyyy-MM-dd 员工生日
gender String 值列表:性别,最大长度 50 员工性别
staffType String 值列表:人员类型,最大长度 50 人员类型
job String 值列表:职务,最大长度 50 职务
approvalLevel String 值列表:审批级别,最大长度 10位数字 审批级别
loginCode String 最大长度20 企业登录的员工ID
staffLevel String 值列表:级别,最大长度 100 员工级别
company EntitySummary oid和code 二选一 员工归属公司
department EntitySummary oid和code 二选一 员工归属部门
managerEmployeeId String 最大长度 32 直属经理工号
customFields CustomField[] 最多10个,不支持图片类型的字段 员工扩展字段列表,fieldCode不能重复
postCustomFields CustomField[] 最多10个,不支持图片类型的字段 岗位扩展字段列表,fieldCode不能重复
notificationStrategyCode String 最大长度 20 员工收信策略编码
mobile String 电话
countryCode String 英大文字2位
CN(+86/中国)
JP(+81/日本)
US(+1/美国)
电话的国家编码
fromDate String 日期格式:yyyy-MM-dd 主岗开始日期
accountTypeCode String 1:租户间的主務、2:租户间的兼務 租户间兼岗区分
isMFAEnabled Boolean 默认:有效 二次认证登录
true:有效
false:无效

EntitySummary

字段名 类型 必填 约束 说明
oid UUID 长度 36 实体OID
name String 长度 50 实体name
code String 长度 50 实体Code
path String 实体path(仅部门)

CustomField

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

接口返回示例

成功

{
    "message": "success",
    "oid": "3249b50a-1e29-4cae-93ea-bfec4955fafa",
    "key": "EMP-1"
}

失败示例

{
    "message": "参数:gender,最大长度50",
    "errorCode": "0013"
}

字段说明

字段名称 类型 说明
message String 返回信息说明
errorCode String 返回错误码
oid UUID 员工OID
key String 员工工号

错误代码

errorCode message 说明
0013 参数:{0},最大长度{1} 字段长度超出限制
120001 当前操作需要租户权限
120003 缺少必填项:{0} 必填字段不能为空
120210 Email不合法
120222 员工最多有10个扩展字段
120223 员工扩展字段编码不能为空
120225 员工扩展字段值不能为空
120227 员工扩展字段编码不能重复
121301 公司不存在
121307 部门不存在
6013009 日期格式为:yyyy-MM-dd
6040014 邮箱已被占用 邮箱整个环境不能重复,不仅时公司内部,其他公司员工已经该邮箱则无法再登录
6047044 工号已存在
6047060 无效的直属领导工号
6047061 性别不存在
6047062 人员类型不存在
6047063 职务不存在
6047064 级别不存在
6061005 自定义字段:{0} 不能为空
6061006 自定义字段:{0} 的值填写不正确
6061007 自定义字段:{0} 的值未按扩展字段规则填写
6061008 自定义字段:{0} 的值整数位数请输入{1}位以内
6061009 自定义字段:{0} 的值浮点数位数请输入{1}位以内
6061010 自定义字段:{0} 的值时间格式不对
6061011 自定义字段:{0} 的值日期格式为YYYY-MM-dd
8702002 操作失败,存在未关联公司的部门
8702003 操作失败,员工归属公司与归属部门对应公司不一致
12458005 员工ID只能是20位以内字母、数字、-、_
12458006 输入的员工ID已存在,请重新输入
136791002 策略编号,请不要输入【英文字母,数字,-,_】 以外的字符
136791003 收信策略{0},不存在或已失效
136791004 请输入20字以内的字符
6047054 无效的部门编码
6047055 无效的公司编码
0010 参数{0}格式错误
6047034 该工号找不到员工
6047044 工号已存在
6047068 审批级别不存在
120224 员工扩展字段校验失败:{0}
60390001 没有有效的岗位
60390003 未找到员工的主岗(基准日期{0})
60390006 部门在区间{0}到{1}内被禁用(从{2}到{3}) 因为所属部门在主岗有效期内无效,所以不能登录
60390007 部门在区间{0}到{1}内无效(从{2}到{3}) 因为所属部门在主岗有效期内不存在,所以不能登录
60390008 岗位已存在开始日期为{0}的期间
60390010 员工在区间{0}到{1}内已存在同一公司同一部门的有效岗位期间(从{2}到{3})
60390011 岗位部门所属公司与岗位所属公司不一致
60390012 岗位(期间从{0}到{1})的公司与部门在期间{2}到{3}内的对应公司不一致
60390013 修改岗位开始日{0}为{1}跨越了一个期间(从{2}到{3})
60390014 修改岗位结束日{0}为{1}跨越了一个期间(从{2}到{3})
60390015 变更岗位开始日{0}为{1}跨越了一个期间(从{2}到{3})
60390016 主岗在区间{0}到{1}内被禁用(从{2}到{3})
60390017 主岗在区间{0}到{1}内无效(从{2}到{3})
60390018 存在主岗有效范围外的辅岗(从{0}到{1})
60000006 国家编码验证规则不存在,国家编码:{0}
220002 电话号码格式不正确
6040013 手机号已被占用 手机号码整个环境不能重复,不仅时公司内部,其他公司员工已经该邮箱则无法再登录
6047478 租户间兼务区分请输入1或者2,(1:租户间的主務、2:租户间的兼務)
spd.9596.004 工号 {0} 员工为共通邮箱,兼岗区分不能设为主岗 共同邮箱:account@common.spendia.jp
2009 获取clientId失败
120015 开始日期不能大于结束日期
120226 员工扩展字段编码不存在:{0}
120252 最多有10个扩展字段
120917 值列表控件的配置发生变更,操作失败(控件:{0})
120918 {0}的配置发生变更,请确认配置
6040005 公司无效
6040020 一个邮箱绑定多个用户,存在错误数据
6040021 一个手机号绑定多个用户,存在错误数据
6047007 邮箱为空
6047018 其他未知错误
6047020 电话号码为空
6047021 电话号码已被使用
6047028 部门已失效
6047029 无法匹配公司
6047049 部门编码不能包含汉字
6047050 部门编码不能包含非法字符
6047051 部门编码不能超过36位
6047056 离职日期不能为空
6047057 待离职的员工工号不存在
9500006 {0} 超出有效范围(1970/01/01 00:00:01~2038/01/19 03:14:07)
12020015 租户不存在
60390019 存在岗位期间外的业务单据,保存失败
60390020 该岗位已存在业务单据,禁用失败
spd.9596.005 当前员工在其他租户中存在岗位,租户间兼务区分不可变更 使用租户集时,在集团公司下面有兼岗时,不可变更。
THIRD_PARTY_APPLICATION_004 无法识别的客户端标识或者该客户端没有权限
spd.13871.001 {0}:字数输入范围为{1}~{2}