GET 查询角色详情
GET 查询。query 参数:id。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
system.role.detail | system:read | GET /v1/role/detail(comap-system) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | 是 | 角色ID |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "system.role.detail",
"query": {
"id": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | 角色ID |
roleName | string | — | 角色名称 |
description | string | — | 角色描述 |
scope | integer(int32) | — | 角色范围:0=超级管理员,1=普通角色 |
source | integer(int64) | — | 创建来源:0=系统初始化,非0=创建时的租户ID |
userCount | integer(int32) | — | 该角色下的用户数量 |
createTime | string(date-time) | — | 创建时间 |
updateTime | string(date-time) | — | 更新时间 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 system:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-system 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回角色