查询角色信息v3
更新时间 2026-01-22 16:39:16
最近更新时间: 2026-01-22 16:39:16
接口功能介绍
查询角色信息
接口约束
无
URI
GET /v3/role/qrySystemRole
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| sysRoleName | 否 | String | 角色名称 | test555 | |
| status | 否 | Integer | 角色状态 | 1 | |
| orgOid | 否 | String | 部门Oid | org-test | |
| isQuerySubOrg | 否 | Boolean | 是否包含下级部门 | false | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 角色数据列表 | list | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sysRoleOid | String | 角色ID | ||
| orgOid | String | 部门ID | ||
| orgDir | String | 部门路径 | ||
| shareFlag | Integer | 是否共享（0-私有，1-共享） | ||
| tenantOid | String | 租户ID | ||
| sysRoleName | String | 角色名称 | ||
| sysRoleCode | String | 角色标识 | ||
| sysRoleDesc | String | 角色描述 | ||
| createDate | String | 创建时间 | ||
| createStaffOid | String | 创建人ID | ||
| updateStaffOid | String | 修改人ID | ||
| statusDate | String | 状态更新时间 | ||
| status | Integer | 角色状态 | ||
| appCode | String | 应用编码 | ||
| appName | String | 应用名称 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&sysRoleName=test555&status=1&orgOid=org-test&isQuerySubOrg=false&pageNum=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"sysRoleOid":"role-xxxxxxxxxxxxxxxxxxxx",
"orgOid":"org-test",
"orgDir":"/根部门/财务部",
"shareFlag":0,
"tenantOid":"tenant-xxxxxxxxxxxxxxxx",
"sysRoleName":"liut555",
"sysRoleCode":"liut555",
"sysRoleDesc":"roletestdescripetion",
"createDate":"2023-10-01T10:00:00Z",
"createStaffOid":"user-xxxxxxxxxxxxxxxx",
"updateStaffOid":"user-xxxxxxxxxxxxxxxx",
"statusDate":"2023-10-10T15:30:00Z",
"status":1,
"appCode":"appcode",
"appName":"管理系统"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
