2.3.2.3用户组读取服务
2.3.2.3.1概述
注册账号 | 服务名称 | 服务URL | 服务负责人 | 负责人邮箱 | 状态 |
---|---|---|---|---|---|
mdm | /cs_auth_web/webservice/groupReadAPI/getGroupsByUserID | 张健 | [email protected] |
2.3.2.3.2GetGroupsByUserId方法
2.3.2.3.2.1描述
根据用户ID获取用户组
2.3.2.3.2.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
userRequest | UserRequest | 是 |
2.3.2.3.2.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页对象 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.2.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.3GetAllGroups方法
2.3.2.3.3.1描述
获取所有组信息
2.3.2.3.3.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
baseRequest | BaseRequest | 是 |
2.3.2.3.3.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页对象 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.3.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.4GetUsersByStaticGroupID方法
2.3.2.3.4.1描述
根据静态用户组ID获取用户列表
2.3.2.3.4.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupRequest | GroupRequest | 是 |
2.3.2.3.4.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页对象 | Page | 否 |
total | 总条数 | int | 否 |
usersInfo | 用户信息 | UsersInfo[] | 否 |
2.3.2.3.4.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.5GetUsersByGroupID方法
2.3.2.3.5.1描述
根据用户组ID获取用户列表
2.3.2.3.5.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupRequest | GroupRequest | 是 |
2.3.2.3.5.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页对象 | Page | 否 |
total | 总条数 | int | 否 |
usersInfo | 用户信息 | UsersInfo[] | 否 |
2.3.2.3.5.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.6GetGroupByGroupID方法
2.3.2.3.6.1描述
根据组ID获取组信息
2.3.2.3.6.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupId | 组ID | String | 是 |
2.3.2.2.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | |
page | 分页对象 | Page | |
total | 总条数 | int | |
groups | 组信息 | Group |
2.3.2.3.6.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
202 | 该操作无相应结果! |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.7CheckGroup方法
2.3.2.3.7.1描述
检查组是否存在
2.3.2.3.7.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupId | 组ID | String | 是 |
2.3.2.3.7.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | |
page | 分页对象 | Page | |
total | 总条数 | int | |
flag | 是否存在标志 | boolean |
2.3.2.3.7.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.8GetGroupsByUserId方法
2.3.2.3.8.1描述
根据用户ID获取对应的组信息
2.3.2.3.8.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
condition | 条件 | String | 是 |
2.3.2.3.8.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
usersInfo | 用户信息 | UsersInfo[] | 否 |
2.3.2.3.8.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.9getGroupsByDomain方法
2.3.2.3.9.1描述
根据业务域获取组
2.3.2.3.9.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
domainGroupRequest | DomainGroupRequest | 是 |
2.3.2.3.9.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.9.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.10GetGroupsByGroupIds方法
2.3.2.3.10.1描述
根据组ID获取组信息
2.3.2.3.10.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupIds | 组ID | String[] | 是 |
2.3.2.3.10.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页对象 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.10.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.11searchGroupsByIDOrName方法
2.3.2.3.11.1描述
根据ID或名称获取组信息
2.3.2.3.11.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
condition | String | 是 |
2.3.2.3.11.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.11.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.12searchUsers方法
2.3.2.3.12.1描述
搜索用户信息
2.3.2.3.12.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
searchRequest | SearchRequest | 是 |
2.3.2.3.12.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
redisInfo | 用户信息 | RedisInfoNew[] | 否 |
2.3.2.3.12.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.13searchUsersExcludeGroup方法
2.3.2.3.13.1描述
搜索排除某些组的用户信息
2.3.2.3.13.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
request | SearchGroupUserRequest | 是 |
2.3.2.3.13.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | |
page | 分页 | Page | |
total | 总条数 | int | |
redisInfo | 用户信息 | RedisInfoNew[] |
2.3.2.3.13.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.14searchGroupInfo方法
2.3.2.3.14.1描述
搜索组信息
2.3.2.3.14.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupInfoRequest | GroupInfoRequest | 是 |
2.3.2.314.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.14.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.15getGroupUserInfosByLike方法
2.3.2.3.15.1描述
查询用户组中的用户信息
2.3.2.3.15.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupUserInfosRequest | GroupUserInfosByLikeRequest | 是 |
2.3.2.3.15.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
redisInfo | 用户信息 | RedisInfoNew[] | 否 |
2.3.2.3.15.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.16 getUsersByGroupIDNew方法
2.3.2.3.16.1描述
根据用户组ID获取用户信息
2.3.2.3.16.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupRequest | GroupRequest | 是 |
2.3.2.3.16.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
redisInfo | 用户信息 | RedisInfoNew[] | 否 |
2.3.2.3.16.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
400 | 参数错误 |
500 | 系统错误 |
2.3.2.3.17 getGlobalGroups方法
2.3.2.3.17.1描述
获取全局组信息
2.3.2.3.17.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
baseRequest | BaseRequest | 是 |
2.3.2.3.17.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.17.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.18 getDomainGroups方法
2.3.2.3.18.1描述
获取业务域组信息
2.3.2.3.18.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
baseRequest | BaseRequest | 是 |
2.3.2.3.18.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.18.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.19 dynaSearchUser方法
2.3.2.3.19.1描述
动态搜索人员
2.3.2.3.19.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
dynaSearchRequest | DynaSearchRequest | 是 |
2.3.2.3.19.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
redisInfo | 人员信息 | RedisInfoNew[] | 否 |
2.3.2.3.19.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.20getGroupsByUserIdAndAppId方法
2.3.2.3.20.1描述
根据用户ID和AppID获取组信息
2.3.2.3.20.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
userId | 用户ID | String | 是 |
appId | AppId | String | 是 |
2.3.2.3.20.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组信息 | Group[] | 否 |
2.3.2.3.20.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.21getGroupsSumInfo方法
2.3.2.3.21.1描述
获取组的汇总信息
2.3.2.3.21.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
groupIds | 组ID | String[] | 是 |
2.3.2.3.21.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
groups | 组汇总信息 | GroupSumInfo[] | 否 |
2.3.2.3.21.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.22dynaSearchGroupUser方法
2.3.2.3.22.1描述
动态搜索组中的用户
2.3.2.3.22.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
dynaSearchUsersRequest | DynaSearchUsersRequest | 是 |
2.3.2.3.22.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
users | 用户信息 | BPMUserInfo[] | 否 |
2.3.2.3.22.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.23groupDeptCountInfo方法
2.3.2.3.23.1描述
2.3.2.3.23.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
bpmGroupDeptRequest | BPMGroupDeptRequest | 是 |
2.3.2.3.23.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
bpmGroupDeptInfos | BPMGroupDeptInfo[] | 否 |
2.3.2.3.23.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.24searchUserWithBracket方法
2.3.2.3.24.1描述
2.3.2.3.24.1入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
dynaSearchUsersRequest | SearchUserWithBracketRequest | 是 |
2.3.2.3.24.2出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
users | 用户信息 | BPMUserInfo[] | 否 |
2.3.2.3.24.3返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.25searchUserWithSpell方法
2.3.2.3.25.1描述
2.3.2.3.25.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
request | UserInfoWithSpellRequest | 是 |
2.3.2.3.25.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
userInfoWithSpells | UserInfoWithSpell[] | 否 |
2.3.2.3.25.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |
2.3.2.3.26getTeacherInfo方法
2.3.2.3.26.1描述
获取教师信息
2.3.2.3.26.2入参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
request | SearchRequest | 是 |
2.3.2.3.26.3出参
参数名 | 描述 | 类型 | 是否必填 |
---|---|---|---|
status | 返回码 | int | 是 |
msg | 描述 | String | 否 |
page | 分页 | Page | 否 |
total | 总条数 | int | 否 |
infos | 教师信息 | TeacherInfoWithPositionPhone[] | 否 |
2.3.2.3.26.4返回状态码
状态码 | 含义 |
---|---|
200 | 操作成功 |
500 | 系统错误 |