跳到主要内容

GET 分页查询用户列表

GET 查询。query 参数:arg0。

接口编码所需范围后端接口
system.user.pagesystem:readGET /v1/user/page(comap-system)

请求参数(query)

字段类型必填说明
keywordstring—关键词(姓名、手机号、邮箱)
roleIdinteger(int64)—角色ID
statusinteger(int32)—账号状态:0=启用,1=禁用,2=待激活,3=锁定,4=停用
deptIdinteger(int64)—部门ID
pageNuminteger(int64)是当前页
pageSizeinteger(int64)是每页大小
activeOnlyboolean—是否只查询有效用户(全局启用且租户正常)

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "system.user.page",
"query": {
"pageNum": 1,
"pageSize": 10
}
}'

响应 data 字段(分页结构:records[] + total)

字段类型必填说明
records14UserVO[]——
totalinteger(int64)——
sizeinteger(int64)——
currentinteger(int64)——
orders2OrderItem[]——
optimizeCountSqlPageUserVO——
searchCountPageUserVO——
optimizeJoinOfCountSqlboolean——
maxLimitinteger(int64)——
countIdstring——
pagesinteger(int64)——

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 system:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-system 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回用户