# wtenms-web **Repository Path**: chenjinsongcc/wtenms-web ## Basic Information - **Project Name**: wtenms-web - **Description**: init - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-09-24 - **Last Updated**: 2021-04-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # WTENMS后端接口文档 ## **简述** 本文档定义了WTENMS后端接口，包含接口名称、说明、URL、请求类型、请求参数、响应内容等，为前、后端程序开发提供依据。 ## **约定** ### 请求方式: | METHOD | 说明 | | ------------ | ------------ | | GET | 获取资源 | | POST | 创建资源 | | PUT | 修改资源，如果资源不存在则创建 | | DELETE | 删除资源 | ### 响应格式： 所有接口输出格式为JSON格式 ## 接口 有以下几大块： - System：程序运行、管理、配置相关，包括用户、菜单、日志、权限等 - Device：设备相关，包括设备静态、动态数据记录等 - Alert：告警相关，包括告警规则、告警信息 - Proxy：Prometheus、Alert Manager、Pushgateway的代理接口 - Workflow：工作流工单相关 - Video：摄像头监控视频相关 ### 1. System #### 1.1 登录接口 **接口地址** `/wtenms-service/sys/login` **请求方式** `POST` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | sysLoginModel | 登录对象 | body | true | 登录对象 | 登录对象 | **schema属性说明** - **登录对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | captcha | 验证码 | body | false |string | | | checkKey | 验证码key | body | false |string | | | password | 密码 | body | false |string | | | username | 账号 | body | false |string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«JSONObject» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 200, "message": "", "result": { "userInfo": {}, "sysAllDictItems": {}, "departs": {}, "token": "some login token" }, "success": true, "timestamp": 0 } ``` #### 1.2 获取验证码 **接口地址** `/wtenms-service/sys/randomImage/{key}` **请求方式** `GET` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | key | key | path | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«string» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | string | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": "check code", "success": true, "timestamp": 0 } ``` #### 1.3 角色表-分页列表查询 **接口地址** `/wtenms-service/sys/role/list` **请求方式** `GET` **接口描述** `角色表-分页列表查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | | query | false | string | | | createTime | | query | false | string | | | description | | query | false | string | | | id | | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | roleCode | | query | false | string | | | roleName | | query | false | string | | | updateBy | | query | false | string | | | updateTime | | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«IPage«SysRole»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | IPage«SysRole» | IPage«SysRole» | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **IPage«SysRole»** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | current | | integer(int64) | | | hitCount | | boolean | | | pages | | integer(int64) | | | records | | array | SysRole | | searchCount | | boolean | | | size | | integer(int64) | | | total | | integer(int64) | | - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "current": 0, "hitCount": true, "pages": 0, "records": [ { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" } ], "searchCount": true, "size": 0, "total": 0 }, "success": true, "timestamp": 0 } ``` #### 1.4 角色表-通过id查询 **接口地址** `/wtenms-service/sys/role/queryById` **请求方式** `GET` **接口描述** `角色表-通过id查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysRole» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysRole | SysRole | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" }, "success": true, "timestamp": 0 } ``` #### 1.5 查询菜单权限树 **接口地址** `/wtenms-service/sys/role/queryTreeList` **请求方式** `GET` **接口描述** `查询菜单权限树` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«Map«string,object»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {全部树节点数据}, "success": true, "timestamp": 0 } ``` #### 1.6 角色表-查询所有角色 **接口地址** `/wtenms-service/sys/role/queryall` **请求方式** `GET` **接口描述** `角色表-查询所有角色` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«List«SysRole»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | array | SysRole | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": [ { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" } ], "success": true, "timestamp": 0 } ``` #### 1.7 角色表-添加 **接口地址** `/wtenms-service/sys/role/add` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["*/*"]` **接口描述** `角色表-添加` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | role | role | body | true | SysRole | SysRole | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | | body | false |string | | | createTime | | body | false |string(date-time) | | | description | | body | false |string | | | id | | body | false |string | | | roleCode | | body | false |string | | | roleName | | body | false |string | | | updateBy | | body | false |string | | | updateTime | | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysRole» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysRole | SysRole | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" }, "success": true, "timestamp": 0 } ``` #### 1.8 角色表-编辑 **接口地址** `/wtenms-service/sys/role/edit` **请求方式** `PUT` **接口描述** `角色表-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | role | role | body | true | SysRole | SysRole | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | | body | false |string | | | createTime | | body | false |string(date-time) | | | description | | body | false |string | | | id | | body | false |string | | | roleCode | | body | false |string | | | roleName | | body | false |string | | | updateBy | | body | false |string | | | updateTime | | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysRole» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysRole | SysRole | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" }, "success": true, "timestamp": 0 } ``` #### 1.9 角色表-批量删除 **接口地址** `/wtenms-service/sys/role/deleteBatch` **请求方式** `DELETE` **接口描述** `角色表-批量删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysRole» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysRole | SysRole | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysRole** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | description | | string | | | id | | string | | | roleCode | | string | | | roleName | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "createBy": "", "createTime": "", "description": "", "id": "", "roleCode": "", "roleName": "", "updateBy": "", "updateTime": "" }, "success": true, "timestamp": 0 } ``` #### 1.10 角色表-通过id删除 **接口地址** `/wtenms-service/sys/role/delete` **请求方式** `DELETE` **接口描述** `角色表-通过id删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 1.11 一级菜单列表 **接口地址** `/wtenms-service/sys/permission/getSystemMenuList` **请求方式** `GET` **接口描述** `一级菜单列表` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«List«SysPermissionTree»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | array | SysPermissionTree | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermissionTree** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | children | | array | SysPermissionTree | | component | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | isLeaf | | boolean | | | keepAlive | | boolean | | | key | | string | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | sortNo | | number(double) | | | status | | string | | | title | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": [ { "alwaysShow": true, "children": [ { "alwaysShow": true, "children": [ {} ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "success": true, "timestamp": 0 } ``` #### 1.12 子菜单列表 **接口地址** `/wtenms-service/sys/permission/getSystemSubmenu` **请求方式** `GET` **接口描述** `子菜单列表` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | parentId | parentId | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«List«SysPermissionTree»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | array | SysPermissionTree | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermissionTree** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | children | | array | SysPermissionTree | | component | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | isLeaf | | boolean | | | keepAlive | | boolean | | | key | | string | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | sortNo | | number(double) | | | status | | string | | | title | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": [ { "alwaysShow": true, "children": [ { "alwaysShow": true, "children": [ {} ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "success": true, "timestamp": 0 } ``` #### 1.13 查询子菜单 **接口地址** `/wtenms-service/sys/permission/getSystemSubmenuBatch` **请求方式** `GET` **接口描述** `查询子菜单` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | parentIds | parentIds | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象 | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {子菜单对象}, "success": true, "timestamp": 0 } ``` #### 1.14 查询用户拥有的菜单权限和按钮权限 **接口地址** `/wtenms-service/sys/permission/getUserPermissionByToken` **请求方式** `GET` **接口描述** `查询用户拥有的菜单权限和按钮权限` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | token | token | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {菜单按钮数据}, "success": true, "timestamp": 0 } ``` #### 1.15 全部菜单数据节点 **接口地址** `/wtenms-service/sys/permission/list` **请求方式** `GET` **接口描述** `全部菜单数据节点` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«List«SysPermissionTree»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | array | SysPermissionTree | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermissionTree** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | children | | array | SysPermissionTree | | component | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | isLeaf | | boolean | | | keepAlive | | boolean | | | key | | string | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | sortNo | | number(double) | | | status | | string | | | title | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": [ { "alwaysShow": true, "children": [ { "alwaysShow": true, "children": [ {} ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "component": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "isLeaf": true, "keepAlive": true, "key": "", "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "sortNo": 0, "status": "", "title": "", "updateBy": "", "updateTime": "", "url": "" } ], "success": true, "timestamp": 0 } ``` #### 1.16 查询角色授权 **接口地址** `/wtenms-service/sys/permission/queryRolePermission` **请求方式** `GET` **接口描述** `查询角色授权` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | roleId | roleId | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«List«string»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | array | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": [角色授权], "success": true, "timestamp": 0 } ``` #### 1.17 获取全部的权限树 **接口地址** `/wtenms-service/sys/permission/queryTreeList` **请求方式** `GET` **接口描述** `获取全部的权限树` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«Map«string,object»» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {全部权限}, "success": true, "timestamp": 0 } ``` #### 1.18 添加菜单 **接口地址** `/wtenms-service/sys/permission/add` **请求方式** `POST` **接口描述** `添加菜单` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | permission | permission | body | true | SysPermission | SysPermission | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alwaysShow | | body | false |boolean | | | component | | body | false |string | | | componentName | | body | false |string | | | createBy | | body | false |string | | | createTime | | body | false |string(date-time) | | | delFlag | | body | false |integer(int32) | | | description | | body | false |string | | | hidden | | body | false |boolean | | | icon | | body | false |string | | | id | | body | false |string | | | internalOrExternal | | body | false |boolean | | | keepAlive | | body | false |boolean | | | leaf | | body | false |boolean | | | menuType | | body | false |integer(int32) | | | name | | body | false |string | | | parentId | | body | false |string | | | perms | | body | false |string | | | permsType | | body | false |string | | | redirect | | body | false |string | | | route | | body | false |boolean | | | ruleFlag | | body | false |integer(int32) | | | sortNo | | body | false |number(double) | | | status | | body | false |string | | | updateBy | | body | false |string | | | updateTime | | body | false |string(date-time) | | | url | | body | false |string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysPermission» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysPermission | SysPermission | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | component | | string | | | componentName | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | keepAlive | | boolean | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | ruleFlag | | integer(int32) | | | sortNo | | number(double) | | | status | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": { "alwaysShow": true, "component": "", "componentName": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "keepAlive": true, "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "ruleFlag": 0, "sortNo": 0, "status": "", "updateBy": "", "updateTime": "", "url": "" }, "success": true, "timestamp": 0 } ``` #### 1.19 添加菜单权限数据 **接口地址** `/wtenms-service/sys/permission/addPermissionRule` **请求方式** `POST` **接口描述** `添加菜单权限数据` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | sysPermissionDataRule | sysPermissionDataRule | body | true | SysPermissionDataRule | SysPermissionDataRule | **schema属性说明** - **SysPermissionDataRule** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | | body | false |string | | | createTime | | body | false |string(date-time) | | | id | | body | false |string | | | permissionId | | body | false |string | | | ruleColumn | | body | false |string | | | ruleConditions | | body | false |string | | | ruleName | | body | false |string | | | ruleValue | | body | false |string | | | status | | body | false |string | | | updateBy | | body | false |string | | | updateTime | | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysPermissionDataRule» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysPermissionDataRule | SysPermissionDataRule | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** **SysPermissionDataRule** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | createBy | | string | | | createTime | | string(date-time) | | | id | | string | | | permissionId | | string | | | ruleColumn | | string | | | ruleConditions | | string | | | ruleName | | string | | | ruleValue | | string | | | status | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | **响应示例** ```json { "code": 0, "message": "", "result": { "createBy": "", "createTime": "", "id": "", "permissionId": "", "ruleColumn": "", "ruleConditions": "", "ruleName": "", "ruleValue": "", "status": "", "updateBy": "", "updateTime": "" }, "success": true, "timestamp": 0 } ``` #### 1.20 编辑菜单 **接口地址** `/wtenms-service/sys/permission/edit` **请求方式** `PUT` **接口描述** `编辑菜单` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | permission | permission | body | true | SysPermission | SysPermission | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alwaysShow | | body | false |boolean | | | component | | body | false |string | | | componentName | | body | false |string | | | createBy | | body | false |string | | | createTime | | body | false |string(date-time) | | | delFlag | | body | false |integer(int32) | | | description | | body | false |string | | | hidden | | body | false |boolean | | | icon | | body | false |string | | | id | | body | false |string | | | internalOrExternal | | body | false |boolean | | | keepAlive | | body | false |boolean | | | leaf | | body | false |boolean | | | menuType | | body | false |integer(int32) | | | name | | body | false |string | | | parentId | | body | false |string | | | perms | | body | false |string | | | permsType | | body | false |string | | | redirect | | body | false |string | | | route | | body | false |boolean | | | ruleFlag | | body | false |integer(int32) | | | sortNo | | body | false |number(double) | | | status | | body | false |string | | | updateBy | | body | false |string | | | updateTime | | body | false |string(date-time) | | | url | | body | false |string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysPermission» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysPermission | SysPermission | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | component | | string | | | componentName | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | keepAlive | | boolean | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | ruleFlag | | integer(int32) | | | sortNo | | number(double) | | | status | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": { "alwaysShow": true, "component": "", "componentName": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "keepAlive": true, "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "ruleFlag": 0, "sortNo": 0, "status": "", "updateBy": "", "updateTime": "", "url": "" }, "success": true, "timestamp": 0 } ``` #### 1.21 保存角色授权 **接口地址** `/wtenms-service/sys/permission/saveRolePermission` **请求方式** `POST` **接口描述** `保存角色授权` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | json | json | body | true | | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«string» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | string | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": "", "success": true, "timestamp": 0 } ``` #### 1.22 根据id删除菜单 **接口地址** `/wtenms-service/sys/permission/delete` **请求方式** `DELETE` **接口描述** `根据id删除菜单` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysPermission» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysPermission | SysPermission | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | component | | string | | | componentName | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | keepAlive | | boolean | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | ruleFlag | | integer(int32) | | | sortNo | | number(double) | | | status | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": { "alwaysShow": true, "component": "", "componentName": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "keepAlive": true, "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "ruleFlag": 0, "sortNo": 0, "status": "", "updateBy": "", "updateTime": "", "url": "" }, "success": true, "timestamp": 0 } ``` #### 1.23 批量删除菜单 **接口地址** `/wtenms-service/sys/permission/deleteBatch` **请求方式** `DELETE` **接口描述** `批量删除菜单` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«SysPermission» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | SysPermission | SysPermission | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **schema属性说明** - **SysPermission** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | | alwaysShow | | boolean | | | component | | string | | | componentName | | string | | | createBy | | string | | | createTime | | string(date-time) | | | delFlag | | integer(int32) | | | description | | string | | | hidden | | boolean | | | icon | | string | | | id | | string | | | internalOrExternal | | boolean | | | keepAlive | | boolean | | | leaf | | boolean | | | menuType | | integer(int32) | | | name | | string | | | parentId | | string | | | perms | | string | | | permsType | | string | | | redirect | | string | | | route | | boolean | | | ruleFlag | | integer(int32) | | | sortNo | | number(double) | | | status | | string | | | updateBy | | string | | | updateTime | | string(date-time) | | | url | | string | | **响应示例** ```json { "code": 0, "message": "", "result": { "alwaysShow": true, "component": "", "componentName": "", "createBy": "", "createTime": "", "delFlag": 0, "description": "", "hidden": true, "icon": "", "id": "", "internalOrExternal": true, "keepAlive": true, "leaf": true, "menuType": 0, "name": "", "parentId": "", "perms": "", "permsType": "", "redirect": "", "route": true, "ruleFlag": 0, "sortNo": 0, "status": "", "updateBy": "", "updateTime": "", "url": "" }, "success": true, "timestamp": 0 } ``` ### 2. 设备 #### 2.1 添加设备 **接口地址** `/wtenms-service/biz/bizDevice/add` **请求方式** `POST` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizDevice | biz_device | body | true | biz_device对象 | biz_device对象 | **schema属性说明** **biz_device对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comminuty | 小区名称 | body | false |string | | | latitude | 纬度 | body | false |string | | | longitude | 经度 | body | false |string | | | modelId | 型号 | body | false |string | | | name | 唯一名称 | body | true |string | | | power | 功率 单位kW | body | false |integer(int32) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 2.2 分页列表查询 **接口地址** `/wtenms-service/biz/bizDevice/list` **请求方式** `GET` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comminuty | 小区名称 | query | false | string | | | modelId | 型号 | query | false | string | | | name | 唯一名称 | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | state | 状态 数据状态，非业务状态；0删除，1正常 | query | false | integer | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 2.3 通过id查询 **接口地址** `/wtenms-service/biz/bizDevice/queryById` **请求方式** `GET` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 2.4 设备编辑 **接口地址** `/wtenms-service/biz/bizDevice/edit` **请求方式** `PUT` **接口描述** `biz_device-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizDevice | biz_device | body | true | biz_device对象 | biz_device对象 | **schema属性说明** **biz_device对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comminuty | 小区名称 | body | false |string | | | id | 主键 | body | false |string | | | latitude | 纬度 | body | false |string | | | longitude | 经度 | body | false |string | | | modelId | 型号 | body | false |string | | | name | 唯一名称 | body | false |string | | | power | 功率 单位kW | body | false |integer(int32) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | #### 2.5 通过id删除 **接口地址** `/wtenms-service/biz/bizDevice/delete` **请求方式** `DELETE` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 2.6 批量删除 **接口地址** `/wtenms-service/biz/bizDevice/deleteBatch` **请求方式** `DELETE` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 2.7 查询小区 **接口地址** `/wtenms-service/biz/bizDevice/comminutyList` **请求方式** `GET` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | name | 小区名 | query | false | string | | | city | 市code | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": { "records": [ { "area": "海淀区", "code": "110101", "community": ["小区1", "小区2"] } ] }, "success": true, "timestamp": 0 } ``` ### 3. 告警 #### 3.1 告警规则分页列表查询 **接口地址** `/wtenms-service/biz/bizAlertRule/list` **请求方式** `GET` **接口描述** `告警规则分页列表查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comparisionOperator | 比较运算符 | query | false | string | | | createBy | 创建人 | query | false | string | | | createTime | 创建时间 | query | false | string | | | description | 描述模板 | query | false | string | | | expr | 表达式 | query | false | string | | | id | 主键 | query | false | string | | | isInitial | 是否是初始规则 0否1是 | query | false | integer | | | last | 持续时间 | query | false | string | | | name | 名称 | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | state | 状态 0删除，1正常，2停用 | query | false | integer | | | threshold | 阈值 | query | false | string | | | type | 类型 | query | false | integer | | | unit | 单位 | query | false | string | | | updateBy | 更新人 | query | false | string | | | updateTime | 更新时间 | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.2 告警规则通过id查询 **接口地址** `/wtenms-service/biz/bizAlertRule/queryById` **请求方式** `GET` **接口描述** `告警规则通过id查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.3 告警规则添加 **接口地址** `/wtenms-service/biz/bizAlertRule/add` **请求方式** `POST` **接口描述** `告警规则添加` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizAlertRule | biz_alert_rule | body | true | biz_alert_rule对象 | biz_alert_rule对象 | **schema属性说明** **biz_alert_rule对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comparisionOperator | 比较运算符 | body | false |string | | | createBy | 创建人 | body | false |string | | | createTime | 创建时间 | body | false |string(date-time) | | | description | 描述模板 | body | false |string | | | expr | 表达式 | body | false |string | | | id | 主键 | body | false |string | | | isInitial | 是否是初始规则 0否1是 | body | false |integer(int32) | | | last | 持续时间 | body | false |string | | | name | 名称 | body | false |string | | | state | 状态 0删除，1正常，2停用 | body | false |integer(int32) | | | threshold | 阈值 | body | false |string | | | type | 类型 | body | false |integer(int32) | | | unit | 单位 | body | false |string | | | updateBy | 更新人 | body | false |string | | | updateTime | 更新时间 | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.4 告警规则编辑 **接口地址** `/wtenms-service/biz/bizAlertRule/edit` **请求方式** `PUT` **consumes** `["application/json"]` **produces** `["*/*"]` **接口描述** `biz_alert_rule-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizAlertRule | biz_alert_rule | body | true | biz_alert_rule对象 | biz_alert_rule对象 | **schema属性说明** **biz_alert_rule对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | comparisionOperator | 比较运算符 | body | false |string | | | createBy | 创建人 | body | false |string | | | createTime | 创建时间 | body | false |string(date-time) | | | description | 描述模板 | body | false |string | | | expr | 表达式 | body | false |string | | | id | 主键 | body | false |string | | | isInitial | 是否是初始规则 0否1是 | body | false |integer(int32) | | | last | 持续时间 | body | false |string | | | name | 名称 | body | false |string | | | state | 状态 0删除，1正常，2停用 | body | false |integer(int32) | | | threshold | 阈值 | body | false |string | | | type | 类型 | body | false |integer(int32) | | | unit | 单位 | body | false |string | | | updateBy | 更新人 | body | false |string | | | updateTime | 更新时间 | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.5 告警规则批量删除 **接口地址** `/wtenms-service/biz/bizAlertRule/deleteBatch` **请求方式** `DELETE` **接口描述** `告警规则批量删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.6 告警规则通过id删除 **接口地址** `/wtenms-service/biz/bizAlertRule/delete` **请求方式** `DELETE` **consumes** `` **produces** `["*/*"]` **接口描述** `告警规则通过id删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.8 告警信息-分页列表查询 **接口地址** `/wtenms-service/biz/bizAlertMsg/list` **请求方式** `GET` **接口描述** `告警信息-分页列表查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alertRuleId | 关联的规则 | query | false | string | | | createBy | 创建人 | query | false | string | | | createTime | 创建时间 | query | false | string | | | description | 描述 | query | false | string | | | deviceId | 关联的设备 | query | false | string | | | endsAt | 结束时间 | query | false | string | | | fingerprint | 告警指纹 | query | false | string | | | id | 主键 | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | startsAt | 开始时间 | query | false | string | | | state | 状态 | query | false | integer | | | updateBy | 更新人 | query | false | string | | | updateTime | 更新时间 | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.9 告警信息-通过id查询 **接口地址** `/wtenms-service/biz/bizAlertMsg/queryById` **请求方式** `GET` **接口描述** `告警信息-通过id查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.10 告警通知查询 **接口地址** `/wtenms-service/biz/bizAlertMsg/noticeList` **请求方式** `GET` **接口描述** `告警通知查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | | query | false | string | | | createTime | | query | false | string | | | deviceId | | query | false | string | | | email | email | query | false | string | | | endsAt | | query | false | string | | | id | 主键 | query | false | string | | | msg | | query | false | string | | | notificationId | 通知 | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | startsAt | | query | false | string | | | state | 阅读状态 | query | false | integer | | | type | | query | false | integer | | | updateBy | | query | false | string | | | updateTime | | query | false | string | | | userId | 用户id | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.11 告警的设备分布 **接口地址** `/wtenms-service/biz/bizAlertMsg/overview` **请求方式** `GET` **接口描述** `告警的设备分布` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | end | end | query | true | string | | | start | start | query | true | string | | | top | top | query | false | integer | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.12 告警类型比例 **接口地址** `/wtenms-service/biz/bizAlertMsg/alertType` **请求方式** `GET` **接口描述** `告警类型比例` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | end | end | query | true | string | | | start | start | query | true | string | | | top | top | query | false | integer | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.13 告警信息-添加 **接口地址** `/wtenms-service/biz/bizAlertMsg/add` **请求方式** `POST` **接口描述** `告警信息-添加` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizAlertMsg | 告警信息 | body | true | biz_alert_msg对象 | biz_alert_msg对象 | **schema属性说明** **biz_alert_msg对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alertRuleId | 关联的规则 | body | false |string | | | createBy | 创建人 | body | false |string | | | createTime | 创建时间 | body | false |string(date-time) | | | description | 描述 | body | false |string | | | deviceId | 关联的设备 | body | false |string | | | endsAt | 结束时间 | body | false |string(date-time) | | | fingerprint | 告警指纹 | body | false |string | | | id | 主键 | body | false |string | | | startsAt | 开始时间 | body | false |string(date-time) | | | state | 状态 | body | false |integer(int32) | | | updateBy | 更新人 | body | false |string | | | updateTime | 更新时间 | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.14 告警信息-编辑 **接口地址** `/wtenms-service/biz/bizAlertMsg/edit` **请求方式** `PUT` **接口描述** `告警信息-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizAlertMsg | 告警信息 | body | true | biz_alert_msg对象 | biz_alert_msg对象 | **schema属性说明** **biz_alert_msg对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alertRuleId | 关联的规则 | body | false |string | | | createBy | 创建人 | body | false |string | | | createTime | 创建时间 | body | false |string(date-time) | | | description | 描述 | body | false |string | | | deviceId | 关联的设备 | body | false |string | | | endsAt | 结束时间 | body | false |string(date-time) | | | fingerprint | 告警指纹 | body | false |string | | | id | 主键 | body | false |string | | | startsAt | 开始时间 | body | false |string(date-time) | | | state | 状态 | body | false |integer(int32) | | | updateBy | 更新人 | body | false |string | | | updateTime | 更新时间 | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.15 告警信息-通过id消除 **接口地址** `/wtenms-service/biz/bizAlertMsg/clear` **请求方式** `PUT` **接口描述** `告警信息-通过id消除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | msg | 告警信息 | body | true | biz_alert_msg对象 | biz_alert_msg对象 | **schema属性说明** **biz_alert_msg对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alertRuleId | 关联的规则 | body | false |string | | | createBy | 创建人 | body | false |string | | | createTime | 创建时间 | body | false |string(date-time) | | | description | 描述 | body | false |string | | | deviceId | 关联的设备 | body | false |string | | | endsAt | 结束时间 | body | false |string(date-time) | | | fingerprint | 告警指纹 | body | false |string | | | id | 主键 | body | false |string | | | startsAt | 开始时间 | body | false |string(date-time) | | | state | 状态 | body | false |integer(int32) | | | updateBy | 更新人 | body | false |string | | | updateTime | 更新时间 | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.16 告警信息-批量消除 **接口地址** `/wtenms-service/biz/bizAlertMsg/clearBatch` **请求方式** `PUT` **consumes** `["application/json"]` **produces** `["*/*"]` **接口描述** `告警信息-批量消除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | body | true | | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.17 将通知状态已读 **接口地址** `/wtenms-service/biz/bizAlertMsg/noticeRead` **请求方式** `PUT` **接口描述** `将通知状态已读` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.18 告警信息-通过id删除 **接口地址** `/wtenms-service/biz/bizAlertMsg/delete` **请求方式** `DELETE` **接口描述** `告警信息-通过id删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.19 告警信息-批量删除 **接口地址** `/wtenms-service/biz/bizAlertMsg/deleteBatch` **请求方式** `DELETE` **接口描述** `告警信息-批量删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.20 根据告警类型name获取所有设备该类型告警的告警次数 **接口地址** `/wtenms-service/biz/bizAlertMsg/reportSubTableByAlertType` **请求方式** `GET` **接口描述** `根据告警类型name获取所有设备该类型告警的告警次数` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | end | end | query | true | string | | | name | name | query | false | string | | | start | start | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 3.21 根据设备name获取该设备各个告警类型的告警次数 **接口地址** `/wtenms-service/biz/bizAlertMsg/reportSubTableByDevice` **请求方式** `GET` **接口描述** `根据设备name获取该设备各个告警类型的告警次数` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | end | end | query | true | string | | | name | name | query | false | string | | | start | start | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` ### 4. 中间件代理接口 #### 4.1 收集设备发来的状态数据 **接口地址** `/wtenms-service/biz/proxy/collect` **请求方式** `GET` **接口描述** `收集设备发来的状态数据` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | BH | 编号 | query | false | string | | | BJ | 报警触发状态 | query | false | array | number | | CL | 处理量 | query | false | number | | | DB | 电表 | query | false | number | | | FS | 粉碎电机状态 | query | false | number | | | GB | 盖板状态 | query | false | array | number | | JB | 搅拌机状态 | query | false | number | | | JR | 加热器状态 | query | false | number | | | JY | 加药泵状态 | query | false | number | | | PH | PH | query | false | number | | | TS | 提升机状态 | query | false | array | number | | TX | 提醒触发状态 | query | false | array | number | | WD | 温度 | query | false | number | | | ZT | 设备运行状态 | query | false | number | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** 暂无 **响应示例** 暂无 #### 4.2 收集设备发来的处理量 **接口地址** `/wtenms-service/biz/proxy/treating` **请求方式** `GET` **接口描述** `收集设备发来的处理量` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | BH | 编号 | query | false | string | | | BJ | 报警触发状态 | query | false | array | number | | CL | 处理量 | query | false | number | | | DB | 电表 | query | false | number | | | FS | 粉碎电机状态 | query | false | number | | | GB | 盖板状态 | query | false | array | number | | JB | 搅拌机状态 | query | false | number | | | JR | 加热器状态 | query | false | number | | | JY | 加药泵状态 | query | false | number | | | PH | PH | query | false | number | | | TS | 提升机状态 | query | false | array | number | | TX | 提醒触发状态 | query | false | array | number | | WD | 温度 | query | false | number | | | ZT | 设备运行状态 | query | false | number | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** 暂无 **响应示例** 暂无 #### 4.3 收集AlertManager发来的告警 **接口地址** `/wtenms-service/biz/proxy/alertReceiver` **请求方式** `POST` **接口描述** `收集AlertManager发来的告警` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | alertManagerReceive | alertManagerReceive | body | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** 暂无 **响应示例** 暂无 #### 4.4 从prometheus查询数据 **接口地址** `/wtenms-service/prom/**` **请求方式** `GET` **接口描述** `从prometheus查询数据` **请求参数** 暂无 **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** 暂无 **响应示例** prometheus查询结果 ### 5. 工作流 #### 5.1 处理人分页列表查询 **接口地址** `/wtenms-service/biz/bizHandling/list` **请求方式** `GET` **接口描述** `处理人分页列表查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | createBy | query | false | string | | | createTime | createTime | query | false | string | | | id | id | query | false | string | | | name | name | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | remark | 备注 | query | false | string | | | state | 0删除 1正常 | query | false | integer | | | tel | tel | query | false | string | | | type | type | query | false | integer | | | updateBy | updateBy | query | false | string | | | updateTime | updateTime | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.2 处理人通过id查询 **接口地址** `/wtenms-service/biz/bizHandling/queryById` **请求方式** `GET` **接口描述** `处理人-通过id查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.3 处理人添加 **接口地址** `/wtenms-service/biz/bizHandling/add` **请求方式** `POST` **接口描述** `处理人添加` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizHandling | biz_handling | body | true | biz_handling对象 | biz_handling对象 | **schema属性说明** **biz_handling对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | id | id | body | false |string | | | name | name | body | false |string | | | remark | 备注 | body | false |string | | | state | 0删除 1正常 | body | false |integer(int32) | | | tel | tel | body | false |string | | | type | type | body | false |integer(int32) | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.4 处理人-编辑 **接口地址** `/wtenms-service/biz/bizHandling/edit` **请求方式** `PUT` **接口描述** `处理人-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizHandling | biz_handling | body | true | biz_handling对象 | biz_handling对象 | **schema属性说明** **biz_handling对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | id | id | body | false |string | | | name | name | body | false |string | | | remark | 备注 | body | false |string | | | state | 0删除 1正常 | body | false |integer(int32) | | | tel | tel | body | false |string | | | type | type | body | false |integer(int32) | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.5 处理人-通过id删除 **接口地址** `/wtenms-service/biz/bizHandling/delete` **请求方式** `DELETE` **接口描述** `处理人-通过id删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.6 处理人-批量删除 **接口地址** `/wtenms-service/biz/bizHandling/deleteBatch` **请求方式** `DELETE` **接口描述** `处理人-批量删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.7 工单-分页列表查询 **接口地址** `/wtenms-service/biz/bizWorkflow/list` **请求方式** `GET` **接口描述** `工单-分页列表查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | content | content | query | false | string | | | createBy | createBy | query | false | string | | | createTime | createTime | query | false | string | | | creator | 工单创建人 | query | false | string | | | deviceId | deviceId | query | false | string | | | id | id | query | false | string | | | num | num | query | false | string | | | pageNo | pageNo | query | false | integer | | | pageSize | pageSize | query | false | integer | | | receiver | 接单人 | query | false | string | | | report.content | content | query | false | string | | | report.createBy | createBy | query | false | string | | | report.createTime | createTime | query | false | string | | | report.creator | creator | query | false | string | | | report.id | id | query | false | string | | | report.state | state | query | false | integer | | | report.time | 报告发生时间 | query | false | string | | | report.title | title | query | false | string | | | report.updateBy | updateBy | query | false | string | | | report.updateTime | updateTime | query | false | string | | | report.workflowId | workflowId | query | false | string | | | state | 0删除 1生成 2处理中 3已处理 | query | false | integer | | | time | 故障发生时间 | query | false | string | | | title | title | query | false | string | | | updateBy | updateBy | query | false | string | | | updateTime | updateTime | query | false | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.8 工单-通过id查询 **接口地址** `/wtenms-service/biz/bizWorkflow/queryById` **请求方式** `GET` **接口描述** `工单-通过id查询` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.9 biz_workflow-添加 **接口地址** `/wtenms-service/biz/bizWorkflow/add` **请求方式** `POST` **接口描述** `biz_workflow-添加` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizWorkflow | biz_workflow | body | true | biz_workflow对象 | biz_workflow对象 | **schema属性说明** **biz_workflow对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | content | content | body | false |string | | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | creator | 工单创建人 | body | false |string | | | deviceId | deviceId | body | false |string | | | id | id | body | false |string | | | num | num | body | false |string | | | receiver | 接单人 | body | false |string | | | report | | body | false |biz_workflow_report对象 | biz_workflow_report对象 | | state | 0删除 1生成 2处理中 3已处理 | body | false |integer(int32) | | | time | 故障发生时间 | body | false |string(date-time) | | | title | title | body | false |string | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | **biz_workflow_report对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | content | content | body | false |string | | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | creator | creator | body | false |string | | | id | id | body | false |string | | | state | state | body | false |integer(int32) | | | time | 报告发生时间 | body | false |string(date-time) | | | title | title | body | false |string | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | | workflowId | workflowId | body | false |string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.10 biz_workflow-编辑 **接口地址** `/wtenms-service/biz/bizWorkflow/edit` **请求方式** `PUT` **接口描述** `biz_workflow-编辑` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | bizWorkflow | biz_workflow | body | true | biz_workflow对象 | biz_workflow对象 | **schema属性说明** **biz_workflow对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | content | content | body | false |string | | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | creator | 工单创建人 | body | false |string | | | deviceId | deviceId | body | false |string | | | id | id | body | false |string | | | num | num | body | false |string | | | receiver | 接单人 | body | false |string | | | report | | body | false |biz_workflow_report对象 | biz_workflow_report对象 | | state | 0删除 1生成 2处理中 3已处理 | body | false |integer(int32) | | | time | 故障发生时间 | body | false |string(date-time) | | | title | title | body | false |string | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | **biz_workflow_report对象** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | content | content | body | false |string | | | createBy | createBy | body | false |string | | | createTime | createTime | body | false |string(date-time) | | | creator | creator | body | false |string | | | id | id | body | false |string | | | state | state | body | false |integer(int32) | | | time | 报告发生时间 | body | false |string(date-time) | | | title | title | body | false |string | | | updateBy | updateBy | body | false |string | | | updateTime | updateTime | body | false |string(date-time) | | | workflowId | workflowId | body | false |string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.11 撤回 **接口地址** `/wtenms-service/biz/bizWorkflow/withdraw` **请求方式** `PUT` **接口描述** `撤回` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.12 批量撤回 **接口地址** `/wtenms-service/biz/bizWorkflow/withdrawBatch` **请求方式** `PUT` **接口描述** `批量撤回` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.13 工单-通过id删除 **接口地址** `/wtenms-service/biz/bizWorkflow/delete` **请求方式** `DELETE` **接口描述** `工单-通过id删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | id | id | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ``` #### 5.14 工单-批量删除 **接口地址** `/wtenms-service/biz/bizWorkflow/deleteBatch` **请求方式** `DELETE` **接口描述** `工单-批量删除` **请求参数** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | | ids | ids | query | true | string | | **响应状态** | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |接口返回对象«object» | | 204 | No Content | | | 401 | Unauthorized | | | 403 | Forbidden | | **响应参数** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | | code |返回代码 | integer(int32) | integer(int32) | | message |返回处理消息 | string | | | result |返回数据对象 | object | | | success |成功标志 | boolean | | | timestamp |时间戳 | integer(int64) | integer(int64) | **响应示例** ```json { "code": 0, "message": "", "result": {}, "success": true, "timestamp": 0 } ```