跳到主要内容

GET 查询启用状态的用户选项列表

GET 查询。query 参数:arg0。

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

请求参数(query)

字段类型必填说明
keywordstring—关键词(姓名、手机号、邮箱)
deptIdinteger(int64)—部门ID
dataPermissionboolean—是否启用数据权限过滤,默认false
activeOnlyboolean—是否只查询有效用户(全局启用且租户正常)
modulestring—业务模块标识(用于查角色数据权限配置,不传走兜底逻辑)

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—用户ID
userNamestring—用户名称
avatarstring—头像地址
deptIdinteger(int64)—部门ID
deptNamestring—部门名称
phonestring—手机号
emailstring—邮箱

错误处理​

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

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

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

← 返回用户