{ "swagger": "2.0", "info": { "title": "电力测温项目API", "description": "电力测温项目接口文档。本文档仅用于本项目的前端接口说明\u003cbr\u003e\u003cspan style='color:red;font-size:16px;'\u003e*****实际使用接口时，均需要将用户登录token通过header进行提交*****\u003c/span\u003e", "version": "1.0.0", "contact": { "email": "3116246@qq.com" } }, "basePath": "/api/", "paths": { "/alarm/confirm": { "post": { "tags": [ "alarm" ], "summary": "对告警记录进行确认", "description": "对告警记录进行确认，确认时要以填确认意见", "parameters": [ { "in": "query", "name": "id", "description": "需要确认的告警记录ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "content", "description": "确认的用户填写的内容", "type": "string" }, { "in": "query", "name": "eventid", "description": "需要确认的告警事件ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/ApiOK" } }, "500": { "description": "status 失败" } } } }, "/alarm/data_list": { "get": { "tags": [ "alarm" ] } }, "/alarm/delete": { "post": { "tags": [ "alarm" ] } }, "/alarm/detail": { "get": { "tags": [ "alarm" ] } }, "/alarm/edit": { "post": { "tags": [ "alarm" ] } }, "/alarm/list": { "get": { "tags": [ "alarm" ] }, "post": { "tags": [ "alarm" ] } }, "/alarm/now": { "get": { "tags": [ "alarm" ] } }, "/alarminfohis/confirm": { "post": { "tags": [ "alarminfohis" ], "summary": "用户告警确认", "description": "用户告警确认", "parameters": [ { "in": "query", "name": "id", "description": "告警信息ID", "required": true, "type": "integer", "format": "int64" } ] } }, "/alarminfohis/query": { "get": { "tags": [ "alarminfohis" ], "summary": "告警详情列表查询", "description": "告警详情列表查询.根据查询条件返回查询结果", "parameters": [ { "in": "query", "name": "pageInex", "description": "页数.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "pageSize", "description": "每页记录数.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpname", "description": "测点名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarmDesc", "description": "告警描述.", "required": true, "type": "string" }, { "in": "query", "name": "beginTime", "description": "开始时间", "required": true, "type": "string" }, { "in": "query", "name": "endTime", "description": "结束时间", "required": true, "type": "string" } ] } }, "/alarminfohis/stat/strategy_total/echarts": { "get": { "tags": [ "alarminfohis" ], "summary": "按策略分类统计告警总数", "description": "按策略分类统计告警总数.并返回echarts柱状图格式数据,格式为:{\"legend\":[],\"data\":[]}", "parameters": [ { "in": "query", "name": "device_id", "description": "设备ID", "type": "integer", "format": "int64" }, { "in": "query", "name": "area_id", "description": "区域ID", "type": "integer", "format": "int64" } ] } }, "/alarminfohis/stat/total": { "get": { "tags": [ "alarminfohis" ], "summary": "告警总数汇总统计", "description": "告警总数汇总统计.统计结果包括总数、月总数、周总数、当前日总数", "parameters": [ { "in": "query", "name": "device_id", "description": "设备ID", "type": "integer", "format": "int64" }, { "in": "query", "name": "area_id", "description": "区域ID", "type": "integer", "format": "int64" } ] } }, "/alarmtactics/absdel": { "post": { "tags": [ "alarmtactics" ], "summary": "删除绝对值告警信息", "description": "删除绝对值告警信息和对应的测点", "parameters": [ { "in": "query", "name": "id", "description": "告警信息id", "required": true, "type": "integer", "format": "int64" } ] } }, "/alarmtactics/abslist": { "get": { "tags": [ "alarmtactics" ], "summary": "获取绝对值告警列表", "description": "获取绝对值告警列表", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/alarmtactics/abssave": { "post": { "tags": [ "alarmtactics" ], "summary": "保存绝对值告警信息", "description": "保存绝对值告警信息和对应的测点", "parameters": [ { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mod_name", "description": "模型名称.", "required": true, "type": "string" }, { "in": "query", "name": "mod_id", "description": "模型id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "operation_symbol", "description": "操作符号.", "required": true, "type": "string" }, { "in": "query", "name": "threshold", "description": "阈值.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpjson", "description": "测点id和测点名称组成的k,v键值对数组的json字符串", "required": true, "type": "string" } ] } }, "/alarmtactics/absupdate": { "post": { "tags": [ "alarmtactics" ], "summary": "更新绝对值告警信息", "description": "更新绝对值告警信息和对应的测点", "parameters": [ { "in": "query", "name": "id", "description": "id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mod_name", "description": "模型名称.", "required": true, "type": "string" }, { "in": "query", "name": "mod_id", "description": "模型id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "operation_symbol", "description": "操作符号.", "required": true, "type": "string" }, { "in": "query", "name": "threshold", "description": "阈值.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpjson", "description": "测点id和测点名称组成的k,v键值对数组的json字符串", "required": true, "type": "string" } ] } }, "/alarmtactics/risedel": { "post": { "tags": [ "alarmtactics" ], "summary": "删除升温告警信息", "description": "删除升温告警信息和对应的测点", "parameters": [ { "in": "query", "name": "id", "description": "告警信息id", "required": true, "type": "integer", "format": "int64" } ] } }, "/alarmtactics/riselist": { "get": { "tags": [ "alarmtactics" ], "summary": "获取升温告警列表", "description": "获取升温告警列表", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/alarmtactics/risesave": { "post": { "tags": [ "alarmtactics" ], "summary": "保存升温告警信息", "description": "保存升温告警信息和对应的测点", "parameters": [ { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mod_name", "description": "模型名称.", "required": true, "type": "string" }, { "in": "query", "name": "mod_id", "description": "模型id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "upcycle", "description": "上升周期.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "scope", "description": "阈值.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpjson", "description": "测点id和测点名称组成的k,v键值对数组的json字符串", "required": true, "type": "string" } ] } }, "/alarmtactics/riseupdate": { "post": { "tags": [ "alarmtactics" ], "summary": "更新升温告警信息", "description": "更新升温告警信息和对应的测点", "parameters": [ { "in": "query", "name": "id", "description": "id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mod_name", "description": "模型名称.", "required": true, "type": "string" }, { "in": "query", "name": "mod_id", "description": "模型id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "upcycle", "description": "上升周期.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "scope", "description": "阈值.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpjson", "description": "测点id和测点名称组成的k,v键值对数组的json字符串", "required": true, "type": "string" } ] } }, "/alarmtactics/unbalancedel": { "post": { "tags": [ "alarmtactics" ], "summary": "删除温度不平衡告警", "description": "删除温度不平衡告警", "parameters": [ { "in": "query", "name": "id", "description": "告警信息id", "required": true, "type": "integer", "format": "int64" } ] } }, "/alarmtactics/unbalancelist": { "get": { "tags": [ "alarmtactics" ], "summary": "获取温度不平衡告警列表", "description": "获取温度不平衡告警列表", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/alarmtactics/unbalancesave": { "post": { "tags": [ "alarmtactics" ], "summary": "保存温度不平衡告警信息", "description": "保存温度不平衡告警信息", "parameters": [ { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "operation_symbol", "description": "操作符号.", "required": true, "type": "string" }, { "in": "query", "name": "threshold", "description": "阈值.", "required": true, "type": "integer", "format": "int64" } ] } }, "/alarmtactics/unbalanceupdate": { "post": { "tags": [ "alarmtactics" ], "summary": "更新温度不平衡告警信息", "description": "更新温度不平衡告警信息", "parameters": [ { "in": "query", "name": "id", "description": "id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "strategy_name", "description": "策略名称.", "required": true, "type": "string" }, { "in": "query", "name": "alarm_level", "description": "告警等级.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "operation_symbol", "description": "操作符号.", "required": true, "type": "string" }, { "in": "query", "name": "threshold", "description": "阈值.", "required": true, "type": "integer", "format": "int64" } ] } }, "/app/list": { "get": { "tags": [ "app" ], "summary": "获取变电管理框架中已注册的应用列表", "description": "获取变电管理框架中已注册的应用列表", "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/app/user/role": { "get": { "tags": [ "app" ], "summary": "获取用户信息", "description": "获取指定token的用户信息", "parameters": [ { "in": "query", "name": "token", "description": "管理app分配的当前登录的TOKEN", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/clearData": { "post": { "tags": [ "base" ], "summary": "物理清除指定数据表的数据", "description": "物理清除指定数据表的数据。数据为物理删除，谨慎调用！", "parameters": [ { "in": "query", "name": "dtype", "description": "表名称。", "required": true, "type": "string" }, { "in": "query", "name": "day", "description": "需要数据保留的最近天数。默认为7天", "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/createuser": { "post": { "tags": [ "base" ] } }, "/base/deleteGlobalcode": { "post": { "tags": [ "base" ], "summary": "删除系统常量字典码定义", "description": "删除系统常量字典码定义。如果指定代码有下级代码将会一并删除", "parameters": [ { "in": "query", "name": "code", "description": "需要删除的字典编码", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/deleteUser": { "post": { "tags": [ "base" ], "summary": "删除指定用户", "description": "删除指定用户。谨慎操作！", "parameters": [ { "in": "query", "name": "id", "description": "用户ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/getGlobalCode": { "get": { "tags": [ "base" ], "summary": "获取系统常量字典码定义", "description": "获取系统常量字典码定义。", "parameters": [ { "in": "query", "name": "pcode", "description": "根据指定代码获取其级子码定义", "type": "string" }, { "in": "query", "name": "code", "description": "根据指定代码的定义", "type": "string" }, { "in": "query", "name": "pageindex", "description": "当前分页页码.默认为第1页", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "当前每页记录数。默认为20", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/getRoleFuncList": { "get": { "tags": [ "base" ], "summary": "查询角色与功能资源可访问关系", "description": "查询角色与功能资源可访问关系。", "parameters": [ { "in": "query", "name": "roleid", "description": "角色ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/getSysParamList": { "get": { "tags": [ "base" ], "summary": "获取系统参数定义", "description": "获取系统参数定义。", "parameters": [ { "in": "query", "name": "name", "description": "系统参数代码名称。为空时获取所有参数定义。", "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/getSyslogList": { "get": { "tags": [ "base" ], "summary": "查询系统操作日志", "description": "查询系统操作日志。", "parameters": [ { "in": "query", "name": "startdate", "description": "查询的开始时间。格式为:yyyy-mm-dd HH:mi:ss。默认为当前天的0点", "type": "string" }, { "in": "query", "name": "enddate", "description": "查询的结束时间。格式为:yyyy-mm-dd HH:mi:ss。默认为当前天的23:59:59", "type": "string" }, { "in": "query", "name": "description", "description": "查询的日志内容。模糊匹配。", "type": "string" }, { "in": "query", "name": "success", "description": "日志操作结果。仅支持0或1。", "type": "string" }, { "in": "query", "name": "logtype", "description": "查询的日志操作类型。仅支持系统字典代码log_opttype定义的code值。", "type": "string" }, { "in": "query", "name": "audittype", "description": "查询的日志审计类型。仅支持系统字典代码log_audittype定义的code值。", "type": "string" }, { "in": "query", "name": "eventtype", "description": "查询的事件类型。仅支持系统字典代码eventtype定义的code值。", "type": "string" }, { "in": "query", "name": "eventlevel", "description": "查询的事件等级。仅支持系统字典代码eventlevel定义的code值。", "type": "string" }, { "in": "query", "name": "pageindex", "description": "当前分页页码.默认为第1页", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "当前每页记录数。默认为20", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/getUser": { "get": { "tags": [ "base" ] }, "post": { "tags": [ "base" ] } }, "/base/getUserPrivList": { "get": { "tags": [ "base" ] } }, "/base/getVersion": { "get": { "tags": [ "base" ], "summary": "获取当前系统的版本号", "description": "获取当前系统的版本号", "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/keep-alive": { "post": { "tags": [ "base" ], "summary": "心跳保活", "description": "心跳保活。特殊应用场景下用于token自动续期。", "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/login": { "post": { "tags": [ "base" ], "summary": "用户登录", "description": "用户登录。集成变电框架时，无需调用此接口。", "parameters": [ { "in": "query", "name": "login_account", "description": "用户帐号", "required": true, "type": "string" }, { "in": "query", "name": "pwd", "description": "用户密码", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/logout": { "post": { "tags": [ "base" ], "summary": "用户登出", "description": "用户登出。集成变电框架时，无需调用此接口。", "parameters": [ { "in": "query", "name": "sessionid", "description": "登录用户的token", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/playWav": { "get": { "tags": [ "base" ], "summary": "语音文件播放", "description": "语音文件播放。仅支持windows系统。", "parameters": [ { "in": "query", "name": "filename", "description": "语音/录音文件名。需要将文件已上传到系统指定目录。", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/resetUserPwd": { "post": { "tags": [ "base" ], "summary": "修改当前用户密码", "description": "修改当前用户密码。一般用于用户修改自己的密码。", "parameters": [ { "in": "query", "name": "newpwd", "description": "新密码。需满足系统当前采用的密码规则", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/saveGlobalcode": { "post": { "tags": [ "base" ], "summary": "保存系统常量字典码定义", "description": "保存系统常量字典码定义。如果code已在存在，将对已有定义进行更新。", "parameters": [ { "in": "query", "name": "name", "description": "当前字典名称或者描述", "required": true, "type": "string" }, { "in": "query", "name": "code", "description": "当前字典编码", "required": true, "type": "string" }, { "in": "query", "name": "parentcode", "description": "当前字典编码的上级编码", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/saveRoleFunc": { "post": { "tags": [ "base" ], "summary": "保存角色与功能资源可访问关系", "description": "保存角色与功能资源可访问关系。", "parameters": [ { "in": "query", "name": "roleid", "description": "角色ID", "required": true, "type": "string" }, { "in": "query", "name": "funcids", "description": "资源功能编号ID。多个ID使用半角逗号分隔", "required": true, "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/saveSysParam": { "post": { "tags": [ "base" ], "summary": "保存系统参数定义", "description": "保存系统参数定义。", "parameters": [ { "in": "query", "name": "param_name", "description": "系统参数代码名称", "required": true, "type": "string" }, { "in": "query", "name": "param_value", "description": "系统参数值", "required": true, "type": "string" }, { "in": "query", "name": "param_memo", "description": "系统参数描述", "type": "string" } ], "responses": { "200": { "description": "错误", "schema": { "$ref": "#/definitions/ApiError" } }, "500": { "description": "status 失败" } } } }, "/base/saveUser": { "post": { "tags": [ "base" ] } }, "/base/saveUserPrivList": { "post": { "tags": [ "base" ] } }, "/base/searchUserInfo": { "get": { "tags": [ "base" ] } }, "/blacklist/delblacklist": { "post": { "tags": [ "blacklist" ], "summary": "删除黑名单主记录和明细记录", "description": "通过设备id删除黑名单主记录和明细记录", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备id必填", "required": true, "type": "integer", "format": "int64" } ] } }, "/blacklist/list": { "get": { "tags": [ "blacklist" ], "summary": "获取黑名单列表", "description": "获取黑名单列表。返回黑名单主信息和测点明细信息", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/blacklist/saveblacklist": { "post": { "tags": [ "blacklist" ], "summary": "保存黑名单列表信息", "description": "保存黑名单基本信息和设备对应的测点", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "area", "description": "区域名称必填否则无法显示区域.", "type": "string" }, { "in": "query", "name": "devicename", "description": "设备名称必填否则无法显示设备名称.", "type": "string" }, { "in": "query", "name": "devicecode", "description": "设备code必填，否则无法显示设备编码.", "type": "string" }, { "in": "query", "name": "creator", "description": "添加人必填，否则无法显示", "type": "string" }, { "in": "query", "name": "mplist", "description": "按逗号分割的测点字符串", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/blacklist/updatemplist": { "post": { "tags": [ "blacklist" ], "summary": "修改黑名单测点列表信息", "description": "修改黑名单测点列表信息", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mplist", "description": "按逗号分割的测点字符串", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/comand/control": { "post": { "tags": [ "comand" ] } }, "/comand/restart": { "post": { "tags": [ "comand" ] } }, "/dataoptimize/delete/deletion_rule": { "post": { "tags": [ "dataoptimize" ], "summary": "删除指定设备的缺点数据优化规则", "description": "删除指定设备的缺点数据优化规则", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/dataoptimize/delete/invalid_rule": { "post": { "tags": [ "dataoptimize" ], "summary": "删除指定设备的无效数据优化规则", "description": "删除指定设备的无效数据优化规则", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/dataoptimize/edit": { "post": { "tags": [ "dataoptimize" ], "summary": "添加或编辑数据优化规则", "description": "保存添加或编辑测点数据优化规则的提交数据", "parameters": [ { "in": "query", "name": "optimizetype", "description": "填充规则类型。invalid：无效数据填充,其cnf参数值格式样例：{Tem1:{attrname:Tem1,value:[-10,55]}} deletion：缺点数据填充,其cnf参数格式样例：[{attrname:Tem1,value:[{attrname:Tem2},{attrname:Tem3}]}]", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "cnf", "description": "填充配置内容。JSON格式的序列化串.", "type": "string" }, { "in": "query", "name": "deviceid", "description": "设备ID", "type": "string" }, { "in": "query", "name": "modelid", "description": "模型ID", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/dataoptimize/list": { "get": { "tags": [ "dataoptimize" ], "summary": "获取数据优化配置测点列表", "description": "获取数据优化配置测点列表", "parameters": [ { "in": "query", "name": "optimizetype", "description": "填充规则类型。invalid：无效数据填充,其返回格式样例：{data:{Tem1:{attrname:Tem1,mpname:测点温度1,value:[-10,20]}},msg:操作成功,success:true} deletion：缺点数据填充,其返回格式样例：{data:[{attrname:Tem1,mpname:测点温度1,value:[{attrname:Tem2,mpname:温度2},{attrname:Tem3,mpname:温度3}]}],msg:操作成功,success:true}", "required": true, "type": "string" }, { "in": "query", "name": "deviceid", "description": "设备ID", "type": "string" }, { "in": "query", "name": "modelid", "description": "模型ID", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/dataoptimize/rule_state/list": { "get": { "tags": [ "dataoptimize" ], "summary": "获取算法优化策略开启状态", "description": "获取算法优化策略开启状态。包括以下状态字典：deletion_fill_rule(数据缺点填充规则)、deletion_fill_specifypoint(指定测点填充开启状态)、deletion_fill_randompoint(相邻测点填充开启状态)、invalid_fill_rule（无效数据填充规则）、invalid_show_rule(无效数据显示)，以上状态字典值均为1或者0.", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/dataoptimize/rule_state/save": { "post": { "tags": [ "dataoptimize" ], "summary": "设置保存算法优化策略开启状态", "description": "设置保存算法优化策略开启状态。包括以下状态字典：deletion_fill_rule(数据缺点填充规则)、deletion_fill_specifypoint(指定测点填充开启状态)、deletion_fill_randompoint(相邻测点填充开启状态)、invalid_fill_rule（无效数据填充规则）、invalid_show_rule(无效数据显示)，以上状态字典值均为1或者0.", "parameters": [ { "in": "query", "name": "rulecode", "description": "规则代码。deletion_fill_rule(数据缺点填充规则)、deletion_fill_specifypoint(指定测点填充开启状态)、deletion_fill_randompoint(相邻测点填充开启状态)、invalid_fill_rule（无效数据填充规则）、invalid_show_rule(无效数据显示配置)", "required": true, "type": "string" }, { "in": "query", "name": "value", "description": "开启状态。仅支持1（启用）或0（禁用）", "required": true, "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/all": { "get": { "tags": [ "device" ], "summary": "获取所有设备详情信息列表", "description": "获取所有设备详情信息列表。", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/area": { "get": { "tags": [ "device" ] } }, "/device/comboxlist": { "get": { "tags": [ "device" ], "summary": "获取设备简单信息列表", "description": "获取设备简单信息列表。仅返回设备ID和设备名称。", "parameters": [ { "in": "query", "name": "deviceid", "description": "测点所属的设备ID。", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/controlid": { "get": { "tags": [ "device" ] }, "post": { "tags": [ "device" ] } }, "/device/delete": { "post": { "tags": [ "device" ], "summary": "删除设备", "description": "删除设备。同时删除设备关联数据，包括关联的测点、控制点以及历史数据等", "parameters": [ { "in": "query", "name": "deviceid", "description": "测点所属的设备ID。", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/detail": { "get": { "tags": [ "device" ], "summary": "获取指定设备的详情", "description": "获取指定设备的详情，包含设备信息、测点信息、控制点信息", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/echarts_history": { "get": { "tags": [ "device" ], "summary": "历史数据EchartsLine数据获取。按Echarts Line要求格式返回结果。", "description": "历史数据EchartsLine数据获取。按Echarts Line要求格式返回结果。", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "attrnames", "description": "查询条件：模型属性名，多个属性名使用逗号分隔，如Tem1,Tem2,...。attrnames与names不能同时为空", "type": "string" }, { "in": "query", "name": "names", "description": "查询条件：测点名称，多个测点名使用逗号分隔，如触头1,触头2,...。attrnames与names不能同时为空", "type": "string" }, { "in": "query", "name": "starttime", "description": "查询条件：开始日期", "type": "integer", "format": "int64" }, { "in": "query", "name": "endtime", "description": "查询条件：结束日期", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/edit": { "post": { "tags": [ "device" ], "summary": "创建新设备", "description": "创建新设备。需要提交设备基本信息、测点信息以及控制点信息，其中测点信息的控制点信息均为序列化成字符串的JSON对象", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID。编辑设备时必传，否则认为是新建设备", "type": "integer", "format": "int64" }, { "in": "query", "name": "stationid", "description": "变电站ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "modelid", "description": "设备采用的数据模型ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "typeid", "description": "设备类型ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "regionid", "description": "设备所在区域ID。", "type": "integer", "format": "int64" }, { "in": "query", "name": "devicename", "description": "设备名称。", "required": true, "type": "string" }, { "in": "query", "name": "serial", "description": "设备Modbus协议串口号。设备采用串口连接时，必须指定，长度不超过30个字符。", "type": "string" }, { "in": "query", "name": "slaveid", "description": "设备Modbus协议从设备号。设备采用串口连接时，必须指定,仅支持0-255之间的整数值", "type": "integer", "format": "int64" }, { "in": "query", "name": "baudrate", "description": "设备Modbus协议的波特率。设备采用串口连接时，必须指定,支持4800,9600,14400,19200,32000,38400,56000,57600,152000,194000其中之一，默认为9600。", "type": "integer", "format": "int64" }, { "in": "query", "name": "stopbit", "description": "设备Modbus协议的停止位。设备采用串口连接时，必须指定,仅支持1或2，默认为1。", "type": "integer", "format": "int64" }, { "in": "query", "name": "check_bit", "description": "设备Modbus协议的校验位。设备采用串口连接时，必须指定,仅支持N、O、E其中之一，默认为N。", "type": "integer", "format": "int64" }, { "in": "query", "name": "data_bit", "description": "设备Modbus协议的数据位。设备采用串口连接时，必须指定,仅支持5、6、7、8其中之一，默认为8。", "type": "string" }, { "in": "query", "name": "ip", "description": "设备IP协议地址。设备采用网口连接时，必须指定，长度不超过17个字符，格式为xxx.xxx.xxx.xxx。", "type": "string" }, { "in": "query", "name": "port", "description": "设备IP协议端口。设备采用网口连接时，必须指定，仅支持80-65535之间的整数值。", "type": "integer", "format": "int64" }, { "in": "query", "name": "mpinfo_para", "description": "测点信息，采用序列化成字符串的JSON对象", "schema": { "$ref": "#/definitions/JSONString" } }, { "in": "query", "name": "control_para", "description": "测点信息，采用序列化成字符串的JSON对象", "schema": { "$ref": "#/definitions/JSONString" } } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/history": { "get": { "tags": [ "device" ], "summary": "查询设备历史数据列表", "description": "查询设备历史数据列表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "attrname", "description": "查询条件：模型属性名称", "type": "integer", "format": "int64" }, { "in": "query", "name": "starttime", "description": "查询条件：开始日期", "type": "integer", "format": "int64" }, { "in": "query", "name": "endtime", "description": "查询条件：结束日期", "type": "integer", "format": "int64" }, { "in": "query", "name": "mpid", "description": "查询条件：测点ID", "type": "integer", "format": "int64" }, { "in": "query", "name": "pageindex", "description": "当前页码", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "每页记录数", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/lastdata": { "get": { "tags": [ "device" ], "summary": "获取设备最新采集数据", "description": "获取设备最新采集数据。以上数据后台会通过主题/rtelec/runtime/device/data进行发布。前端可订阅该主题。", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID。为空时查询所有设备的最新采集数据", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/lastdata/table": { "get": { "tags": [ "device" ], "summary": "获取设备最新采集数据,以Table展示（分为表头和表体数据）格式返回。以同一模型设备为一组。", "description": "获取设备最新采集数据,以Table展示（分为表头和表体数据）格式返回。以同一模型设备为一组。", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID。为空时查询所有设备的最新采集数据", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/list": { "get": { "tags": [ "device" ], "summary": "查询设备化记录列表", "description": "查询设备记录列表", "parameters": [ { "in": "query", "name": "devicename", "description": "查询条件：设备名称", "type": "string" }, { "in": "query", "name": "regionid", "description": "查询条件：区域ID", "type": "string" }, { "in": "query", "name": "typeid", "description": "查询条件：设备类型ID", "type": "string" }, { "in": "query", "name": "modelid", "description": "查询条件：物模型ID", "type": "string" }, { "in": "query", "name": "pageindex", "description": "当前页码", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "每页记录数", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/model/list": { "get": { "tags": [ "device" ], "summary": "查询设备模型信息列表", "description": "查询设备模型信息列表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID。可以为空，不指定设备ID时将获取所有的模型列表信息", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mp/delete": { "post": { "tags": [ "device" ], "summary": "删除设备的指定测点", "description": "删除设备的指定测点。", "parameters": [ { "in": "query", "name": "deviceid", "description": "测点所属的设备ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpid", "description": "测点ID。未传值时表示删除该设备所有测点", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mp/list": { "get": { "tags": [ "device" ], "summary": "获取设备测点信息列表", "description": "获取设备测点信息列表。仅返回设备ID、测点ID以及测点名称。", "parameters": [ { "in": "query", "name": "deviceid", "description": "测点所属的设备ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "pageindex", "description": "当前页码", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "每页记录数", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mp/mpInfoDetail": { "get": { "tags": [ "device" ], "summary": "获取设备一个测点的详细信息", "description": "获取设备一个测点的详细信息", "parameters": [ { "in": "query", "name": "mpid", "description": "设备测点的id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mp/save": { "post": { "tags": [ "device" ], "summary": "保存设备测点信息", "description": "保存设备测点信息。", "parameters": [ { "in": "query", "name": "deviceid", "description": "测点所属的设备ID。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "modelid", "description": "测点关联的模型ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpid", "description": "测点ID。未传值时表示新增操作", "type": "integer", "format": "int64" }, { "in": "query", "name": "mpname", "description": "测点名称。建议20个字符以内", "required": true, "type": "string" }, { "in": "query", "name": "zonename", "description": "测点所在区域名称", "type": "string" }, { "in": "query", "name": "positionname", "description": "测点所在位置名称", "type": "string" }, { "in": "query", "name": "unit", "description": "测点单位。指该测点采集数据的计量单位。", "type": "string" }, { "in": "query", "name": "attrname", "description": "测点关联的模型属性名称", "required": true, "type": "string" }, { "in": "query", "name": "phase", "description": "测点监测对象的相位。仅为空值、A、B、C、N其中之一。", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mpgroup/list": { "get": { "tags": [ "device" ], "summary": "获取设备分组列表", "description": "获取设备分组列表", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mpgroup/mplist": { "get": { "tags": [ "device" ], "summary": "获取设备测点分组的测点列表", "description": "获取设备测点分组的测点列表", "parameters": [ { "in": "query", "name": "deviceid", "description": "查询条件：设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "groupid", "description": "查询条件：分组ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/mpgroup/save": { "post": { "tags": [ "device" ], "summary": "保存设备测点分组信息", "description": "保存设备测点分组信息", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "groupid", "description": "分组ID。为空或未传时表示新建分组；否则为编辑分组", "type": "integer", "format": "int64" }, { "in": "query", "name": "groupname", "description": "分组名称。", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "mpids", "description": "测点ID列表。多个测点ID使用逗号分隔，测点数量不能超过3个。", "required": true, "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/tree": { "get": { "tags": [ "device" ], "summary": "获取设备列表并以树形数据结构返回", "description": "获取设备列表并以树形数据结构返回。数据格式为: [{id:[节点ID],label:[节点名称],type:[节点类型(root|region|device)],devcount:[挂载设备数量],children:[嵌套子节点]}]。", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/device/type/list": { "get": { "tags": [ "device" ], "summary": "查询设备类型数据列表", "description": "查询设备类型数据列表。仅返回类型ID(id)和名称(type_name)", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/devicealarmsetting/copytactics": { "post": { "tags": [ "devicealarmsetting" ], "summary": "复制一个设备的策略到另外的设备", "description": "复制一个设备的策略到另外的设备", "parameters": [ { "in": "query", "name": "olddeviceid", "description": "旧设备ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "newdeviceid", "description": "新设备ID必传.按逗号分割的字符串", "required": true, "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/devicealarmsetting/delAloneTactics": { "post": { "tags": [ "devicealarmsetting" ], "summary": "删除一个设备的独立策略点", "description": "删除一个设备的独立策略点,会把独立配置的所有的测点的阈值都清除", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID必传.", "required": true, "type": "integer", "format": "int64" } ] } }, "/devicealarmsetting/list": { "get": { "tags": [ "devicealarmsetting" ], "summary": "获取设备策略配置列表", "description": "获取设备策略配置列表。返回获取设备策略配置列表和策略明细信息", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "pageIndex", "description": "分页当前页.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "pageSize", "description": "分页大小.", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/devicealarmsetting/saveAloneTactics": { "post": { "tags": [ "devicealarmsetting" ], "summary": "添加独立策略点", "description": "添加独立策略点。批量提交json格式的字符串[{},{},{}...],大部分字段值可由list获取,只有threshold需要手动填写", "parameters": [ { "in": "query", "name": "alonelist", "description": "json字符串格式", "required": true, "type": "string" }, { "in": "query", "name": "alonelist.deviceid", "description": "设备ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.mpid", "description": "测点ID必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.attrname", "description": "测点属性名必传.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.mpname", "description": "测点名称.", "required": true, "type": "string" }, { "in": "query", "name": "alonelist.alarm_type", "description": "告警类型(1:绝对值,2:升温).", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.alarm_id", "description": "告警策略id.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.upcycle", "description": "当alarm_type=2时需要传此值.", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "alonelist.threshold", "description": "阈值.", "required": true, "type": "number", "format": "float" } ] } }, "/excel/expTableData": { "get": { "tags": [ "excel" ], "summary": "数据导出为Excel", "description": "数据导出为Excel。接口将生成数据文件，并返回文件下载路径。当前支持:device_info、device_mp_info、history-data-opt(自定义日期段历史数据导出)、report-all（导出全部报表）、report-opt(各类型报表导出,需要device_id、reportid、reporttype[1|2|3|4]三个参数)、optimize_invalid_fillrule（导出无效数据填充规则，需要device_id和model_id参数）、optimize_invalid_fillrule（导出缺点数据填充规则，需要device_id和model_id参数）", "parameters": [ { "in": "query", "name": "code", "description": "业务数据类别，由系统定义。当前支持:history-data-opt(自定义日期段历史数据导出)、report-all（导出全部报表）、report-opt(各类型报表导出,需要device_id、reportid、reporttype[1|2|3|4]三个参数)、optimize_invalid_fillrule（导出无效数据填充规则）、optimize_invalid_fillrule（导出缺点数据填充规则）", "required": true, "type": "string" }, { "in": "query", "name": "caption", "description": "数据标题/文件名称，将显示在excel中的第一行。", "type": "string" }, { "in": "query", "name": "expcols", "description": "需要导出的字段名。未设置时按数据结果全部返回。", "type": "string" }, { "in": "query", "name": "expcolnames", "description": "导出字段名对应的中文名称。与导出字段名一一对应", "type": "string" }, { "in": "query", "name": "...paras", "description": "根据业务查询需求，提供相应的参数", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/excel/upload": { "post": { "tags": [ "excel" ], "summary": "将Excel数据导入到指定模块", "description": "将Excel数据导入到指定模块", "parameters": [ { "in": "query", "name": "code", "description": "业务数据类别，由系统定义。当前支持:device_info、device_mp_info、optimize_invalid_fillrule、optimize_deletion_fillrule", "required": true, "type": "string" }, { "in": "query", "name": "file", "description": "文件流参数名", "required": true, "type": "file" }, { "in": "query", "name": "...paras", "description": "根据业务查询需求，提供相应的参数", "type": "string" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/isslog/delete": { "post": { "tags": [ "isslog" ] } }, "/isslog/list": { "get": { "tags": [ "isslog" ] } }, "/linkevent/link_list": { "get": { "tags": [ "linkevent" ] } }, "/linkevent/now": { "get": { "tags": [ "linkevent" ] } }, "/model/get_model_attr": { "get": { "tags": [ "model" ], "summary": "获取指定模型的属性列表", "description": "获取指定模型的属性列表。该模型定义由数据中台管理。", "parameters": [ { "in": "query", "name": "modelid", "description": "数据模型ID。", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "[{object}] ApiOK|ApiError 服务访问成功" }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/model/get_south_model": { "get": { "tags": [ "model" ], "summary": "获取本应用的模型列表", "description": "获取本应用的模型列表。应用使用的模型需要通过业务场景进行配置，否则会返回中台的所有模型。", "responses": { "200": { "description": "[{object}] ApiOK|ApiError 服务访问成功" }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/region/list": { "get": { "tags": [ "region" ], "summary": "查询区域记录列表", "description": "查询区域记录列表", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ApiOK" } }, "500": { "description": "{object} ApiError" } } } }, "/region/station": { "get": { "tags": [ "region" ], "summary": "获取当前变电站信息", "description": "获取当前变电站信息。", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/custmer/list": { "get": { "tags": [ "report" ], "summary": "获取自定义周期内的日报表列表", "description": "获取自定义周期内的日报表列表。建议开始和结束日期范围不超过3个月！", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "s1", "description": "查询条件：开始日期", "required": true, "type": "string" }, { "in": "query", "name": "s2", "description": "查询条件：结束日期", "type": "string" }, { "in": "query", "name": "pageindex", "description": "查询条件：当前页码。默认为1", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "查询条件：每页记录数。默认为20", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/data/list": { "get": { "tags": [ "report" ], "summary": "获取报表数据", "description": "获取报表数据", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "reportid", "description": "查询条件：报表ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "reporttype", "description": "查询条件：报表类型。支持以下：1 年报 2 月报 3 周报 4 日报", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/day/list": { "get": { "tags": [ "report" ], "summary": "获取日报表列表", "description": "获取日报表列表。不指定月时，获取指定年内所有的日报表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "year", "description": "查询条件：年份", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "month", "description": "查询条件：月份", "type": "integer", "format": "int64" }, { "in": "query", "name": "pageindex", "description": "查询条件：当前页码。默认为1", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "查询条件：每页记录数。默认为20", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/device/total": { "get": { "tags": [ "report" ], "summary": "获取设备数量统计信息", "description": "获取设备数量统计信息。包括:总设备数、在线数、离线数、告警数。以上信息每分钟后台会通过主题/rtelec/runtime/device/total进行发布。前端可订阅该主题。", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/maxdata": { "get": { "tags": [ "report" ], "summary": "获取最高数据（温度、湿度、电压等）统计信息", "description": "获取最高数据（温度、湿度、电压等）统计信息。包括:tem(温度、时间、设备名称)对象,hum(湿度、时间、设备名称)对象,vol(电压、时间、设备名称)对象.以上信息后台会通过主题/rtelec/runtime/today/maxdata进行发布。前端可订阅该主题。", "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/month/list": { "get": { "tags": [ "report" ], "summary": "获取月报表列表", "description": "获取月报表列表。不指定月份时，获取指定年内所有的月报表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "year", "description": "查询条件：年份", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "month", "description": "查询条件：月份", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/mutil_mp/comp": { "get": { "tags": [ "report" ], "summary": "多测点对比数据查询", "description": "多测点对比数据查询", "parameters": [ { "in": "query", "name": "mplist", "description": "对比的测点列表。测点格式为：设备ID.测点属性名(如123.tem1)。多个测点之间使用逗号分隔。", "required": true, "type": "string" }, { "in": "query", "name": "startdate", "description": "数据查询开始日期", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "enddate", "description": "数据查询结束日期", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/mutil_mp/echarts_data": { "get": { "tags": [ "report" ], "summary": "多测点对比Echarts Line数据查询。按Echarts Line要格式要求返回数据。", "description": "多测点对比Echarts Line数据查询按Echarts Line要格式要求返回数据。", "parameters": [ { "in": "query", "name": "mplist", "description": "对比的测点列表。测点格式为：设备ID.测点属性名(如123.tem1)。多个测点之间使用逗号分隔。", "required": true, "type": "string" }, { "in": "query", "name": "startdate", "description": "数据查询开始日期", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "enddate", "description": "数据查询结束日期", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/week/list": { "get": { "tags": [ "report" ], "summary": "获取周报表列表", "description": "获取周报表列表。不指定周时，获取指定年内所有的周报表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "year", "description": "查询条件：年份", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "week", "description": "查询条件：周", "type": "integer", "format": "int64" }, { "in": "query", "name": "pageindex", "description": "查询条件：当前页码。默认为1", "type": "integer", "format": "int64" }, { "in": "query", "name": "pagesize", "description": "查询条件：每页记录数。默认为20", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/report/year/list": { "get": { "tags": [ "report" ], "summary": "获取年报表列表", "description": "获取年报表列表。不指定年份时，获取所有的年报表。", "parameters": [ { "in": "query", "name": "deviceid", "description": "设备ID", "required": true, "type": "integer", "format": "int64" }, { "in": "query", "name": "year", "description": "查询条件：年份", "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "服务访问成功", "schema": { "$ref": "#/definitions/ApiOK|ApiError" } }, "401": { "description": "status 认证未通过，一般是未指定token或token已失效" }, "500": { "description": "status 服务器｜后台发生错误" } } } }, "/scene/addrelation": { "post": { "tags": [ "scene" ] } }, "/scene/delrelation": { "post": { "tags": [ "scene" ] } }, "/scene/getListBySceneName": { "post": { "tags": [ "scene" ] } }, "/scene/getScencList": { "post": { "tags": [ "scene" ] } }, "/scene/updateScene": { "post": { "tags": [ "scene" ] } }, "/task/delete": { "post": { "tags": [ "task" ] } }, "/task/edit": { "post": { "tags": [ "task" ] } }, "/task/list": { "get": { "tags": [ "task" ] } }, "/task/pause": { "post": { "tags": [ "task" ] } }, "/wechat/api/app/chat": { "get": { "tags": [ "wechat" ] }, "post": { "tags": [ "wechat" ] } }, "/wechat/api/common/weixindevapply": { "get": { "tags": [ "wechat" ] }, "post": { "tags": [ "wechat" ] } }, "/wechat/api/wechat/message/push": { "get": { "tags": [ "wechat" ] }, "post": { "tags": [ "wechat" ] } }, "/wechat/api/wechat/r/chat": { "get": { "tags": [ "wechat" ] }, "post": { "tags": [ "wechat" ] } }, "/wechat/api/wechat/user/get": { "get": { "tags": [ "wechat" ] }, "post": { "tags": [ "wechat" ] } } }, "definitions": { "ApiError": { "title": "ApiError", "type": "object" }, "ApiOK": { "title": "ApiOK", "type": "object" }, "ApiOK|ApiError": { "title": "ApiOK|ApiError", "type": "object" }, "JSONString": { "title": "JSONString", "type": "object" } }, "tags": [ { "name": "base", "description": "基础功能服务\n" }, { "name": "excel", "description": "Excel相关服务\n" }, { "name": "file", "description": "文件下载相关服务\n" }, { "name": "alarm", "description": "告警相关服务\n" }, { "name": "comand", "description": "指令控制相关服务\n" }, { "name": "dataoptimize", "description": "数据优化相关服务\n" }, { "name": "device", "description": "设备管理相关服务\n" }, { "name": "isslog", "description": "ISS日志相关服务\n" }, { "name": "linkevent", "description": "联动管理相关服务\n" }, { "name": "model", "description": "物模型相关服务\n" }, { "name": "scene", "description": "业务场景模块相关服务\n" }, { "name": "task", "description": "计划任务相关服务\n" }, { "name": "region", "description": "区域管理相关服务\n" }, { "name": "app", "description": "应用管理服务控制器\n" }, { "name": "report", "description": "数据统计报表相关服务\n" }, { "name": "blacklist", "description": "告警配置黑名单控制器\n" } ] }