作者:管理员 历史版本:1 最后编辑:龚清 更新时间:2024-09-20 15:13
获取用户与组关系列表
简述:
- 根据用户id获取用户与组关系列表
请求URL:
- http://ip:port/ibps/platform/v3/group/findByUserId
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
userId | string | 是 | 用户id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/findByUserId?userId=633271888658825216
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": [
{
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"userId": null,
"groupId": "640858910105796608",
"userName": "ccc管理员",
"groupName": "项目一组"
}
]
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | List< PartyUserGroupPo > | 用户与组关系对象列表 |
用户组列表
简述:
- 根据用户id,获取用户组列表
请求URL:
- http://ip:port/ibps/platform/v3/group/findGroupByUserId
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
userId | String | 是 | 用户id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/findGroupByUserId?userId=643398911343460352
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": [
{
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": "xmyz",
"groupNote": "项目",
"delBeforeSave": true,
"partyUserGroupPoList": []
}
]
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | List< PartyGroupPo > | 用户组对象列表 |
查询用户组信息
简述:
- 查询用户组信息
请求URL:
- http://ip:port/ibps/platform/v3/group/findTreeData
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
partyId | String | 否 | 参与者ID串,逗号分割 | ||
type | Integer | 是 | 查询类型 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/findTreeData?partyId=640858910315511808&type=1
返回示例:
{
"state": 200,
"request": null,
"message": "获取用户组信息成功!",
"cause": "",
"variables": {},
"data": [
{
"pk": "",
"name": "用户组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "0",
"groupAlias": null,
"groupNote": null,
"parentId": null,
"sn": null,
"icon": "fa-home",
"type": "root",
"nocheck": false,
"chkDisabled": false,
"click": true,
"title": "",
"open": "true"
},
{
"pk": "",
"name": "项目二",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "643773035593072640",
"groupAlias": null,
"groupNote": null,
"parentId": "0",
"sn": null,
"icon": null,
"type": "sys",
"nocheck": false,
"chkDisabled": false,
"click": true,
"title": "",
"open": "true"
},
{
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": null,
"groupNote": null,
"parentId": "0",
"sn": null,
"icon": null,
"type": "sys",
"nocheck": false,
"chkDisabled": false,
"click": true,
"title": "",
"open": "true"
}
]
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | List< PartyGroupTreePo > | 角色对象列表 |
获取用户组信息(根据groupId)
简述:
- 根据groupId获取用户组数据
请求URL:
- http://ip:port/ibps/platform/v3/group/get
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
groupId | String | 是 | 用户组id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/get?groupId=640858910105796608
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": "xmyz",
"groupNote": "项目",
"delBeforeSave": true,
"partyUserGroupPoList": []
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | APIResult< PartyGroupPo > | 用户组对象 |
获取用户组信息(根据groupKey)
简述:
- 根据groupKey获取用户组数据
请求URL:
- http://ip:port/ibps/platform/v3/group/getByKey
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
groupKey | String | 是 | 用户组标识 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/getByKey?groupKey=xmyz
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": "xmyz",
"groupNote": "项目",
"delBeforeSave": true,
"partyUserGroupPoList": []
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | PartyGroupPo | 用户组对象 |
获取用户组信息(根据groupId)
简述:
- 根据groupId获取用户组数据
请求URL:
- http://ip:port/ibps/platform/v3/group/loadCascade
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
groupId | String | 是 | 用户组id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/loadCascade?groupId=640858910105796608
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": "xmyz",
"groupNote": "项目",
"delBeforeSave": true,
"partyUserGroupPoList": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1572834271000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910315511808",
"userId": "633271888658825216",
"groupId": "640858910105796608",
"userName": "ccc管理员",
"groupName": "项目一组"
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1572834271000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910521032704",
"userId": "632153957724061696",
"groupId": "640858910105796608",
"userName": "EVA",
"groupName": "项目一组"
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1573112567000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "642026167620075520",
"userId": "640858342633242624",
"groupId": "640858910105796608",
"userName": "开发创建用户",
"groupName": "项目一组"
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1573454413000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "643459976903262208",
"userId": "643398911343460352",
"groupId": "640858910105796608",
"userName": "阿佩",
"groupName": "项目一组"
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1573457024000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "643470926041579520",
"userId": "626796627947945984",
"groupId": "640858910105796608",
"userName": "产品主管",
"groupName": "项目一组"
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1573526976000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "643764326032736256",
"userId": "626353848415420416",
"groupId": "640858910105796608",
"userName": "zjh",
"groupName": "项目一组"
}
]
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | PartyGroupPo | 用户组对象 |
用户组列表(分页)
简述:
- 根据传入参数查询,并返回用户组列表
请求URL:
- http://ip:port/ibps/platform/v3/group/query
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/query
返回示例:
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": "项目二",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "643773035593072640",
"groupAlias": "xme",
"groupNote": "",
"delBeforeSave": true,
"partyUserGroupPoList": []
},
{
"pk": "",
"name": "项目一组",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "640858910105796608",
"groupAlias": "xmyz",
"groupNote": "项目",
"delBeforeSave": true,
"partyUserGroupPoList": []
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 2,
"totalPages": 1
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
dataResult | Array | 用户组列表数据 |
pageResult | Object | 分页数据 |
删除用户组
简述:
- 根据groupIds删除用户组
请求URL:
- http://ip:port/ibps/platform/v3/group/
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
groupIds | String[] | 是 | 用户组ID数组 |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/group/remove?groupIds=643773035593072640
返回示例:
{
"state": 200,
"request": null,
"message": "删除用户组成功",
"cause": "",
"variables": {},
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
保存用户组
简述:
- 保存用户组
请求URL:
- http://ip:port/ibps/platform/v3/group/saveCascade
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | String | 是 | 用户组别名 | ||
groupAlias | String | 是 | 用户组别名 | ||
groupNote | String | 否 | 用户组描述 | ||
partyUserGroupPoList | List< PartyUserGroupPo > | 否 | 用户与组关系对象信息列表 |
PartyUserGroupPo属性信息:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
userId | String | 是 | 用户id | ||
userName | String | 是 | 用户名 |
请求参数示例:
{
"name": "scs",
"groupAlias": "scs",
"groupNote": "",
"partyUserGroupPoList": [{
"userId": "646017197759528960",
"userName": "王按钮"
}]
}
返回示例:
{
"state": 200,
"request": null,
"message": "保存用户组成功",
"cause": "",
"variables": {
"id": "646367321480232960"
},
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
备注
- [1] : APIRequest为动态查询请求对象,详情请移步全局请求格式