接口说明
新增部门信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/add
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | true | long | 部门id,需要通过部门全局id生成申请 |
parentId | true | long | 父部门Id,默认为根节点1 |
name | true | string | 部门名称,长度 1-25 位,允许输入的值:数字、字母、下划线、中文、横线、点 、·最大长度25个字符,不能以空格开头和结尾,正则:^[a-zA-Z0-9_@./ ():-\s\u4E00-\u9FA5\u3400-\u4DBF]{0,25}$ |
memo | false | string | 备注 |
service | false | string | 添加服务名 |
请求参数示例
{
"id":"10000",
"parentId":10013,
"name":"二级小区H",
"memo":"备注小区H",
"service":"evo-event"
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+id | long | 部门id |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 10015
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28170000",
"errMsg": "上级部门不存在"
}
接口说明
更新部门信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/update
请求Method
PUT
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | true | long | 部门Id,不支持修改 |
parentId | true | long | 父部门Id,必填,但不支持更新父部门id,不支持修改 |
name | true | string | 部门名称,长度 1-25 位,允许输入的值:数字、字母、下划线、中文、横线、点 、·最大长度25个字符,不能以空格开头和结尾,正则:^[a-zA-Z0-9_@./ ():-\s\u4E00-\u9FA5\u3400-\u4DBF]{0,25}$ |
memo | false | string | 备注 |
service | false | string | 添加服务名 |
请求参数示例
{
"id":10011,
"parentId":10002,
"name":"一级部门G",
"meno":"备注",
"service":"evo-event"
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+id | long | 部门id |
返回参数示例(成功)
{
"success": true,
"data": {
"id":10011
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28170000",
"errMsg": "上级部门不存在"
}
接口说明
更新部门信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/batch-add
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | true | long | 部门id,需要通过部门全局id批量生成接口申请 |
parentId | true | long | 父部门Id |
name | true | string | 部门名称,长度 1-25 位,允许输入的值:数字、字母、下划线、中文、横线、点 、·最大长度25个字符,不能以空格开头和结尾,正则:^[a-zA-Z0-9_@./ ():-\s\u4E00-\u9FA5\u3400-\u4DBF]{0,25}$ |
memo | false | string | 备注 |
service | false | string | 子系统服务编码,默认evo-thirdParty |
depOperateLock | false | object | 操作权限锁 |
+add | false | int | 下级节点数据添加是否锁定,锁定之后其他系统无法在部门下新增部门 |
+update | false | int | 下级节点数据更新是否锁定,锁定之后其他系统无法更新锁定的部门 |
+delete | false | int | 下级节点数据删除是否锁定,锁定之后其他系统无法删除被锁定的部门 |
+addPerson | false | int | 添加设备权限是否锁定,锁定之后其他子系统无法在被锁定的部门下添加人员 |
请求参数示例
{
"departmentList":[
{
"id":10011,
"parentId":10002,
"name":"一级部门G",
"memo":"备注",
"depOperateLock":{
"add":1,
"delete":1,
"update":1,
"addPerson":1
},
"service":"evo-thirdParty"
},{
"id":10012,
"parentId":10002,
"name":"一级部门G2",
"memo":"备注2",
"depOperateLock":{
"add":1,
"delete":1,
"update":1,
"addPerson":1
},
"service":"evo-thirdParty"
}
]
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0为无错误,非0为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+ids | array | 部门id集合 |
返回参数示例(成功)
{
"success": true,
"data": {
"ids":[10011,10012]
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28170000",
"errMsg": "上级部门不存在"
}
接口说明
删除部门信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/delete
请求Method
DELETE
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | true | long | 部门Id |
service | true | string | 子系统编码,默认evo-thirdParty |
请求参数示例
{
"id": 10005,
"service":"evo-thirdParty"
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+id | long | 部门Id |
返回参数示例(成功)
{
"success": true,
"code": "0",
"errMsg": "成功",
"data": {
"id":10005
}
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28170014",
"errMsg": "用户没有对应部门权限"
}
接口说明
查询部门详细信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/{id}
请求Method
GET
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | true | long | 部门id |
请求参数示例
/evo-apigw/evo-brm/1.0.0/department/1
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+name | String | 部门名称 |
+id | long | 部门ID |
+parentId | long | 父ID |
+memo | string | 备注 |
+sort | int | 同级部门排序字段 |
返回参数示例(成功)
{
"success": true,
"code": "0",
"errMsg": "",
"data": {
"service": null,
"id": 1,
"parentId": 0,
"name": "根部门",
"memo": "根部门",
"sort": 1
}
}
接口说明
生成部门全局id(新增部门时候使用)
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/generate-id
请求Method
GET
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|
请求参数示例
/evo-apigw/evo-brm/1.0.0/department/generate-id
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+id | long | 部门全局ID |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 10015
},
"code": "0",
"errMsg": ""
}
接口说明
批量生成部门全局id(批量新增部门时候使用)
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/batch-generate-id
请求Method
GET
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
count | true | Integer | 生成全局唯一部门Id个数 |
请求参数示例
/evo-apigw/evo-brm/1.0.0/department/batch-generate-id?count=2
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | object | 返回数据对象 |
+idList | Array | 部门全局ID集合 |
返回参数示例(成功)
{
"success": true,
"code": "0",
"errMsg": ""
"data": {
"idList":[12,13]
}
}
接口说明
分页查询部门信息
若无请求参数,请求体应设置为{}
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.2.0/department/page
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
parentId | false | long | 上级部门ID |
containerLower | false | string | 是否包含所有下级节点,parentId不为空时有效 |
departmentIds | false | array | 部门id列表 |
pageNum | false | int | 当前页, 默认1 |
pageSize | false | int | 每页大小 |
searchKey | false | string | 模糊搜索关键字 按照部门名称模糊 |
请求参数示例
{
"parentId":1,
"containerLower":"1",
"searchKey":"",
"departmentIds":[],
"pageNum":1,
"pageSize":10
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | PageVO | 分页数据 |
PageVO
名称 | 类型 | 说明 |
---|---|---|
currentPage | int | 当前页码 |
totalPage | int | 总页数 |
pageSize | int | 每页记录数 |
totalRows | int | 总数 |
pageData | List<DeptInfoVO> | 数据列表 |
DeptInfoVO
名称 | 类型 | 说明 | |
---|---|---|---|
id | long | 部门id | |
parentId | long | 上级部门id | |
name | string | 部门名称 | |
memo | string | 备注 | |
sort | int | 同级部门排序值 | |
parentIds | string | 部门层级关系 | |
departmentSn | string | 部门唯一编码 | |
domainId | string | 级联节点的域id |
返回参数示例(成功)
{
"success": true,
"data": {
"pageData": [
{
"id": 1,
"parentId": 0,
"name": "根部门",
"memo": "根部门",
"sort": 1,
"parentIds": "1,",
"domainId": null,
"departmentSn": null
},
{
"id": 10001,
"parentId": 1,
"name": "默认部门2",
"memo": null,
"sort": 1,
"parentIds": "1,10001,",
"domainId": null,
"departmentSn": "12"
}
],
"currentPage": 1,
"totalPage": 1,
"pageSize": 2,
"totalRows": 2
},
"code": "0",
"errMsg": ""
}
接口说明
全量同步部门数据
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/department/list-page
请求Method
GET
数据提交格式
multipart/form-data
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
maxRangeId | false | long | 同步边界值 |
pageNum | false | int | 当前页, 默认1 |
pageSize | false | int | 每页大小 |
searchKey | false | string | 模糊搜索关键字 按照部门名称模糊 |
请求参数示例
https://10.55.36.202/evo-apigw/evo-brm/1.0.0/department/list-page?pageSize=20&pageNum=1
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | PageVO | 分页数据 |
PageVO
名称 | 类型 | 说明 |
---|---|---|
currentPage | int | 当前页码 |
totalPage | int | 总页数 |
pageSize | int | 每页记录数 |
totalRows | int | 总数 |
pageData | List<DeptInfoVO> | 数据列表 |
DeptInfoVO
名称 | 类型 | 说明 |
---|---|---|
id | long | 部门id |
parentId | long | 上级部门id |
name | string | 部门名称 |
memo | string | 备注 |
sort | int | 同级部门排序值 |
parentIds | string | 部门层级关系 |
departmentSn | string | 部门唯一编码 |
domainId | string | 级联节点的域id |
返回参数示例(成功)
{
"success": true,
"data": {
"pageData": [
{
"id": 1,
"parentId": 0,
"name": "根部门",
"memo": "根部门",
"sort": 1,
"parentIds": "1,",
"domainId": null,
"departmentSn": null
},
{
"id": 10001,
"parentId": 1,
"name": "默认部门2",
"memo": null,
"sort": 1,
"parentIds": "1,10001,",
"domainId": null,
"departmentSn": "12"
}
],
"currentPage": 1,
"totalPage": 1,
"pageSize": 2,
"totalRows": 2
},
"code": "0",
"errMsg": ""
}
接口说明
查询部门树
若无请求参数,请求体应设置为{}
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.2.0
接口URL
/evo-apigw/evo-brm/1.2.0/department/tree
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
parentId | false | long | 上级部门id |
checkStat | false | int | 上级部门checkStat (是否有权限) |
name | false | string | 查询部门名称 |
showPersonNode | false | Integer | 是否展示人员节点,默认不展示 |
showCascadeNode | false | Integer | 是否展示级联节点级联节点,默认不展示 |
personIdentityId | false | Long | 人员身份 只有展示人员节点时可用 |
pageNum | false | int | 当前页, 默认1 |
needCheckDepartmentIdList | false | List | 勾选部门ID列表 |
请求参数示例
{
"parentId":0,
"checkStat":1,
"name":"根部门",
"showPersonNode":"1",
"showCascadeNode":"1",
"personIdentityId":1,
"pageNum":1,
"needCheckDepartmentIdList":[1,2]
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | ValueVO | 返回数据 |
ValueVO
名称 | 类型 | 说明 |
---|---|---|
value | List<DeptInfoVO> | 数据列表 |
DeptInfoVO
名称 | 类型 | 说明 |
---|---|---|
id | long | 部门id |
parentId | long | 上级部门id |
name | String | 部门名称 |
checkStat | int | 是否有节点权限 |
sort | int | 同级部门排序字段 |
isParent | int | 是否有子部门 |
nodeType | int | 部门树节点类型,默认部门节点 |
pageNum | int | 下一页页数 仅虚拟翻页节点有,表示下一页页数 |
personId | Long | 人员ID 仅人员节点有 |
personCode | String | 人员编码 仅人员节点有 |
personName | String | 人员姓名 仅人员节点有 |
personIdentity | Long | 人员身份 仅人员节点有 |
paperNumber | String | 证件号码 仅人员节点有 |
paperType | int | 证件类型,仅人员节点有 |
isCheck | Boolean | 是否勾选,仅传参有needCheckDepartmentIdList时返回 |
返回参数示例(成功)
{
"success": true,
"data": {
"value": [
{
"id": 1,
"parentId": 0,
"name": "根部门",
"checkStat": 1,
"sort": 1,
"isParent": 1,
"isCheck": true
},
{
"parentId": 2,
"name": "人员名称",
"checkStat": 1,
"sort": 1,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 16,
"personCode": "48477",
"personName": "人员名称",
"personIdentity": 1,
"paperNumber": "1000000013452",
"paperType": 3
},
{
"parentId": 2,
"name": "人员名称",
"checkStat": 1,
"sort": 2,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 14,
"personCode": "39961",
"personName": "人员名称",
"personIdentity": 1,
"paperNumber": "1000000018593",
"paperType": 3
},
{
"parentId": 1,
"name": "人员名称",
"checkStat": 1,
"sort": 3,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 12,
"personCode": "38116",
"personName": "人员名称",
"personIdentity": 1,
"paperNumber": "1000000013296",
"paperType": 3
},
{
"parentId": 1,
"name": "人员名称update",
"checkStat": 1,
"sort": 4,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 6,
"personCode": "1234571",
"personName": "人员名称update",
"personIdentity": 1,
"paperNumber": "110101199003076632",
"paperType": 111
},
{
"parentId": 1,
"name": "147852369",
"checkStat": 1,
"sort": 5,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 5,
"personCode": "147852369",
"personName": "147852369",
"personIdentity": 1,
"paperNumber": "147852369",
"paperType": 131
},
{
"parentId": 5,
"name": "123456789",
"checkStat": 1,
"sort": 6,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 4,
"personCode": "123456789",
"personName": "123456789",
"personIdentity": 1,
"paperNumber": "123456789",
"paperType": 6
},
{
"parentId": 1,
"name": "213123",
"checkStat": 1,
"sort": 7,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 3,
"personCode": "321321",
"personName": "213123",
"personIdentity": 1,
"paperNumber": "3213213",
"paperType": 3
},
{
"parentId": 1,
"name": "dsadsa",
"checkStat": 1,
"sort": 8,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 2,
"personCode": "312",
"personName": "dsadsa",
"personIdentity": 1,
"paperNumber": "3213",
"paperType": 3
},
{
"parentId": 1,
"name": "123123123",
"checkStat": 1,
"sort": 9,
"isParent": 0,
"nodeType": 2,
"isCheck": false,
"personId": 1,
"personCode": "123123321",
"personName": "123123123",
"personIdentity": 1,
"paperNumber": "153123132",
"paperType": 6
}
]
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28160061",
"errMsg": "匹配结果节点较多,请提供更精确的模糊查询条件进行搜索 "
}