1. MIX.IOT.2018.F.11.22-APIQ API

1.1. 文档说明

智物联《物联网基础平台MIXIOT》(以下简称:MIXIOT)包括数十个子系统与服务,为不同子系统之间通信与数据交互提供支持,在MIXIOT的基础上,通过HTTP协议提供低频数据接口APIQ。

1.2. 适用对象

本文档适用人员范围:MIXIOT平台开发、运维、测试、交付等所有使用人员。

1.3. 请求地址

HOST:http://xxx.com/path/(具体以系统部署地址为准) 请求地址:HOST +下文接口中的url

1.4. 请求说明

固定传参

在 http header 中传入参数,该参数来源于用户登录后获得到的验证信息,用于鉴权

参考

Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

1.5. 响应说明

所有响应都提供了遵循如下响应规则,在后面的响应说明中不再做出说明

状态码说明:

code 含义
500 错误
200 执行成功

1.6. 接口定义

1.6.1. 登录与授权

1.6.1.1. Login(登录)

调用接口:

属性
url /api/login
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
username 登录账户 String 登录账户:用户名
password 登录密码 String
system 登录系统 String PRO系统标识:PRO或者MixPro

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "登录成功",
    "result": {
        "user_id": 998,
        "username": "admin",
        "system": "PRO",
        "is_super": 1,
        "description": "超级管理员",
        "mobile": "1382140445",
        "email": "admin@mixlinker.com",
        "address": "深圳市宝安区隆昌路10号美生创谷春谷三楼",
        "created": "2018-09-28 15:01:27",
        "token": "0Lq8CeAvxQYVgVsrOWeNRTYSenOyqH12"
    }
}

备注:

若无特殊说明,其他接口鉴权时 需要将token通过http请求头 header发送以下数据鉴权($token表示登录返回的token数据):

Authorization:Bearer $token

1.6.1.2. APP Login(APP登录)

调用接口:

属性
url /api/app/login
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
username 登录账户 String 登录账户:手机号
password 登录密码 String
system 登录系统 String APP系统标识:APP

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "登录成功",
    "result": {
        "user_id": 998,
        "username": "admin",
        "system": "PRO",
        "is_super": 1,
        "description": "超级管理员",
        "mobile": "1382140445",
        "email": "admin@mixlinker.com",
        "address": "深圳市宝安区隆昌路10号美生创谷春谷三楼",
        "created": "2018-09-28 15:01:27",
        "token": "0Lq8CeAvxQYVgVsrOWeNRTYSenOyqH12"
    }
}

备注:

APP Login(APP登录)接口 与 2.1.1Login(登录)接口一样提供用户登录;区别是APP通过手机号登陆,ADMIN和PRO等通过用户名登录。

新版本中, 2.1.1Login(登录)已支持手机号登录,建议APP也通过2.1.1Login(登录)登录。

1.6.1.3. CheckTicket(票据校验)

调用接口:

属性
url /api/check_ticket
http方法 post
Content-Type application/json或application/x-www-form-urlencoded
备注 CheckTicket接口无需鉴权

请求参数:

字段 字段名称 字段类型 说明 是否必传
source 系统标识 String
ticket 票据(令牌) String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 400:失败 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "user_id": 1001,
        "username": "admin",
        "is_super": 1,
        "description": "超级管理员",
        "mobile": "13800138000",
        "email": "admin@mixlinker.com",
        "address": "深圳市美声创谷春谷3楼-智物联网络有限公司",
        "created": "2018-10-18 16:44:17"
    }
}

备注:

CheckTicket接口提供单点登录鉴权,非单点登录时通过Login接口登录。

1.6.1.4. User(当前用户信息)

调用接口:

属性
url /api/user
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
- - - - -

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "user_id": 1001,
        "username": "admin",
        "is_super": 1,
        "description": "超级管理员",
        "mobile": "13800138000",
        "email": "admin@mixlinker.com",
        "address": "深圳市美声创谷春谷3楼-智物联网络有限公司",
        "created": "2018-10-18 16:44:17"
    }
}

1.6.1.5. ResetPassword(更改密码)

调用接口:

属性
url /api/user/reset_password
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
old_password 旧密码 String
new_password 新密码 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "修改成功",
    "result": []
}

1.6.1.6. Upload(附件上传)

调用接口:

属性
url /api/file/upload
http方法 post
Content-Type multipart/form-data

请求参数:

字段 字段名称 字段类型 说明 是否必传
upload_file 文件 File
type 上传类型 String 作业:activity 服务:service 设备:equipment

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "上传成功",
    "result": {
        "path": "equipment/2018/11/fangkuaizutaitu.gif"
    }
}

1.6.1.7. Download(附件下载)

调用接口:

属性
url /api/file/download
http方法 get
Content-Type
备注 Download接口无需鉴权

请求参数:

字段 字段名称 字段类型 说明 是否必传
path 文件路径 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 500,
    "msg": "文件不存在",
    "result": []
}

备注:

下载成功时,直接返回输出文件流;下载失败时,返回状态码和提示信息。

1.6.2. Activity(作业)

1.6.2.1. 查询(关注设备或关注客户或无设备ID)详细列表

调用接口:

属性
url /api/activity/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["activity_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "activity_id": 1001,
                "activity_name": "日常作业",
                "date": "2018-12-07 12:30:00",
                "category": "",
                "description": null,
                "customer_id": 1001,
                "equipment_id": 1001,
                "staff": "",
                "attachment": "",
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-12-07 12:30:00",
                "is_available": 1
            }
        ]
    }
}

1.6.2.2. 查询指定记录

调用接口:

属性
url /api/activity/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
activity_id 作业标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "activity_id": 1001,
        "activity_name": "日常作业",
        "date": "2018-12-07 12:30:00",
        "category": "",
        "description": null,
        "customer_id": 1001,
        "equipment_id": 1001,
        "staff": "",
        "attachment": "",
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-12-07 12:30:00",
        "is_available": 1
    }
}

1.6.2.3. 查询(关注设备或关注客户或无设备ID)下拉列表

调用接口:

属性
url /api/activity/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 3,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "activity_id": 1001,
                "activity_name": "日常作业",
                "date": "2018-12-07 12:30:00",
                "created": "2018-12-07 12:30:00"
            }
        ]
    }
}

1.6.2.4. 查询(关注设备)详细列表(EXP使用)

调用接口:

属性
url /api/exp/activity/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.2.5. 查询(关注设备)下拉列表(EXP使用)

调用接口:

属性
url /api/exp/activity/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.2.6. 添加activity

调用接口:

属性
url /api/activity/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
activity_name 作业名称 String
date 作业时间 datetime
category 作业类型 String
description 描述 Text
customer_id 客户标识 String
equipment_id 设备标识 String
staff 服务人员 String
attachment 服务附件路径 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.2.7. 编辑activity

调用接口:

属性
url /api/activity/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
activity_id 作业标识 String
activity_name 作业名称 String
date 作业时间 datetime
category 作业类型 String
description 描述 Text
customer_id 客户标识 String
staff 服务人员 String
attachment 服务附件路径 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.2.8. 删除activity

调用接口:

属性
url /api/activity/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
activity_id 作业标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.3. Alert(报警)

1.6.3.1. 查询(关注设备或无设备ID)详细列表

调用接口:

属性
url /api/alert/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["alert_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "alert_id": 1002,
                "code": "9527",
                "alert_name": "锅炉过热",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:锅炉过热",
                "aprus_id": "A22018083100002",
                "equipment_id": 1001,
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-09-11 17:03:07",
                "is_available": 1
            },
            {
                "alert_id": 1001,
                "code": "2514",
                "alert_name": "油分器堵塞",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞",
                "aprus_id": "A22018083100002",
                "equipment_id": 1002,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-01 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.3.2. 查询指定记录

调用接口:

属性
url /api/alert/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
alert_id 报警标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "alert_id": 1001,
        "code": "2514",
        "alert_name": "油分器堵塞",
        "description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞",
        "aprus_id": "A22018083100002",
        "equipment_id": 1002,
        "template": "",
        "script": "",
        "reference": "",
        "created": "2018-09-01 15:43:32",
        "is_available": 1
    }
}

1.6.3.3. 查询(关注设备或无设备ID)下拉列表

调用接口:

属性
url /api/alert/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "alert_id": 1002,
                "alert_name": "锅炉过热",
                "equipment_id": 1001,
                "created": "2018-09-11 17:03:07"
            },
            {
                "alert_id": 1001,
                "alert_name": "油分器堵塞",
                "equipment_id": 1002,
                "created": "2018-09-01 15:43:32"
            }
        ]
    }
}

1.6.3.4. 查询(关注设备)详细列表(EXP使用)

调用接口:

属性
url /api/exp/alert/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.3.5. 查询(关注设备)下拉列表(EXP使用)

调用接口:

属性
url /api/exp/alert/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.3.6. 添加alert

调用接口:

属性
url /api/alert/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
alert_name 报警代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.3.7. 编辑alert

调用接口:

属性
url /api/alert/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
alert_id 报警标识 String
alert_name 报警代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.3.8. 删除alert

调用接口:

属性
url /api/alert/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
alert_id 报警标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.4. AlertMosaic(报警挂板)

1.6.4.1. 查询AlertMosaic详细列表

调用接口:

属性
url /api/alert_mosaic/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["equipment_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [{
            "equipment_id": 1007,
            "alert_mosaic": {
                "7603 ": ["1002 ", "减速过电流 "]
            },
            "template": "",
            "script": "",
            "reference": "",
            "created": "2018-09-11 16:54:13",
            "is_available": 1
        }, {
            "equipment_id": 1005,
            "alert_mosaic": {
                "7493 ": ["1001 ", "速度反馈错误 "]
            },
            "template": "",
            "script": "",
            "reference": "",
            "created": "2018-09-11 16:52:04",
            "is_available": 1
        }]
    }
}

1.6.4.2. 查询AlertMosaic指定记录

调用接口:

属性
url /api/alert_mosaic/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "equipment_id": 1007,
        "alert_mosaic": {
            "7603": [
                "1002",
                "减速过电流"
            ]
        },
        "template": "",
        "script": "",
        "reference": "",
        "created": "2018-09-11 16:54:13",
        "is_available": 1
    }
}

1.6.4.3. 查询AlertMosaic指定设备挂板列表

调用接口:

属性
url /api/alert_mosaic/get_list_by_equipment
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "alert_id": 1001,
                "code": "2514",
                "alert_name": "油分器堵塞",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞",
                "aprus_id": "A22018083100002",
                "equipment_id": 1002,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-01 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.4.4. 查询AlertMosaic关注设备挂板列表

调用接口:

属性
url /api/alert_mosaic/get_list_by_user
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "alert_id": 1001,
                "code": "2514",
                "alert_name": "油分器堵塞",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞",
                "aprus_id": "A22018083100002",
                "equipment_id": 1002,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-01 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.4.5. 添加AlertMosaic

调用接口:

属性
url /api/alert_mosaic/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
alert_mosaic 告警标识集合 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.4.6. 编辑AlertMosaic

调用接口:

属性
url /api/alert_mosaic/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
alert_mosaic 告警标识集合 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.4.7. 删除AlertMosaic

调用接口:

属性
url /api/alert_mosaic/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.5. Aprus(适配器)

1.6.5.1. 查询Aprus详细列表

调用接口:

属性
url /api/aprus/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["aprus_id", "like", "fidiser"], ["aprus_name", "=", "专用适配器"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "aprus_id": "A201812060003",
                "aprus_name": "空压机-0766",
                "access": "pub",
                "topic": "r,a,v,p,i,n,d",
                "description": "无",
                "maker": "智物联",
                "config_id": 1002,
                "codebase_id": 1001,
                "nominal": null,
                "activated": "2018-08-31 16:37:39",
                "type": "2",
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-08-31 16:37:39",
                "is_available": 1
            }
        ]
    }
}

1.6.5.2. 查询Aprus指定记录

调用接口:

属性
url /api/aprus/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
aprus_id 适配器标识 String 适配器标识

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "aprus_id": "A201812060003",
        "aprus_name": "空压机-0766",
        "access": "pub",
        "topic": "r,a,v,p,i,n,d",
        "description": "无",
        "maker": "智物联",
        "config_id": 1002,
        "codebase_id": 1001,
        "nominal": null,
        "activated": "2018-08-31 16:37:39",
        "type": "2",
        "template": null,
        "script": null,
        "reference": null,
        "created": "2018-08-31 16:37:39",
        "is_available": 1
    }
}

1.6.5.3. 添加Aprus

调用接口:

属性
url /api/aprus/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
aprus_id 适配器标识 String
aprus_name 适配器名称 String
description 描述 Text
username 鉴权用户名 String
pin 鉴权验证码 String
access 报文权限 String 单选:all,pub,sub
topic 报文主题 String 多选: all:all pub:r,a,v,p,i,n sub:g/#
maker 生产厂家 String
config_id 适配器配置标识 String 对应config表
codebase_id 代码库 String 对应codebase
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.5.4. 编辑Aprus

调用接口:

属性
url /api/customer/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
aprus_id 适配器标识 String
aprus_name 适配器名称 String
description 描述 Text
username 鉴权用户名 String
pin 鉴权验证码 String
access 报文权限 String 单选:all,pub,sub
topic 报文主题 String 多选: all:all pub:r,a,v,p,i,n sub:g/#
description 描述 text
maker 生产厂家 String
config_id 适配器配置标识 String 对应config表
codebase_id 代码库 String 对应codebase
nominal 公称名义 String 不可编辑
activated 激活时间 datetime 不可编辑
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.5.5. 删除Aprus

调用接口:

属性
url /api/aprus/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
aprus_id 适配器标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.6. Codebase(代码库)

1.6.6.1. 查询Codebase详细列表

调用接口:

属性
url /api/codebase/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["codebase_id", "like", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "codebase_id": 1001,
                "codebase_name": "1号机组",
                "description": "",
                "template": "[]",
                "script": "[]",
                "reference": "",
                "created": "2018-09-18 18:03:26",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.6.2. 查询Codebase指定记录

调用接口:

属性
url /api/codebase/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
codebase_id 代码库标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "customer_id": 1001,
        "customer_name": "智物联",
        "description": "智物联-物联网平台",
        "secret": "5JHC",
        "exp_id": "zhiwulian.exp",
        "province": "广东省",
        "city": "深圳市",
        "address": "美声创谷春谷",
        "phone": "075523740592",
        "contact": "admin",
        "mobile": "13800138000",
        "email": "admin.mixlinker.com",
        "template": "",
        "script": "",
        "reference": "",
        "created": "2018-09-18 17:42:50"
    }
}

1.6.6.3. 添加Codebase

调用接口:

属性
url /api/codebase/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
codebase_name 代码库名称 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.6.4. 编辑Codebase

调用接口:

属性
url /api/codebase/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
codebase_id 代码库标识 String
codebase_name 代码库名称 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.6.5. 删除Codebase

调用接口:

属性
url /api/codebase/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
codebase_id 代码库标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.7. Collect(离线数据类型)

1.6.7.1. 查询Collect详细列表

调用接口:

属性
url /api/collect/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["event_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "collect_id": "pressure",
                "collect_name": "压力",
                "instrument": "压力计",
                "unit": "Mpa",
                "description": null,
                "default_value": "0",
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-18 20:04:33",
                "is_available": 1,
                "boss_sync": 0
            },
            {
                "collect_id": "temperature",
                "collect_name": "温度",
                "instrument": "温度计",
                "unit": "摄氏度",
                "description": null,
                "default_value": "0",
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-09-05 17:25:53",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.7.2. 查询Collect指定记录

调用接口:

属性
url /api/collect/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collect_id 数据采集标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "collect_id": "temperature",
        "collect_name": "温度",
        "instrument": "温度计",
        "unit": "摄氏度",
        "description": null,
        "default_value": "0",
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-09-05 17:25:53",
        "is_available": 1,
        "boss_sync": 0
    }
}

1.6.7.3. 查询Collect下拉列表

调用接口:

属性
url /api/collect/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "collect_id": "pressure",
                "collect_name": "压力",
                "unit": "Mpa"
            },
            {
                "collect_id": "temperature",
                "collect_name": "温度",
                "unit": "摄氏度"
            }
        ]
    }
}

1.6.7.4. 添加Collect

调用接口:

属性
url /api/collect/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collect_id 数据采集标识 String
collect_name 数据采集类型名称 String
instrument 记录仪器 String
unit 数据单位 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.7.5. 编辑Collect

调用接口:

属性
url /api/collect/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collect_id 数据采集标识 String
collect_name 数据采集类型名称 String
instrument 记录仪器 String
unit 数据单位 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.7.6. 删除Collect

调用接口:

属性
url /api/collect/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collect_id 数据采集标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.8. Collectos(离线数据结果)

1.6.8.1. 查询Collectos详细列表

调用接口:

属性
url /api/collectos/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["collectos_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "collectos_id": 1001,
                "collectos_name": "temperature",
                "description": null,
                "collect_id": "temperature",
                "equipment_id": 1004,
                "data": "25",
                "collectos_file": "",
                "collector": "",
                "collect_time": "2018-11-23 18:43:30",
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-11-23 18:43:30",
                "is_available": 1,
                "boss_sync": 0,
                "collect_name": "温度",
                "unit": "℃"
            }
        ]
    }
}

1.6.8.2. 查询Collectos指定记录

调用接口:

属性
url /api/collectos/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collectos_id 消息标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "collectos_id": 1001,
        "collectos_name": "temperature",
        "description": null,
        "collect_id": "temperature",
        "equipment_id": 1004,
        "data": "25",
        "collectos_file": "",
        "collector": "",
        "collect_time": "2018-11-23 18:43:30",
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-11-23 18:43:30",
        "is_available": 1,
        "boss_sync": 0,
        "collect_name": "温度",
        "unit": "℃"
    }
}

1.6.8.3. 查询Collectos下拉列表

调用接口:

属性
url /api/collectos/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "collectos_id": 1001,
                "collectos_name": "temperature"
            }
        ]
    }
}

1.6.8.4. 添加Collectos

调用接口:

属性
url /api/collectos/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collectos_name 采集结果名称 String
description 描述 Text
collect_id 采集类型标识 String
equipment_id 设备标识 String
data 采集数据 text
collectos_file 附件路径 String
collector 采集人员 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.8.5. 编辑Collectos

调用接口:

属性
url /api/collectos/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collectos_id 采集结果标识 String
collectos_name 采集结果名称 String
description 描述 Text
collect_id 采集类型标识 String
equipment_id 设备标识 String
data 采集数据 text
collectos_file 附件路径 String
collector 采集人员 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.8.6. 删除Collectos

调用接口:

属性
url /api/collectos/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
collectos_id 消息标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.9. Common(公共接口)

1.6.9.1. 查询故障、报警、事件-详细列表

调用接口:

属性
url /api/common/get_all_warn
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_group 是否查询设备组 Boolean 不传则返回所有数据; 值为1则只返回设备组数据; 值为0则只返回设备数据

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "id": 1002,
                "name": "锅炉过热",
                "type": "alert",
                "type_name": "报警",
                "code": "9527",
                "aprus_id": "A22018083100002",
                "equipment_id": 1001,
                "equipment_name": "pro+测试设备",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:锅炉过热",
                "created": "2018-09-11 17:03:07",
                "is_available": 1
            }
        ]
    }
}

1.6.10. Config(适配器配置)

1.6.10.1. 查询Config详细列表

调用接口:

属性
url /api/config/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", ${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["config_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "customer_id": 1001,
                "customer_name": "智物联",
                "description": "智物联-物联网平台",
                "secret": "5JHC",
                "exp_id": "zhiwulian.exp",
                "province": "广东省",
                "city": "深圳市",
                "address": "美声创谷春谷",
                "phone": "075523740592",
                "contact": "admin",
                "mobile": "13800138000",
                "email": "admin.mixlinker.com",
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-18 17:42:50"
            }
        ]
    }
}

1.6.10.2. 查询Config指定记录

调用接口:

属性
url /api/config/get
http方法 post

请求参数:

字段 字段名称 字段类型 说明 是否必传
config_id 适配器配置标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
data 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "config_id": 1001,
                "config_name": "空压机配置",
                "description": null,
                "hardware": null,
                "mcu_file": null,
                "mcu_version": null,
                "remosu_file": null,
                "remosu_version": null,
                "lua_file": null,
                "lua_version": null,
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-20 22:14:41",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.10.3. 添加Config

调用接口:

属性
url /api/config/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
config_name 适配器配置名称 String
description 描述 Text
firmware 硬件版本号 String
mcu_file mcu文件路径 String
mcu_version muc版本号 String
lua_file lua程序文件路径 String
lua_version lua版本号 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.10.4. 编辑Config

调用接口:

属性
url /api/config/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
config_id 适配器配置标识 String
config_name 适配器配置名称 String
description 描述 Text
firmware 硬件版本号 String
mcu_file mcu文件路径 String
mcu_version muc版本号 String
lua_file lua程序文件路径 String
lua_version lua版本号 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.10.5. 删除Config

调用接口:

属性
url /api/config/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
config_id 适配器配置标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.11. Customer(客户)

1.6.11.1. 查询Customer关注客户列表

调用接口:

属性
url /api/customer/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

其中,运算符为MySQL比较运算符,支持一下几种:

运算符 含义
= 等于
> 大于
\< 小于
>= 大于等于
\<= 小于等于
!=或\<> 不等于
LIKE或like 包含

举例

[["customer_id", "=", "1001"], ["customer_name", "LIKE", "智物联"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "customer_id": 1001,
                "customer_name": "智物联",
                "description": "智物联-物联网平台",
                "secret": "5JHC",
                "exp_id": "zhiwulian.exp",
                "province": "广东省",
                "city": "深圳市",
                "address": "美声创谷春谷",
                "phone": "075523740592",
                "contact": "admin",
                "mobile": "13800138000",
                "email": "admin.mixlinker.com",
                "template": null
                "script": null,
                "reference": null,
                "created": "2018-09-18 17:42:50"
            }
        ]
    }
}

1.6.11.2. 所有客户列表

调用接口:

属性
url /api/customer/get_all_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["customer_id", "=", "1001"], ["customer_name", "LIKE", "智物联"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "customer_id": 1001,
                "customer_name": "智物联",
                "description": "智物联-物联网平台",
                "secret": "5JHC",
                "exp_id": "zhiwulian.exp",
                "province": "广东省",
                "city": "深圳市",
                "address": "美声创谷春谷",
                "phone": "075523740592",
                "contact": "admin",
                "mobile": "13800138000",
                "email": "admin.mixlinker.com",
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-18 17:42:50"
            }
        ]
    }
}

1.6.11.3. 指定记录

调用接口:

属性
url /api/customer/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
customer_id 客户标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "customer_id": 1001,
        "customer_name": "智物联",
        "description": "智物联-物联网平台",
        "secret": "5JHC",
        "exp_id": "zhiwulian.exp",
        "province": "广东省",
        "city": "深圳市",
        "address": "美声创谷春谷",
        "phone": "075523740592",
        "contact": "admin",
        "mobile": "13800138000",
        "email": "admin.mixlinker.com",
        "template": "",
        "script": "",
        "reference": "",
        "created": "2018-09-18 17:42:50"
    }
}

1.6.11.4. 客户下拉列表

调用接口:

属性
url /api/customer/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{ "code": 200, "msg": "查询成功", "result": { "data": [ { "customer_id": 1001, "customer_name": "智物联", "created": "2018-09-18 17:42:50" }, { "customer_id": 1002, "customer_name": "深海捷", "created": "2018-11-18 17:42:50" } ] } }

1.6.11.5. EXP下拉列表

调用接口:

属性
url /api/customer/get_exp_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{ "code": 200, "msg": "查询成功", "result": [ { "exp_id": "develop.exp", "exp_name": "智物联" } ] }

1.6.11.6. 添加Customer

调用接口:

属性
url /api/customer/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
customer_name 客户名称 String
description 描述 Text
secret 管理密码 String
exp_id EXP标识 String
province 省份 String
city 城市/地区 String
address 地址 String
phone 电话 String
contact 联系人 String
mobile 联系人手机 String
email 邮箱 String
template 模板/样式 Text
script 脚本 Text
reference 参考号 String
is_available 是否有效 Boolean

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.11.7. 编辑Customer

调用接口:

属性
url /api/customer/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
customer_id 客户标识 String
customer_name 客户名称 String
description 描述 Text
secret 管理密码 String
exp_id EXP标识 String
province 省份 String
city 城市/地区 String
address 地址 String
phone 电话 String
contact 联系人 String
mobile 联系人手机 String
email 邮箱 String
template 模板/样式 Text
script 脚本 Text
reference 参考号 String
is_available 是否有效 Boolean

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.11.8. 删除Customer

调用接口:

属性
url /api/customer/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
customer_id 客户标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.12. Dashboard(显示板)

1.6.12.1. 查询Dashboard详细列表

调用接口:

属性
url /api/dashboard/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["dashboard_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "dashboard_id": 1003,
                "dashboard_name": "设备大屏模板",
                "description": "",
                "template": "[]",
                "script": "[]",
                "mixshow": "[]",
                "exp": "[]",
                "reference": "",
                "created": "2018-10-17 13:59:21",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.12.2. 查询Dashboard指定记录

调用接口:

属性
url /api/dashboard/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
dashboard_id 显示板标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "dashboard_id": 1003,
        "dashboard_name": "设备大屏模板",
        "description": "",
        "template": "[]",
        "script": "[]",
        "mixshow": "[]",
        "exp": "[]",
        "reference": "",
        "created": "2018-10-17 13:59:21",
        "is_available": 1,
        "boss_sync": 0
    }
}

1.6.12.3. 添加Dashboard

调用接口:

属性
url /api/dashboard/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
dashboard_name 显示板名称 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

|--------|----------|----------|---------------------|------------| | 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 | | code | 返回码 | Integer | 200:成功 500:失败 | 是 | | msg | 提示信息 | String | | 是 | | result | 返回结果 | Json | | 是 | | |

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.12.4. 编辑Dashboard

调用接口:

属性
url /api/dashboard/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
dashboard_id 显示板标识 String
dashboard_name 显示板名称 String
description 描述 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.12.5. 删除Dashboard

调用接口:

属性
url /api/dashboard/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
dashboard_id 显示板标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.13. Datasheet(数据表)

1.6.13.1. 查询Datasheet详细列表

调用接口:

属性
url /api/datasheet/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["key", "operator", "value"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["datasheet_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "datasheet_id": 1002,
                "datasheet_name": "深海捷",
                "description": null,
                "file": null,
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-20 20:18:48",
                "is_available": 1,
                "boss_sync": 0
            },
            {
                "datasheet_id": 1001,
                "datasheet_name": "智物联",
                "description": null,
                "file": null,
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-09-18 19:46:47",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.13.2. 查询Datasheet指定记录

调用接口:

属性
url /api/datasheet/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
datasheet_id 数据表标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "datasheet_id": 1002,
        "datasheet_name": "深海捷",
        "description": null,
        "file": null,
        "template": null,
        "script": null,
        "reference": null,
        "created": "2018-09-20 20:18:48",
        "is_available": 1,
        "boss_sync": 0
    }
}

1.6.13.3. 添加Datasheet

调用接口:

属性
url /api/datasheet/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
datasheet_name 数据表名称 String
description 描述 Text
file 数据表文件路径
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.13.4. 编辑Datasheet

调用接口:

属性
url /api/datasheet/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
datasheet_id 数据表标识 String
datasheet_name 数据表名称 String
description 描述 Text
file 数据表文件路径
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.13.5. 删除Datasheet

调用接口:

属性
url /api/datasheet/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
datasheet_id 数据表标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.14. Equipment(设备)

1.6.14.1. 查询Equipment关注设备列表

调用接口:

属性
url /api/equipment/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"

举例

[["equipment_id", "=", "1001"]]

返回参数:

|--------|----------|----------|---------------------|------------| | 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 | | code | 返回码 | Integer | 200:成功 500:失败 | 是 | | msg | 提示信息 | String | | 是 | | result | 结果 | Json | | 是 | | |

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [{
            "equipment_id": 1005,
            "equipment_name": "设备5",
            "description": "设备5",
            "customer_id": 1003,
            "equipment_sn": "1001",
            "model": "设备5",
            "type_id": null,
            "camera_list": "设备5",
            "is_group": 0,
            "camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com",
            "datasheet_id": null,
            "aprus_list": [" A22018083100003 ", "A22018083100002"],
            "mapping_id": 1003,
            "gis": "",
            "secret": "DZHR",
            "auth_code": null,
            "equipment_image": "equipment/2018/09/Desert_VJR97.jpg",
            "addition": [{
                "title ": "基本信息 ",
                "data ": [
                    ["生产厂家 ", ""],
                    ["锅炉吨位 ", "10 吨 "],
                    ["设备尺寸 ", ""],
                    ["设备重量 ", ""],
                    ["制造日期 ", ""],
                    ["启用日期 ", ""]
                ]
            }],
            "template": null,
            "script": null,
            "reference": null,
            "created": "2018-08-3018:24:19",
            "is_available": 1,
            "boss_sync": 0,
            "customer_name": "test",
            "status_code": 0,
            "status_name": "停止"
        }]
    }
}

1.6.14.2. 查询Equipment所有设备列表

调用接口:

属性
url /api/equipment/get_all_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["equipment_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [{
            "equipment_id": 1005,
            "equipment_name": "设备5",
            "description": "设备5",
            "customer_id": 1003,
            "equipment_sn": "1001",
            "model": "设备5",
            "type_id": null,
            "camera_list": "设备5",
            "is_group": 0,
            "camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com",
            "datasheet_id": null,
            "aprus_list": [" A22018083100003 ", "A22018083100002"],
            "mapping_id": 1003,
            "gis": "",
            "secret": "DZHR",
            "auth_code": null,
            "equipment_image": "equipment/2018/09/Desert_VJR97.jpg",
            "addition": [{
                "title ": "基本信息 ",
                "data ": [
                    ["生产厂家 ", ""],
                    ["锅炉吨位 ", "10 吨 "],
                    ["设备尺寸 ", ""],
                    ["设备重量 ", ""],
                    ["制造日期 ", ""],
                    ["启用日期 ", ""]
                ]
            }],
            "template": null,
            "script": null,
            "reference": null,
            "created": "2018-08-3018:24:19",
            "is_available": 1,
            "boss_sync": 0,
            "customer_name": "test",
            "status_code": 0,
            "status_name": "停止"
        }]
    }
}

1.6.14.3. 查询Equipment指定记录

调用接口:

属性
url /api/equipment/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [{
            "equipment_id": 1005,
            "equipment_name": "设备5",
            "description": "设备5",
            "customer_id": 1003,
            "equipment_sn": "1001",
            "model": "设备5",
            "type_id": null,
            "camera_list": "设备5",
            "is_group": 0,
            "camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com",
            "datasheet_id": null,
            "aprus_list": [" A22018083100003 ", "A22018083100002"],
            "mapping_id": 1003,
            "gis": "",
            "secret": "DZHR",
            "auth_code": null,
            "equipment_image": "equipment/2018/09/Desert_VJR97.jpg",
            "addition": [{
                "title ": "基本信息 ",
                "data ": [
                    ["生产厂家 ", ""],
                    ["锅炉吨位 ", "10 吨 "],
                    ["设备尺寸 ", ""],
                    ["设备重量 ", ""],
                    ["制造日期 ", ""],
                    ["启用日期 ", ""]
                ]
            }],
            "template": null,
            "script": null,
            "reference": null,
            "created": "2018-08-3018:24:19",
            "is_available": 1,
            "boss_sync": 0,
            "customer_name": "test",
            "status_code": 0,
            "status_name": "停止"
        }]
    }
}

1.6.14.4. 查询Equipment关注设备下拉列表

调用接口:

属性
url /api/equipment/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 5,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "equipment_id": 1004,
                "equipment_name": "智物联设备"
            },
            {
                "equipment_id": 1001,
                "equipment_name": "pro+设备"
            }
        ]
    }
}

1.6.14.5. 查询Equipment所有设备下拉列表

调用接口:

属性
url /api/equipment/menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_records": 2,
        "total_page": 1,
        "data": [
            {
                "equipment_id": 1004,
                "equipment_name": "智物联设备"
            },
            {
                "equipment_id": 1001,
                "equipment_name": "pro+设备"
            }
        ]
    }
}

1.6.14.6. 查询Equipment用户关注设备列表

调用接口:

属性
url /api/equipment/opt_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
user_id 用户标识 Integer
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_records": 5,
        "total_page": 1,
        "data": [
            {
                "equipment_id": 1004,
                "equipment_name": "智物联设备",
                "equipment_image": "equipment/2018/11/fangkuaizutaitu.gif",
                "model": "927"
            },
            {
                "equipment_id": 1001,
                "equipment_name": "pro+设备",
                "equipment_image": "equipment/2018/09/Desert_VJR97.jpg",
                "model": "007"
            }
        ]
    }
}

1.6.14.7. 添加Equipment

调用接口:

属性
url /api/equipment/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_name 设备名称 String
description 描述 Text
customer_id 客户标识 String
equipment_sn 设备编号 String
model 设备型号 String
datasheet_id 设备数据表标识 String
aprus_list 适配器列表 String
mapping_id 设备与适配器参数映射表标识 String
statistics_id 统计计算标识 String
gis 设备地理信息 String
secret 管理密码 String
auth_code 反向控制管理密码 String
equipment_image 设备图片路径 String
addition 附加字段/自定义字段 Json
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

addition数据格式说明(json格式):

[
    {
        "title": "锅炉信息",
        "data": [
            [
                "燃料类型",
                "天然气"
            ],
            [
                "锅炉重量",
                "2吨"
            ],
            [
                "出厂日期",
                "2018-03-03"
            ]
        ]
    },
    {
        "title": "能效指标信息",
        "data": [
            [
                "热效率",
                0.8
            ],
            [
                "燃料热值",
                7000
            ],
            [
                "吨汽燃料指标",
                0.21
            ]
        ]
    }
]
```json

返回参数:

| 字段   | 字段名称 | 字段类型 | 说明                | 是否必传 |
|--------|----------|----------|---------------------|----------|
| code   | 返回码   | Integer  | 200:成功 500:失败 | 是       |
| msg    | 提示信息 | String   |                     | 是       |
| result | 返回结果 | Json     |                     | 是       |

返回示例:

```json
{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.14.8. 编辑Equipment

调用接口:

属性
url /api/equipment/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
equipment_name 设备名称 String
description 描述 Text
customer_id 客户标识 String
equipment_sn 设备编号 String
model 设备型号 String
datasheet_id 设备数据表标识 String
aprus_list 适配器列表 String
mapping_id 设备与适配器参数映射表标识 String
statistics_id 统计计算标识 String
gis 设备地理信息 String
secret 管理密码 String
auth_code 反向控制管理密码 String
equipment_image 设备图片路径 String
addition 附加字段/自定义字段 Json
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

addition数据格式说明(json格式):

[
    {
        "title": "锅炉信息",
        "data": [
            [
                "燃料类型",
                "天然气"
            ],
            [
                "锅炉重量",
                "2吨"
            ],
            [
                "出厂日期",
                "2018-03-03"
            ]
        ]
    },
    {
        "title": "能效指标信息",
        "data": [
            [
                "热效率",
                0.8
            ],
            [
                "燃料热值",
                7000
            ],
            [
                "吨汽燃料指标",
                0.21
            ]
        ]
    }
]
```json

返回参数:

| 字段   | 字段名称 | 字段类型 | 说明                | 是否必传 |
|--------|----------|----------|---------------------|----------|
| code   | 返回码   | Integer  | 200:成功 500:失败 | 是       |
| msg    | 提示信息 | String   |                     | 是       |
| result | 返回结果 | Json     |                     | 是       |

返回示例:

```json
{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.14.9. 删除Equipment

调用接口:

属性
url /api/equipment/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.14.10. 查询Equipment反向控制列表

调用接口:

属性
url /api/equipment/get_codebase_template
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": [{
        "aprus_id": "A22018083100003",
        "aprus_name": "锅炉专用",
        "codebase_id": 1001,
        "template": [
            ["Control", "StartRemoteControl", "设备控制", "2", "L1_3_9", "1|2|4|8", "远程启动|远程停机|卸载|加载", "PEA"],
            ["temp", "temp", "设备控制", "2", "L1_3_8", "$", "温度", "PEA"]
        ]
    }]
}

1.6.14.11. 查询Equipment故障和报警列表

调用接口:

属性
url /api/equipment/get_warn_info
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
total 查询记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "total_records": 3,
        "data": [
            {
                "id": 1002,
                "name": "锅炉过热",
                "type": "alert",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:锅炉过热",
                "created": "2018-09-11 17:03:07"
            },
            {
                "id": 1001,
                "name": "速度反馈错误",
                "type": "fault",
                "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
                "created": "2018-09-03 15:43:32"
            },
            {
                "id": 1002,
                "name": "减速过电流",
                "type": "fault",
                "description": "Label_En:Retarded Overcurrent;Label_Cn:减速过电流",
                "created": "2018-09-01 15:43:32"
            }
        ]
    }
}

1.6.14.12. 查询Equipment服务和作业列表

调用接口:

属性
url /api/equipment/get_task_info
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
total 查询记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "total_records": 3,
        "data": [
            {
                "id": 1001,
                "name": "施工服务",
                "type": "service",
                "description": "",
                "date": "2018-11-30 09:16:18"
            },
            {
                "id": 1001,
                "name": "日常检修",
                "type": "activity",
                "description": "",
                "date": "2018-11-30 09:16:18"
            },
            {
                "id": 1002,
                "name": "普通作业",
                "type": "activity",
                "description": "",
                "date": "2018-11-30 09:16:18"
            }
        ]
    }
}

1.6.14.13. 查询EquipmentAPP显示板信息

调用接口:

属性
url /api/equipment/get_dashboard_template
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "equipment_id": 1001,
        "mapping_id": 1001,
        "template": [{
            "specialParameters": [{
                "title": "瞬时流量",
                "key": "S01",
                "value": "0",
                "unit": "Nm³"
            }],
            "basicParameters": [{
                "title": "累计流量",
                "key": "S04",
                "value": "0",
                "unit": "Nm³"
            }, {
                "title": "供气压力",
                "key": "S05",
                "value": "0",
                "unit": "Mpa"
            }],
            "moreParameter": [{
                "class": "数值监控类",
                "data": [{
                    "title": "瞬时流量",
                    "key": "S01",
                    "value": "0",
                    "unit": "Nm³"
                }]
            }],
            "controlPanel": [{
                "title": "远程控制监控5",
                "key": "S13",
                "value": "0",
                "unit": "h",
                "max": "50",
                "min": "0",
                "color": "#ffffff"
            }]
        }]
    }
}

1.6.14.14. 查询Equipment故障和报警挂板列表

调用接口:

属性
url /api/equipment/get_mosaic_warn
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "success",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 2,
        "total_records": 1,
        "data": [
            {
                "id": 1001,
                "name": "速度反馈错误",
                "type": "fault",
                "code": "7493",
                "equipment_id": 1001,
                "aprus_id": "A22018083100002",
                "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
                "created": "2018-09-03 15:43:32"
            },
            {
                "id": 1001,
                "name": "油分器堵塞",
                "type": "alert",
                "code": "2514",
                "equipment_id": 1002,
                "aprus_id": "A22018083100002",
                "description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞",
                "created": "2018-09-01 15:43:32"
            }
        ]
    }
}

1.6.14.15. 查询Equipment设备关联适配器的Fidis变量

调用接口:

属性
url /api/equipment/get_fidis_variable
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
aprus_id 适配器标识 String 如:A20180831003
aprus_key 参数上报Key String 如:L1_3_1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "fidis_var": "S01"
    }
}

1.6.15. EquipmentGroup(设备组)

1.6.15.1. 查询EquipmentGroup关注设备组列表

调用接口:

属性
url /api/equipment_group/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["group_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "group_id": 1001,
                "group_name": "pro+设备",
                "description": null,
                "sub_equipment": "1007,1005",
                "main_equipment": "1001",
                "secret": "NYEW",
                "image": null,
                "template": "[]",
                "script": "[]",
                "reference": null,
                "created": "2018-09-25 09:30:49",
                "is_available": 1,
                "addition": "[]",
                "gis": "23.5485544122,114.0661345267,0,0",
                "customer_id": 1001,
                "customer_name": "智物联",
                "气站状态": 1,
                "气电比": "0.1172",
                "设备尺寸": "",
                "锅炉吨位": "",
                "产气量": "10.5H",
                "更新时间": "2018-11-30 17:16:35"
            }
        ]
    }
}

1.6.15.2. 查询EquipmentGroup所有设备组列表

调用接口:

属性
url /api/equipment_group/get_all_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否不分页返回(即返回所有数据) Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["group_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "group_id": 1001,
                "group_name": "pro+设备",
                "description": null,
                "sub_equipment": "1007,1005",
                "main_equipment": "1001",
                "secret": "NYEW",
                "image": null,
                "template": "[]",
                "script": "[]",
                "reference": null,
                "created": "2018-09-25 09:30:49",
                "is_available": 1,
                "addition": "[]",
                "gis": "23.5485544122,114.0661345267,0,0",
                "customer_id": 1001,
                "customer_name": "智物联",
                "气站状态": 1,
                "气电比": "0.1172",
                "设备尺寸": "",
                "锅炉吨位": "",
                "产气量": "10.5H",
                "更新时间": "2018-11-30 17:16:35"
            }
        ]
    }
}

1.6.15.3. 查询EquipmentGroup指定记录

调用接口:

属性
url /api/equipment_group/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组标识 Integer

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "group_id": 1001,
        "group_name": "pro+设备",
        "description": null,
        "sub_equipment": "1007,1005",
        "main_equipment": "1001",
        "secret": "NYEW",
        "image": null,
        "template": "[]",
        "script": "[]",
        "reference": null,
        "created": "2018-09-25 09:30:49",
        "is_available": 1,
        "addition": "[]",
        "gis": "23.5485544122,114.0661345267,0,0",
        "customer_id": 1001,
        "customer_name": "智物联",
        "气站状态": 1,
        "气电比": "0.1172",
        "设备尺寸": "",
        "锅炉吨位": "",
        "产气量": "10.5H",
        "更新时间": "2018-11-30 17:16:35"
    }
}

1.6.15.4. 查询EquipmentGroup所有设备组下拉列表

调用接口:

属性
url /api/equipment_group/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "group_id": 1001,
                "group_name": "pro+设备"
            }
        ]
    }
}

1.6.15.5. 添加EquipmentGroup

调用接口:

属性
url /api/equipment_group/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_name 设备组名称 String
description 描述 String
sub_equipment 子设备标识集合,如:1001,1002,1003 String
main_equipment 主设备标识 Integer
secret 管理密码 String
image 设备组图片路径 String
template 模板/样式 String
script 脚本 String
reference 参考号 String
created 记录创建时间 datetime
is_available 是否有效:1是、0否 Integer

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.15.6. 编辑EquipmentGroup

调用接口:

属性
url /api/equipment_group/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组标识 Integer
group_name 设备组名称 String
description 描述 String
sub_equipment 子设备标识集合,如:1001,1002,1003 String
main_equipment 主设备标识 Integer
secret 管理密码 String
image 设备组图片路径 String
template 模板/样式 String
script 脚本 String
reference 参考号 String
created 记录创建时间 datetime
is_available 是否有效:1是、0否 Integer
addition 扩展信息 JSON

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.15.7. 删除EquipmentGroup

调用接口:

属性
url /api/equipment_group/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组标识 Integer

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.15.8. 查询设备组子设备列表

调用接口:

属性
url /api/equipment_group/get_equipment
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组标识 Integer

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": [
        {
            "equipment_id": 1005,
            "equipment_name": "测试设备5",
            "description": "测试设备5",
            "customer_id": 1003,
            "equipment_sn": "1001",
            "model": "测试设备5",
            "type_id": null,
            "camera_list": "测试设备5",
            "is_group": 0,
            "camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com",
            "datasheet_id": null,
            "aprus_list": "",
            "mapping_id": 1003,
            "gis": "",
            "secret": "DZHR",
            "auth_code": null,
            "equipment_image": "",
            "addition": [],
            "template": null,
            "script": null,
            "reference": null,
            "created": "2018-08-30 18:24:19",
            "is_available": 1,
            "boss_sync": 0,
            "customer_name": "test",
            "status_code": 0,
            "status_name": "关机|故障"
        }
    ]
}

1.6.15.9. 查询设备组事件、故障、报警、服务、作业列表

调用接口:

属性
url /api/equipment_group/get_process
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组编号 Integer
start_time 查询开始时间 datetime
end_time 查询结束时间 datetime
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 0,
        "total_records": 0,
        "data": []
    }
}

1.6.15.10. 查询设备组事件列表

调用接口:

属性
url /api/equipment_group/get_event
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组编号 Integer
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 0,
        "total_records": 0,
        "data": []
    }
}

1.6.15.11. 查询设备组故障挂板列表

调用接口:

属性
url /api/equipment_group/get_fault_mosaic
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组编号 Integer
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 0,
        "total_records": 0,
        "data": []
    }
}

1.6.15.12. 查询设备组报警挂板列表

调用接口:

属性
url /api/equipment_group/get_alert_mosaic
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组编号 Integer
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 0,
        "total_records": 0,
        "data": []
    }
}

1.6.15.13. 查询设备组故障和报警挂板列表

调用接口:

属性
url /api/equipment_group/get_mosaic_warn
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
group_id 设备组编号 Integer
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 0,
        "total_records": 0,
        "data": []
    }
}

1.6.16. Event(事件)

1.6.16.1. 查询Event(关注设备或无设备ID)详细列表

调用接口:

属性
url /api/event/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["event_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "event_id": 1003,
                "code": "3701",
                "event_name": "设备开始加载",
                "description": "Label_En:System Load Start;Label_Cn:设备开始加载",
                "aprus_id": "A22018083100002",
                "equipment_id": 1002,
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-09-11 16:43:42",
                "is_available": 1
            }
        ]
    }
}

1.6.16.2. 查询Event指定记录

调用接口:

属性
url /api/event/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
event_id 事件标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "event_id": 1003,
        "code": "3701",
        "event_name": "设备开始加载",
        "description": "Label_En:System Load Start;Label_Cn:设备开始加载",
        "aprus_id": "A22018083100002",
        "equipment_id": 1002,
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-09-11 16:43:42",
        "is_available": 1
    }
}

1.6.16.3. 查询Event(关注设备或无设备ID)下拉列表

调用接口:

属性
url /api/event/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 3,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "event_id": 1003,
                "event_name": "设备开始加载",
                "equipment_id": 1002,
                "created": "2018-09-11 16:43:42"
            },
            {
                "event_id": 1002,
                "event_name": "设备开始运行",
                "equipment_id": 1001,
                "created": "2018-09-03 15:43:32"
            }
        ]
    }
}

1.6.16.4. 查询Event(关注设备)详细列表(EXP使用)

调用接口:

属性
url /api/exp/event/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.16.5. 查询Event(关注设备)下拉列表(EXP使用)

调用接口:

属性
url /api/exp/event/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.16.6. 添加Event

调用接口:

属性
url /api/event/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
event_name 事件代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.16.7. 编辑Event

调用接口:

属性
url /api/event/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
event_id 事件标识 String
event_name 事件代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.16.8. 删除Event

调用接口:

属性
url /api/event/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
event_id 事件标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.17. Fault(故障)

1.6.17.1. 查询Fault(关注设备或无设备ID)详细列表

调用接口:

属性
url /api/fault/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["fault_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "fault_id": 1001,
                "code": "7493",
                "fault_name": "速度反馈错误",
                "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
                "aprus_id": "A22018083100002",
                "equipment_id": 1001,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-03 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.17.2. 查询Fault指定记录

调用接口:

属性
url /api/fault/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
fault_id 故障ID Integer 自增id

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "fault_id": 1001,
        "code": "7493",
        "fault_name": "速度反馈错误",
        "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
        "aprus_id": "A22018083100002",
        "equipment_id": 1001,
        "template": "",
        "script": "",
        "reference": "",
        "created": "2018-09-03 15:43:32",
        "is_available": 1
    }
}

1.6.17.3. 查询Fault(关注设备或无设备ID)下拉列表

调用接口:

属性
url /api/fault/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "fault_id": 1001,
                "fault_name": "速度反馈错误",
                "equipment_id": 1001,
                "created": "2018-09-03 15:43:32"
            },
            {
                "fault_id": 1002,
                "fault_name": "减速过电流",
                "equipment_id": 1001,
                "created": "2018-09-01 15:43:32"
            }
        ]
    }
}

1.6.17.4. 查询Fault(关注设备)详细列表(EXP使用)

调用接口:

属性
url /api/exp/fault/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.17.5. 查询Fault(关注设备)下拉列表(EXP使用)

调用接口:

属性
url /api/exp/fault/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.6.17.6. 添加Fault

调用接口:

属性
url /api/fault/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
fault_name 故障代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.17.7. 编辑Fault

调用接口:

属性
url /api/fault/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
fault_id 故障标识 String
fault_name 故障代码 String
description 描述 Text
aprus_id 适配器标识 String
equipment_id 设备标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.17.8. 删除Fault

调用接口:

属性
url /api/fault/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
fault_id 故障ID Integer 自增id

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.18. FaultMosaic(故障挂板)

1.6.18.1. 查询FaultMosaic详细列表

调用接口:

属性
url /api/fault_mosaic/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}",{value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["equipment_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "equipment_id": 1007,
                "fault_mosaic": {
                    "7603": [
                        "1002",
                        "减速过电流"
                    ]
                },
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-09-11 16:54:13",
                "is_available": 1
            },
            {
                "equipment_id": 1005,
                "fault_mosaic": {
                    "7493": [
                        "1001",
                        "速度反馈错误"
                    ]
                },
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-11 16:52:04",
                "is_available": 1
            }
        ]
    }
}

1.6.18.2. 查询FaultMosaic指定记录

调用接口:

属性
url /api/fault_mosaic/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "equipment_id": 1007,
        "fault_mosaic": {
            "7603": [
                "1002",
                "减速过电流"
            ]
        },
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-09-11 16:54:13",
        "is_available": 1
    }
}

1.6.18.3. 查询指定设备挂板列表

调用接口:

属性
url /api/fault_mosaic/get_list_by_equipment
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "fault_id": 1001,
                "code": "7493",
                "fault_name": "速度反馈错误",
                "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
                "aprus_id": "A22018083100002",
                "equipment_id": 1001,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-03 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.18.4. 查询关注设备挂板列表

调用接口:

属性
url /api/fault_mosaic/get_list_by_user
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "fault_id": 1001,
                "code": "7493",
                "fault_name": "速度反馈错误",
                "description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误",
                "aprus_id": "A22018083100002",
                "equipment_id": 1001,
                "template": "",
                "script": "",
                "reference": "",
                "created": "2018-09-03 15:43:32",
                "is_available": 1
            }
        ]
    }
}

1.6.18.5. 添加fault_mosaic

调用接口:

属性
url /api/fault_mosaic/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
fault_mosaic 故障标识集合 Json
template 模板/样式 String
script 脚本 String
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.18.6. 编辑fault_mosaic

调用接口:

属性
url /api/fault_mosaic/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String
fault_mosaic 故障标识集合 Text
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.18.7. 删除fault_mosaic

调用接口:

属性
url /api/fault_mosaic/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
equipment_id 设备标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.19. Mapping(映射表)

1.6.19.1. 查询Mapping详细列表

调用接口:

属性
url /api/mapping/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["mapping_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "mapping_id": 1003,
                "mapping_name": "设备大屏配置",
                "description": "",
                "dashboard_id": 1003,
                "template": "[]",
                "script": "[]",
                "reference": "",
                "created": "2018-10-17 14:03:39",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

1.6.19.2. 查询Mapping指定记录

调用接口:

属性
url /api/mapping/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
mapping_id 映射表标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "mapping_id": 1003,
        "mapping_name": "设备大屏配置",
        "description": "",
        "dashboard_id": 1003,
        "template": "[]",
        "script": "[]",
        "reference": "",
        "created": "2018-10-17 14:03:39",
        "is_available": 1,
        "boss_sync": 0
    }
}

1.6.19.3. 查询Mapping下拉列表

调用接口:

属性
url /api/mapping/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 3,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "mapping_id": 1003,
                "mapping_name": "设备大屏配置"
            },
            {
                "mapping_id": 1001,
                "mapping_name": "远程控制监控"
            }
        ]
    }
}

1.6.19.4. 添加Mapping

调用接口:

属性
url /api/mapping/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
mapping_name 映射表名称 String
description 描述 Text
dashboard_id 显示板标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.19.5. 编辑Mapping

调用接口:

属性
url /api/mapping/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
mapping_id 映射表标识 String
mapping_name 映射表名称 String
description 描述 Text
dashboard_id 显示板标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.19.6. 删除Mapping

调用接口:

属性
url /api/mapping/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
mapping_id 映射表标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "删除成功",
    "result": []
}

1.6.20. Message(消息)

1.6.20.1. 查询Message详细列表

调用接口:

属性
url /api/message/get_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 Json LIKE模糊搜索条件
start_time 开始时间 Datetime 按创建时间搜索的开始时间和结束时间
end_time 结束时间 Datetime
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认0

condition参数:

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["message_id", "=", "1001"]]

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "message_id": 1009,
                "message_name": "适配器离线",
                "date": null,
                "category": "AprusDisconnect",
                "unit": "gards",
                "messenger": "A22018083100002",
                "description": "",
                "customer_id": null,
                "template": null,
                "script": null,
                "reference": "",
                "created": "2018-09-03 18:46:26",
                "is_available": 1
            }
        ]
    }
}

1.6.20.2. 查询Message指定记录

调用接口:

属性
url /api/message/get
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
message_id 消息标识 String

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "message_id": 1009,
        "message_name": "适配器离线",
        "date": null,
        "category": "AprusDisconnect",
        "unit": "gards",
        "messenger": "A22018083100002",
        "description": "",
        "customer_id": null,
        "template": null,
        "script": null,
        "reference": "",
        "created": "2018-09-03 18:46:26",
        "is_available": 1
    }
}

1.6.20.3. 查询Message下拉列表

调用接口:

属性
url /api/message/get_menu_list
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String LIKE模糊搜索条件
is_all 是否返回所有数据 Boolean 1:是,0:否;如果为空,则默认1

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 结果 Json

返回数据举例:

{
    "code": 200,
    "msg": "查询成功",
    "result": {
        "page_index": 1,
        "page_size": 9,
        "total_pages": 1,
        "total_records": 2,
        "data": [
            {
                "message_id": 1009,
                "messenger": "A22018083100002",
                "message_name": "适配器离线",
                "created": "2018-09-03 18:46:26"
            },
            {
                "message_id": 1007,
                "messenger": "A22018083100002",
                "message_name": "适配器上线",
                "created": "2018-09-03 18:03:11"
            }
        ]
    }
}

1.6.20.4. 添加Message

调用接口:

属性
url /api/message/add
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
message_name 消息摘要或标题 String
date 消息时间 datetime
category 消息类型 String
unit 消息来源分类 String
messenger 消息来源 String
description 描述 Text
customer_id 客户标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "添加成功",
    "result": []
}

1.6.20.5. 编辑Message

调用接口:

属性
url /api/message/edit
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传
message_id 消息标识 String
message_name 消息摘要或标题 String
date 消息时间 datetime
category 消息类型 String
unit 消息来源分类 String
messenger 消息来源 String
description 描述 Text
customer_id 客户标识 String
template 模板/样式 text
script 脚本 text
reference 参考号 String
is_available 是否有效 Boolean 1:是,0:否

返回参数:

字段 字段名称 字段类型 说明 是否必传
code 返回码 Integer 200:成功 500:失败
msg 提示信息 String
result 返回结果 Json

返回示例:

{
    "code": 200,
    "msg": "编辑成功",
    "result": []
}

1.6.20.6. 删除Message

调用接口:

属性
url /api/message/delete
http方法 post
Content-Type application/json或application/x-www-form-urlencoded

请求参数:

字段 字段名称 字段类型 说明 是否必传