GET 分页查询用户列表
GET 查询。query 参数:arg0。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
system.user.page | system:read | GET /v1/user/page(comap-system) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
keyword | string | — | 关键词(姓名、手机号、邮箱) |
roleId | integer(int64) | — | 角色ID |
status | integer(int32) | — | 账号状态:0=启用,1=禁用,2=待激活,3=锁定,4=停用 |
deptId | integer(int64) | — | 部门ID |
pageNum | integer(int64) | 是 | 当前页 |
pageSize | integer(int64) | 是 | 每页大小 |
activeOnly | boolean | — | 是否只查询有效用户(全局启用且租户正常) |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
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)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
records14 | UserVO[] | — | — |
total | integer(int64) | — | — |
size | integer(int64) | — | — |
current | integer(int64) | — | — |
orders2 | OrderItem[] | — | — |
optimizeCountSql | PageUserVO | — | — |
searchCount | PageUserVO | — | — |
optimizeJoinOfCountSql | boolean | — | — |
maxLimit | integer(int64) | — | — |
countId | string | — | — |
pages | integer(int64) | — | — |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 system:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-system 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回用户