WorkPlus 开放平台

主题

账号同步 ​

组织 ​

组织导入 ​

注意，组织导入的时候，要先把组织层级排序下，低层级的要先进行导入。如AAA，AAA/BBB。要先把AAA导入再进行AAA/BBB导入，否则会出现根组织找不到的问题。

js
POST http://{host}:{port}/v1/admin/organizations/{org_code}/import-orgs?access_token={access_token}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

字段类型是否必填说明
access_tokenStringY访问token
org_codeStringY组织标识
typeStringY节点类型,DEPT或者CORP
parent_pathStringN父节点path
parent_idStringN父节点ID,与parent_path不能同时为空
nameStringY节点名称
logoStringNlogo媒体ID
telStringN电话
contactStringN联系人
snStringN节点编号
serial_noStringN第三方序列号,唯一
sort_orderIntegerN排序号

请求示例：

json
[
    {
        "name": "测试部", 
        "sn": "00010122", 
        "serial_no": "00010122", 
        "type": "DEPT", 
        "parent_path": "恒拓高科/地产集团", 
        "sort_order": 0
    }, 
    {
        "name": "临高合作地产", 
        "sn": "00010124", 
        "serial_no": "00010124", 
        "type": "CORP", 
        "parent_path": "恒拓高科/地产集团", 
        "sort_order": 0
    }
]

响应参数：

字段类型是否必填说明
successesMap[String, String]Y导入成功组织，key为组织路径，value为组织id
failuresMap[String, String]Y导入成功组织，key为组织路径，value为错误信息

响应示例：

json
{
  "status": 0, 
  "message": "Everything is ok.", 
  "result": {
    "successes": {
      "恒拓高科/地产集团/测试部": 2699
    }, 
    "failures": {
      "恒拓高科/地产集团/临高合作地产": 2700
    }
  }
}

组织删除 ​

js
DELETE http://{host}:{port}/v1/admin/organizations/{org_code}/{id}?access_token={access_token}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

字段类型是否必填说明
access_tokenStringY访问token
org_codeStringY组织标识
idStringY组织id

响应示例：

json
{
  "status": 0,
  "message": "ok",
  "result": {
    // result
  }
}

错误返回值：

statusmessage
208507组织下已存在雇员
208502没有对应的组织

组织架构列表 ​

不推荐使用!

js
GET http://{host}:{port}/v1/admin/organizations/{code}/list-all?access_token={access_token}&org_id={org_id}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

字段类型是否必填说明
domain_idStringY域信息
codeStringY组织标识
org_idStringN节点ID,不传则查根节点

请求示例：

js
/v1/admin/organizations/{code}/list-all?access_token={token}

响应示例：

json
{
  "status": 0, 
  "message": "ok", 
  "result": [
    {
      "id": "aaa", 
      "domain_id": "xxx", 
      "org_code": "xxx", 
      "type": "CORP", 
      "path": "/aaa/", 
      "name": "xxx", 
      "en_name": "xxx", 
      "tw_name": "xxx", 
      "logo": "xxx", 
      "sort_order": 1, 
      "level": 1, 
      "uuid": "aaa", 
      "owner_id": "xxx", 
      "owner": "xxx", 
      "owner_name": "xxx", 
      "created": 1534829681346, 
      "last_modified": 1564998633361, 
      "disabled": false, 
      "employee_count": 0, 
      "all_employee_count": 0, 
      "employees": [ ], 
      "children": [ ]
    }
  ]
}

雇员 ​

雇员列表 ​

js
GET http://{host}:{port}/v1/admin/organizations/{code}/employees?access_token={access_token}

请求参数：

字段类型是否必填说明
domain_idStringY域信息
codeStringY组织标识
typeStringN默认值为"id",为"username"时,query为用户名查询
queryStringN查询条件
pathStringN组织路径,非空时, 查该路径下, 符合query查询条件的雇员
matchingbooleanN为true时, 根据type类型不同, 按,隔开查雇员列表, 为false时, 模糊查询该机构下的雇员信息

请求示例：

  1. 根据userid批量查询雇员信息
js
/v1/admin/organizations/{code}/employees?access_token={access_token}&matching=true&query=userId1,userId2,userId3
  1. 根据username批量查询雇员信息
js
/v1/admin/organizations/{code}/employees?access_token={access_token}&matching=true&type=username&query=username1,username2,username3
  1. 指定组织节点查询雇员信息
js
/v1/admin/organizations/{code}/employees?access_token={access_token}&org_id=999&recursion=true
  1. 指定路径查询雇员信息,path每个节点均为为orgId,query匹配雇员名
js
/v1/admin/organizations/{code}/employees?access_token={access_token}&path=/111/222/333&query=aaa

响应示例：

点击查看响应数据
json
{
  "status": 0, 
  "message": "ok", 
  "result": [
    {
      "id": "xxxx", // 雇员ID
      "type": "EMPLOYEE", // 雇员类型,固定值
      "domain_id": "xxx", // 域标识
      "org_code": "xxx",  //组织标识
      "display_name": "李四", //名称
      "name": "李四", // 名称
      "pinyin": "lisi", //拼音
      "initial": "ls", //拼音首字母
      "gender": "MALE", //姓名
      "email": "1231414324@qq.com", //邮箱
      "status": "ACTIVATED", //状态,已激活
      "sn": "IMPL00001", // 工号
      "user_id": "xxx", // 用户ID
      "username": "****", // 账号
      "nickname": "1", // 昵称
      "sort_order": 999, //排序号
      "senior": false, //是否高管
      "locked": false, //是否离职
      "employee_rank": 0, //职级ID
      "tags": [
        1 // 雇员标签
      ], 
      "tag_names": [
        "分组1-标签1" //标签名称
      ], 
      "positions": [
        {
          "id": "xxxxxx", //职位ID
          "domain_id": "xxx", //域标识
          "code": "xxxx", //组织标识
          "employee_id": "fdf82464bba34dc5a86f7af9ee20b3db", //雇员ID
          "org_id": "abc", // 组织节点ID
          "path": "/aaa/abc/", //组织path
          "type": "CORP", 
          "job_title": "xxxx", // 职位
          "level": 2,  // 组织层级
          "primary": true, // 是否主职位
          "chief": false,  // 是否首要职位
          "display_nodes": [
            {
              "id": "aaa", //节点ID
              "name": "xxxx", //节点名称
              "type": "CORP", //节点类型
              "path": "/aaa/", //节点path
              "display": true //是否显示
            }, 
            {
              "id": "abc", //节点ID
              "name": "xxxx", //节点名称
              "type": "CORP", //节点类型
              "path": "/aaa/abc/", //节点path
              "display": true //是否显示
            }
          ], 
          "full_name_path": "/xxxx/xxxx/", //中文全路径
          "org_name": "xxxx" //节点名称
        }
      ], 
      "data_schemas": [
        {
          "domain_id": "xxxx", //域标识
          "org_code": "xxxxx", //组织标识
          "id": "xx", //ID
          "property": "xxx", //名称
          "type": "TEXT", //类型
          "name": "xxx", //显示名称
          "alias": "姓名", //显示昵称
          "en_alias": "Name", //英文昵称
          "tw_alias": "姓名", //繁体昵称
          "options": [ ], 
          "min": -1, 
          "max": -1, 
          "visible_range": "ALL", //可见范围
          "ops_range": "FINAL", //操作类型
          "opsable": false, //是否可操作
          "privacy": false,  //是否隐私字段
          "sort_order": 4 // 排序
        }
      ], 
      "properties": [ ], 
      "created": 1539154556491, //创建时间
      "last_modified": 1591095956291, //修改时间
      "root_org_info": {
        "id": "xxxx", //根节点ID
        "name": "xxxxxx", //根节点名称
        "type": "O", //根节点类型
        "path": "/zcQ7KReg0Xe7sfCI5nZvkY/", //根节点路径
        "display": true // 是否显示
      }, 
      "platforms": [ ]
    }
  ]
}

雇员导入/更新 ​

js
POST http://{host}:{port}/v1/admin/organizations/{code}/import-employees?access_token={access_token}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

查看所有请求参数
字段类型是否必填说明
access_tokenStringY访问token
org_codeStringY组织标识
nameStringY雇员名
en_nameStringN雇员名
mobileStringN手机号
emailStringN邮件
extension_idStringN第三方序列号
serial_noStringN第三方序列号,优先取extension_id
sort_orderIntegerN排序号
seniorBooleanN是否高管
snStringN工号
provinceStringN省份
cityStringN城市
telStringN座机号
faxStringN传真号
workPhoneStringN工作电话
otherPhoneStringN其他号码
otherEmailStringN其他邮箱
industryStringN行业
regionStringN区域
labelStringN标签
extended1StringN扩展字段1
extended2StringN扩展字段2
extended3StringN扩展字段3
usernameStringY账号
source_idStringN认证源
user_idStringN用户ID
id_cardStringN身份证号码
passwordStringN用户密码(仅用户新增时使用)
genderStringN性别
birthdayLongN生日,13为时间戳
source_credentialsStringN第三方认证码
source_identifiersMap[String, String]N第三方认证信息
tagsSeq[Long]N雇员标签,优先读取
tag_namesSeq[Tag]N雇员标签信息
Tag.groupStringY标签分组
Tag.tagStringY标签名称
Tag.group_propertyStringN标签分组标识
Tag.tag_propertyStringN标签标识
rankLongN雇员职级,优先读取
employee_rank_nameStringN雇员职级
positionsSeq[Position]Y职位
Position.org_idLongN节点ID
Position.org_pathStringN节点path,与org_id不能同时为空
Position.job_titleStringN职位
Position.primaryBooleanN是否主职位
Position.chiefBooleanN是否首要
Position.source_typeStringN职位分组
propertiesSeq[Property]N雇员扩展字段
Property.data_schema_idLongY扩展ID
Property.valuesSeq[String]Y扩展内容
opsStringN默认新增/更新,为REMOVE为删除雇员

请求示例：

json
[
  {
    "birthDay": 773596800000, 
    "hireDay": 1612800000000, 
    "gender": "male", 
    "mobile": "15207710870", 
    "positions": [
      {
        "chief": false, 
        "org_path": "恒拓高科/租售部", 
        "job_title": "租售主管", 
        "primary": false
      }
    ], 
    "source_type": "LDAP", 
    "ops": "", 
    "grade": "租售主管", 
    "name": "李三", 
    "sn": "200702", 
    "sort_order": 999, 
    "email": "test05@xx.com", 
    "username": "KW2100702"
  }
]

响应示例：

点击查看响应数据
json
{
  "status": 0,
  "message": "ok",
  "result": {
    "employee_id": {
      "domain_id": "xxx",
      "code": "xxx",
      "id": "雇员ID"
    },
    "name": "xxxxxxx",
    "pinyin": "xxxxxxx",
    "initial": "xxxxxxx",
    "sn": "IMPL00001",
    "email": "1231414324@qq.com",
    "sort_order": 999,
    "senior": false,
    "user": {
      "id": "用户ID",
      "username": "xxxxxxx",
      "name": "xxxxxxx",
      "id_card": "1231414324@qq.com",
      "gender": "male",
      "status": "confirmed"
    },
    "extension_profiles": {
    },
    "positions": [
      {
        "position_id": {
            "domain_id": "xxx",
            "code": "xxx",
            "id": "possitionID"
        },
        "employee_id": "雇员ID",
        "org_id": "节点ID",
        "path": "/aaa/bbb/",
        "type": "O",
        "job_title": "测试",
        "primary": false,
        "chief": false
      }
    ],
    "properties": [
    ],
    "rank": 0,
    "tags": [
    ],
    "disabled": false,
    "deleted": false,
    "create_time": 1592284154154,
    "modify_time": 1592284154154
  }
}

雇员删除 ​

跟雇员导入参数一致，不过ops的值为REMOVE。

请求示例：

json
[
  {
    "ops": "REMOVE", 
    "username": "xxx", 
    "name": "xxx", 
    "sn": "xxx", 
    "mobile": "", 
    "email": "xxx@qq.com", 
    "positions": [
      {
        "jobTitle": "测试", 
        "org_path": "AAA/BBB/CCC"
      }
    ]
  }
]

响应示例：

json
{
  "status": 0, 
  "message": "Everything is ok.", 
  "result": {
    "successes": {
      "username1": 31718
    }, 
    "failures": { 
      "username1": "异常信息"
    }
  }
}

雇员离职 ​

js
POST http://{host}:{port}/v1/admin/organizations/{code}/employees/{employeeId}/disable|lock?access_token={access_token}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

字段类型是否必填说明
access_tokenStringY访问token
org_codeStringY组织标识
employeeIdStringY雇员ID

请求示例：

V3 版本接口仅支持 lock, V4 版本接口两者均支持。

js
/v1/admin/organizations/xxx/employees/xxx/disable?access_token=xxx
js
/v1/admin/organizations/xxx/employees/xxx/lock?access_token=xxx

响应示例：

json
{  "status": 0,  "message": "ok",  "result": {    // result  }}

雇员复职 ​

js
POST http://{host}:{port}/v1/admin/organizations/{code}/employees/{employeeId}/enable|unlock?access_token={access_token}

请求头部：

请求头说明
Content-Typeapplication/json

请求参数：

字段类型是否必填说明
access_tokenStringY访问token
org_codeStringY组织标识
employeeIdStringY雇员ID

请求示例：

V3 版本接口仅支持unlock，V4 版本接口两者均支持。

js
/v1/admin/organizations/xxx/employees/xxx/enable?access_token=xxx
js
/v1/admin/organizations/xxx/employees/xxx/unlock?access_token=xxx

响应示例：

json
{
  "status": 0,
  "message": "ok",
  "result": {
    // result
  }
}