Fx.org:和系统用户操作有关的API
1. findUserById 按用户ID查询用户信息
Fx.org.findUserById(<String userId>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
userId | String | 用户id |
返回值类型
APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.org.findUserById("1001");
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def(Boolean error, Map data, String errorMessage) = Fx.org.findUserById("1001")
2. findByUserIds 按用户Id列表查询若干用户信息
Fx.org.findByUserIds(<List userIds>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
userIds | List | 用户id列表 |
返回值类型
APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.org.findByUserIds(Lists.newArrayList("1001", "1002"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (Boolean error,Map data,String errorMessage) = Fx.org.findByUserIds(["1001","1002"])
3. findEmployeeByDepartmentId 根据部门id查员工信息
Fx.org.findEmployeeByDepartmentId(<String departmentId>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
departmentId | String | 部门Id |
返回值类型
APIResult
返回值说明
返回的数据类型: List <Map> String departmentId:主属部门Id String name 部门名称 String tenantId 企业id List <String> ViceDepartmentIds 附属部门id String employee 员工Id Integer type 员工类型 1:内部员工 2:外部员工 Integer status 部门状态 1:正常 2:停用 3:删除
Java举例
APIResult ret = Fx.org.findEmployeeByDepartmentId("1061");
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (Boolean error,List data,String errorMessage) = Fx.org.findEmployeeByDepartmentId('1061')
4. findDepartmentByIds 根据部门ID列表,查询部门信息
Fx.org.findDepartmentByIds(<List departmentIds>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
departmentIds | List | 部门ID集合 |
返回值类型
APIResult
返回值说明
返回的数据类型: List <Map> List <String> owner 部门负责人 String superordinateDepartmentId 上级部门id String name 部门名称 String enterpeiseId 企业id
Java举例
APIResult ret = Fx.org.findDepartmentByIds(Lists.newArrayList("1016"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (Boolean error,List data,String errorMessage) = Fx.org.findDepartmentByIds(['1016'])
注意事项
- 由于下游企业在上游企业组织架构里,相当于是一个部门,所以也可用该函数查询下游企业的对接人,此时 owner 表示:下游企业的对接人
5. findSuperordinateDepartments 根据部门id查上级部门信息
Fx.org.findSuperordinateDepartments(<String id>, <Boolean recursion>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
id | String | 部门id |
recursion | Boolean | 是否递归 |
返回值类型
APIResult
返回值说明
返回的数据类型: Map List <String> owner 部门负责人 String superordinateDepartmentId 上级部门id String name 部门名称 String enterpeiseId 企业id
Java举例
APIResult ret = Fx.org.findSuperordinateDepartments("1016", true);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (Boolean error,Map data,String errorMessage) = Fx.org.findSuperordinateDepartments('1016', true)
6. findSubordinateDepartments 根据部门id查下级部门信息
Fx.org.findSubordinateDepartments(<String id>, <Boolean recursion>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
id | String | 部门id |
recursion | Boolean | 是否递归 |
返回值类型
APIResult
返回值说明
返回的数据类型: Map List <String> owner 部门负责人 String superordinateDepartmentId 上级部门id String name 部门名称 String enterpeiseId 企业id
Java举例
APIResult ret = Fx.org.findSubordinateDepartments("1016", true);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (Boolean error,Map data,String errorMessage) = Fx.org.findSubordinateDepartments('1016',true)
7. findOutUserById 查询外部人员信息
Fx.org.findOutUserById(<String outUserId>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
outUserId | String | 外部人员id |
返回值类型
APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.org.findOutUserById("300090724");
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (boolean error,Map result,String errorMessage) = Fx.org.findOutUserById("300090724")
8. findOutUserByIds 批量查询外部人员信息
Fx.org.findOutUserByIds(<List outUserId>)
参数说明
参数 | 类型 | 说明 |
---|---|---|
outUserId | List | 外部人员idl列表 |
返回值类型
APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.org.findOutUserByIds(Lists.newArrayList("300090724"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (boolean error,Map result,String errorMessage) = Fx.org.findOutUserByIds(["300090724"])
9. getCompanyInfo 获得企业信息
Fx.org.getCompanyInfo()
返回值类型
APIResult
返回值说明
返回的数据类型: Map 包含: defaultLanguage 默认语言 defaultTimeZone 默认时区 companyName 企业名字 tenantId 企业Id isSandbox 是否为沙盒企业 tenantType 企业版本(如 enterprise_edition)
Java举例
APIResult ret = Fx.org.getCompanyInfo();
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例
def (boolean error,Map result,String errorMessage) = Fx.org.getCompanyInfo()