Paths

角色新增

接口说明

新增角色信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/role

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
roleName	true	string	角色名称
roleGrade	true	int	角色等级
memo	false	string	角色描述
ownerCode	true	string	所属组织
defaultRole	false	int	默认角色
menus	false	array	菜单信息
+menuCode	true	array	菜单编码，调接口用户导航菜单查询获取
+terminal	true	int	菜单所属终端类型
allMenus	false	Boolean	是否全量菜单
organizations	false	Set	当前角色有权限的组织节点
departments	false	Set	当前角色有权限的部门节点
logicOrgCodes	false	string	逻辑组织编码
logicOrganizations	false	array	逻辑组织
+logicOrgCode	false	string	逻辑组织编码
+logicOrgCodeSet	false	set	逻辑组织编码集合
subsystemResource	false	array	逻辑组织
+systemCode	false	string	逻辑组织编码
+requestUri	false	string	逻辑组织编码集合
+data	false	set	逻辑组织编码集合

请求参数示例

{
	"roleName": "管理员",
	"roleGrade": 1,
	"ownerCode": "001",
	"defaultRole": 0,
	"memo": "管理员角色",
	"menus": [{
			"menuCode": ["EVOBRM_201001", "EVOBRM_201002"],
			"terminal": 1
		},
		{
			"menuCode": ["EVOBRM_201001", "EVOBRM_201002"],
			"terminal": 2
		},
		{
			"menuCode": ["EVOBRM_201001", "EVOBRM_201002"],
			"terminal": 3
		}
	],
	"allMenus": 1,
	"organizations": ["001001"],
	"logicOrgCodes": "001001",
	"logicOrganizations": [{
		"logicOrgCode": "",
		"logicOrgCodeSet": []
	}],
	"departments": [1]
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	long	角色ID

返回参数示例（成功）

{
    "success":true,
    "data":{
        "id":1242
    },
    "code":"0",
    "errMsg":""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28120001",
    "errMsg": "角色已存在"
}

角色更新

接口说明

更新角色信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

智能物联综合管理平台iConnection Center V5.0.6版本

接口URL

/evo-apigw/evo-brm/1.2.0/role

请求Method

PUT

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
id	true	long	角色ID，不支持修改
roleName	true	string	角色名称，不支持修改
roleGrade	true	int	角色等级
memo	false	string	角色描述
ownerCode	true	string	所属组织
defaultRole	false	int	默认角色
allMenus	false	Boolean	是否全量菜单
organizations	false	Set	当前角色有权限的组织节点
departments	false	Set	当前角色有权限的部门节点
logicOrgCodes	false	string	逻辑组织编码
logicOrganizations	false	array	逻辑组织
+logicOrgCode	false	string	逻辑组织编码
+logicOrgCodeSet	false	set	逻辑组织编码集合

请求参数示例

{
	"id": 1252,
	"roleName": "管理员",
	"roleGrade": 1,
	"ownerCode": "001",
	"defaultRole": null,
	"memo": null,
	"menus": [{
			"menuCode": [
				"EVOBRM_201001",
				"EVOBRM_201002"
			],
			"terminal": 1
		},
		{
			"menuCode": [
				"EVOBRM_201001",
				"EVOBRM_201002"
			],
			"terminal": 2
		},
		{
			"menuCode": [
				"EVOBRM_201001",
				"EVOBRM_201002"
			],
			"terminal": 3
		}
	],
	"allMenus": null,
	"organizations": null,
	"departments": null,
	"menuSystemCodes": null,
	"logicOrgCodes": null,
	"logicOrganizations": [{
			"logicOrgCode": "005",
			"logicOrgCodeSet": null
		},
		{
			"logicOrgCode": "L04",
			"logicOrgCodeSet": [

			]
		},
		{
			"logicOrgCode": "L05",
			"logicOrgCodeSet": [

			]
		}
	]
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	long	角色ID

返回参数示例（成功）

{
    "success": true,
    "code": "0",
    "errMsg": "成功",
    "data": {
        "id": 1004
    }
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28120002",
    "errMsg": "角色不存在"
}

角色删除

接口说明

删除角色信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/role/delete

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
ids	true	array	需要删除的角色id集合

请求参数示例

{
	"ids": [1004, 1005]
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+value	object	结果信息
++deleteSuccessIds	array	删除成功的角色id数组
++deleteFailIds	array	删除失败的角色id数组
++failReason	array	删除失败数组
+++id	long	角色id
+++roleName	string	角色名称
+++failReason	string	失败原因

返回参数示例（成功）

{
	"code": "0",
	"data": {},
	"errMsg": "",
	"success": true
}

返回参数示例（失败）

{
	"success": false,
	"code": 28120014,
	"errMsg": "成功",
	"data": {
		"value": {
			"failReason": [{
				"id": 1,
				"roleName": "管理员",
				"failReason": "28120002"
			}],
			"deleteSuccessIds": [],
			"deleteFailIds": [1]
		}
	}
}

角色详情查询

接口说明

查询角色详细信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/role/detail/{id}

请求Method

GET

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
id	true	long	角色ID

请求示例

/evo-apigw/evo-brm/1.0.0/role/detail/2

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
role	object	角色信息
+id	long	角色ID
+roleName	String	角色名称
+roleGrade	int	角色等级
+ownerCode	String	所属组织编码
+defaultRole	int	是否是默认角色
+administerRootCheck	int	是否勾选管理员端所有权限
+operationRootCheck	int	是否勾选操作员端所有权限
+appRootCheck	int	是否勾选移动端所有权限
+status	int	是否显示
+logicOrgCodes	array	逻辑组织编码
menuPrivileges	array	有权限的菜单信息
+menuCode	array	菜单编码集合
+terminal	string	终端类型
departments	array	有权限的部门
organizations	array	有权限的组织

返回参数示例（成功）

{
    "success": true,
    "data": {
        "role": {
            "id": 28,
            "roleName": "zx_suiji",
            "roleGrade": 1,
            "administerRootCheck": 0,
            "operationRootCheck": 0,
            "appRootCheck": 0,
            "defaultRole": 0,
            "ownerCode": "001",
            "logicOrgCodes":"001,002,L04"
            "status": 1
        },
        "menuPrivileges": [
            {
                "uniqueMenuCode": "EVOBRM_001",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001001",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001001001",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001001002",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001001003",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001001004",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001009005",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001009006",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001010",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001011",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001011001",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001011002",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001011003",
                "terminal": 1
            },
            {
                "uniqueMenuCode": "EVOBRM_001011004",
                "terminal": 1
            }
        ],
        "departments": [
            374
        ],
        "organizations": [
            "001001",
            "001002",
            "001003",
            "001004",
            "001005"
        ]
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28120002",
    "errMsg": "角色不存在"
}

角色信息分页查询

接口说明

分页查询角色信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/role/subsystem/page

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
pageNum	false	int	当前页, 默认1
pageSize	false	int	每页记录数, 默认10
searchKey	false	string	模糊查询参数
sort	false	string	排序属性（支持排序属性：id、createDate、updateDate、roleName、roleGrade）
sortType	false	string	排序方式： ASC-升序， DESC-降序（默认）
roleIdList	false	List	角色ID列表过滤条件
roleNameList	false	List	角色名称列表过滤条件
roleGradeList	false	List	角色等级过滤条件
ownerCode	false	string	所属组织

请求参数示例

{
	"pageNum": 1,
	"pageSize": 10,
	"searchKey": "",
	"sort": "roleName",
	"sortType": "DESC",
	"roleIdList": [
		4, 1009, 1007
	],
	"roleNameList": ["移动端用户"],
	"ownerCode": "001",
	"roleGradeList": [
		1,
		3
	]
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	PageVO	分页数据

PageVO

名称	类型	说明
currentPage	int	当前页码
totalPage	int	总页数
pageSize	int	每页记录数
totalRows	int	总数
pageData	List<RoleInfoVO>	数据列表

RoleInfoVO

名称	类型	说明
id	String	角色ID
roleName	String	角色名称
roleGrade	Integer	角色等级
privilegeType	Integer	角色类型
administerRootCheck	Integer	是否勾选管理员端所有权限
operationRootCheck	Integer	是否勾选操作员端所有权限
appRootCheck	Integer	是否勾选移动端所有权限
defaultRole	Integer	是否是默认角色
ownerCode	String	所属组织
status	Integer	是否显示
memo	String	描述

返回参数示例（成功）

{
    "success": true,
    "data": {
        "pageData": [
            {
                "service": null,
                "id": 4,
                "roleName": "移动端用户",
                "roleGrade": 3,
                "privilegeType": null,
                "administerRootCheck": 0,
                "operationRootCheck": 0,
                "appRootCheck": 1,
                "defaultRole": 1,
                "ownerCode": "001",
                "status": 1,
                "memo": null
            }
        ],
        "currentPage": 1,
        "totalPage": 1,
        "pageSize": 10,
        "totalRows": 1
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28999996",
    "errMsg": "排序属性非法"
}

角色全量数据同步

接口说明

全量同步角色数据

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/role/list-page

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
pageNum	false	int	当前页, 默认1
pageSize	false	int	每页记录数, 默认10
menuNeed	false	int	是否获取菜单数据默认是0

请求参数示例

{
	"pageNum": 1,
	"pageSize": 10,
	"menuNeed": 1
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	String	角色ID
+roleName	String	角色名称
+roleGrade	Integer	角色等级
+defaultRole	Integer	是否是默认角色
+ownerCode	String	所属组织
+logicOrgCodes	String	逻辑组织编码
+roleOrgs	Array	角色有权限的组织
++orgCode	string	组织编码
+menuPrivileges	Array	角色有权限的组织
++uniqueMenuCode	string	菜单编码
++terminal	int	终端类型 1：web端 2：客户端 3：移动端
+roleDepartments	Array	角色有权限的组织
++departmentId	long	部门id

返回参数示例（成功）

{
	"success": true,
	"data": {
		"pageData": [{
			"id": 1,
			"roleName": "超级管理员",
			"roleGrade": 3,
			"ownerCode": "001",
			"defaultRole": 1,
			"roleOrgs": [{
				"orgCode": "001"
			}],
			"roleDepartments": [{
				"departmentId": 1
			}],
			"menuPrivileges": [{
					"uniqueMenuCode": "ADMIN_001",
					"terminal": 1
				},
				{
					"uniqueMenuCode": "ADMIN_001005",
					"terminal": 1
				}
			],
			"logicOrgCodes": "L04,L01"
		}],
		"currentPage": 1,
		"totalPage": 1,
		"pageSize": 10,
		"totalRows": 1
	},
	"code": "0",
	"errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28999996",
    "errMsg": "排序属性非法"
}

用户导航菜单查询

接口说明

用户导航菜单查询

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/navigation

请求Method

GET

请求参数

参数名	必选	类型	说明
terminal	true	int	当前终端，web端：1，客户端：2，移动端：3

请求参数示例

https://10.55.36.202/evo-apigw/evo-brm/1.0.0/user/navigation?terminal=1

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象

data

名称	类型	说明
value	List<ModuleMenu>	模块菜单列表

ModuleMenu

名称	类型	说明
module	string	应用大类key
moduleName	string	用户自定义应用大类名称
sort	int	用户自定义应用大类排序序号
terminal	int	终端类型
groups	List<MenuGroup>	菜单分组对象
menus	List<MenuInfo>	菜单列表

MenuGroup

名称	类型	说明
groupKey	string	分组key
groupSort	int	分组排序
menus	List<MenuInfo>	分组菜单列表

MenuInfo

名称	类型	说明	备注
menuCode	String	菜单编码
uniqueMenuCode	String	菜单唯一编码
menuName	String	菜单名称
menuPath	String	菜单跳转路径
menuIcon	String	快捷导航菜单图标
menuHomeIcon	String	首页菜单图标
menuStaticHomeIcon	string	子系统放在静态资源中的图标
menuType	String	菜单类型
module	String	菜单所属应用大类key
isC	boolean	是否加入快捷导航
sort	String	快捷导航菜单排序序号
menuSort	String	全部导航菜单排序序号
systemCode	String	子系统code
customNameFlag	int	是否用户自定义添加的菜单名称	0:否 1:是默认0
menuRegroupName	string	重组菜单名称
menuAddtype	string	菜单添加方式	0:默认菜单 1:添加的已有菜单 2:添加的第三方菜单 3:MCCS菜单 4:组合菜单(5.0.10支持) 5: 子系统上报的配置信息(以菜单形式挂载在系统设置菜单下，5.0.10支持)
menuOpenType	string	菜单打开方式	0:平台页签打开 1:浏览器页签打开 2:浏览器新窗口打开
systemMenuDelete	int	系统菜单删除标志	1 表示已经删除，其他值表示未删除

返回参数示例（成功）

{
	"success": true,
	"code": "0",
	"errMsg": "成功",
	"data": {
		"value": [{
			"module": "1",
			"moduleName": "基础业务",
			"sort": 1,
			"terminal": 1,
			"menus": [{
					"menuCode": "001001",
					"uniqueMenuCode": "EVOBRM_001001",
					"menuName": "menu.roleManage",
					"menuIcon": "",
					"menuHomeIcon": "a.jpg",
					"menuPath": "/roleManage",
					"menuType": 1,
					"module": "1",
					"isC": true,
					"sort": "1",
					"menuSort": 1,
					"systemCode": "evo-brm",
					"customNameFlag": 0,
					"systemMenuDelete": 1
				},
				{
					"menuCode": "001002",
					"uniqueMenuCode": "EVOBRM_001002",
					"menuName": "用户管理",
					"menuIcon": "",
					"menuHomeIcon": "a.jpg",
					"menuPath": "",
					"menuType": 1,
					"module": "1",
					"isC": true,
					"sort": "2",
					"menuSort": 2,
					"systemCode": "evo-brm",
					"customNameFlag": 0
				},
				{
					"menuCode": "001003",
					"uniqueMenuCode": "EVOBRM_001003",
					"menuName": "menu.personManage",
					"menuIcon": "",
					"menuHomeIcon": "a.jpg",
					"menuPath": "",
					"menuType": 1,
					"module": "1",
					"isC": true,
					"sort": "3",
					"menuSort": 3,
					"systemCode": "evo-brm",
					"customNameFlag": 0
				},
				{
					"menuCode": "001004",
					"uniqueMenuCode": "EVOBRM_001004",
					"menuName": "设备管理",
					"menuIcon": "",
					"menuHomeIcon": "a.jpg",
					"menuPath": "",
					"menuType": 1,
					"module": "1",
					"isC": false,
					"sort": "4",
					"menuSort": 4,
					"systemCode": "evo-brm",
					"customNameFlag": 0
				}
			],
			"groups": [{
				"menus": [{
						"menuCode": "001001",
						"uniqueMenuCode": "EVOBRM_001001",
						"menuName": "menu.roleManage",
						"menuIcon": "",
						"menuHomeIcon": "a.jpg",
						"menuPath": "/roleManage",
						"menuType": 1,
						"module": "1",
						"isC": true,
						"sort": "1",
						"menuSort": 1,
						"systemCode": "evo-brm",
						"customNameFlag": 0
					},
					{
						"menuCode": "001002",
						"uniqueMenuCode": "EVOBRM_001002",
						"menuName": "用户管理",
						"menuIcon": "",
						"menuHomeIcon": "a.jpg",
						"menuPath": "",
						"menuType": 1,
						"module": "1",
						"isC": true,
						"sort": "2",
						"menuSort": 2,
						"systemCode": "evo-brm",
						"customNameFlag": 0
					},
					{
						"menuCode": "001003",
						"uniqueMenuCode": "EVOBRM_001003",
						"menuName": "menu.personManage",
						"menuIcon": "",
						"menuHomeIcon": "a.jpg",
						"menuPath": "",
						"menuType": 1,
						"module": "1",
						"isC": true,
						"sort": "3",
						"menuSort": 3,
						"systemCode": "evo-brm",
						"customNameFlag": 0
					},
					{
						"menuCode": "001004",
						"uniqueMenuCode": "EVOBRM_001004",
						"menuName": "设备管理",
						"menuIcon": "",
						"menuHomeIcon": "a.jpg",
						"menuPath": "",
						"menuType": 1,
						"module": "1",
						"isC": false,
						"sort": "4",
						"menuSort": 4,
						"systemCode": "evo-brm",
						"customNameFlag": 0
					}
				],
				"groupKey": "defaultGroup",
				"groupSort": 1
			}]
		}]
	}
}