1. MIX.IOT.2018.F.21.01-APIM API

1.1. 文档说明

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

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. 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": 1000,
        "username": "admin",
        "realname": "",
        "is_super": 1,
        "mobile": "13800138002",
        "description": "",
        "sex": "",
        "position": "",
        "phone": "",
        "email": "admin\@mixlinker.com",
        "address": "",
        "template": "",
        "script": "",
        "reference": "mixlinker.pro.admin",
        "created": "2018-06-14 20:00:00",
        "is_available": 1,
        "boss_sync": 0,
        "ticket": "uLu9pOZoI83g1XNPtYaYkTUS3Z2hIKq5",
        "group_list": null,
        "account_list": "",
        "client_list": "",
        "token": "Sy2wm1BSIaXtAPWTAyOzx5QN1Z7gGRRm"
    }
}

备注:

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

Authorization:Bearer $token

1.6.2. Activity(作业)

1.6.2.1. 查询详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.2. 查询下拉列表

调用接口:

属性
url /api/m/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:否;如果为空,则默认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. Alert(报警)

1.6.3.1. 查询报警详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.2. 下拉列表

调用接口:

属性
url /api/m/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:否;如果为空,则默认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.4. AlertMosaic(报警挂板)

1.6.4.1. 查询详细列表

调用接口:

属性
url /api/m/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 查询条件 String 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.5. Aprus(适配器)

1.6.5.1. 查询Aprus详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.5.2. 查询Aprus下拉列表

调用接口:

属性
url /api/m/aprus/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:否;如果为空,则默认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.6. AprusType(适配器类型)

1.6.6.1. 查询AprusType详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.6.2. 查询AprusType下拉列表

调用接口:

属性
url /api/m/aprus_type/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:否;如果为空,则默认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.7. Codebase(代码库)

1.6.7.1. 查询Codebase详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.7.2. 查询Codebase下拉列表

调用接口:

属性
url /api/m/codebase/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:否;如果为空,则默认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.8. Collect(离线数据类型)

1.6.8.1. 查询Collect详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.8.2. 查询Collect下拉列表

调用接口:

属性
url /api/m/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:否;如果为空,则默认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.9. Config(适配器配置)

1.6.9.1. 查询Config详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.9.2. 查询Config下拉列表

调用接口:

属性
url /api/m/config/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:否;如果为空,则默认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.10. Customer(客户)

1.6.10.1. 查询Customer详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.10.2. 查询Customer下拉列表

调用接口:

属性
url /api/m/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 查询条件 String LIKE模糊搜索条件
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.11. Dashboard(显示板)

1.6.11.1. 查询Dashboard详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.11.2. 查询Dashboard下拉列表

调用接口:

属性
url /api/m/dashboard/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:否;如果为空,则默认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.12. Datasheet(数据表)

1.6.12.1. 查询Datasheet详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.12.2. 查询Datasheet下拉列表

调用接口:

属性
url /api/m/datasheet/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:否;如果为空,则默认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.13. Equipment(设备)

1.6.13.1. 查询Equipment详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.13.2. 查询Equipment下拉列表

调用接口:

属性
url /api/m/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:否;如果为空,则默认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.14. EquipmentGroup(设备组)

1.6.14.1. 查询EquipmentGroup详细列表

调用接口:

属性
url /api/m/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 查询条件 String 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.14.2. 查询EquipmentGroup下拉列表

调用接口:

属性
url /api/m/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
condition 查询条件 String LIKE模糊搜索条件
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.15. EquipmentType(设备类型)

1.6.15.1. 查询EquipmentType详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.15.2. 查询EquipmentType下拉列表

调用接口:

属性
url /api/m/equipment_type/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:否;如果为空,则默认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. Event(事件)

1.6.16.1. 查询Event详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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. Fault(故障)

1.6.17.1. 查询Fault详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.18. FaultMosaic(故障挂板)

1.6.18.1. 查询FaultMosaic详细列表

调用接口:

属性
url /api/m/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 查询条件 String 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.19. Log(日志)

1.6.19.1. 查询Log详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.20. Mapping(映射表)

1.6.20.1. 查询Mapping详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.20.2. 查询Mapping下拉列表

调用接口:

属性
url /api/m/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:否;如果为空,则默认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.21. Message(消息)

1.6.21.1. 查询Message详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.22. Service(服务)

1.6.22.1. 查询Service详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.23. Statistics(统计计算类型)

1.6.23.1. 查询Statistics详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.23.2. 查询Statistics下拉列表

调用接口:

属性
url /api/m/statistics/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:否;如果为空,则默认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.24. Statos(统计计算结果)

1.6.24.1. 查询Statos基本表-详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.24.2. 查询Statos基本表-下拉列表

调用接口:

属性
url /api/m/statos/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:否;如果为空,则默认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.24.3. 查询Statos不同表-详细列表

调用接口:

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

请求参数:

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

备注:

type 为以下几种类型:

类型 说明
hour 小时(基本统计)
yesterday 昨天
lastWeek 上周
lastMonth 上月
lastYear 去年
staDay 当天
staMonth 当月
staYear 当年
total 累计

返回参数:

字段 字段名称 字段类型 说明 是否必传
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.25. User(用户)

1.6.25.1. 查询User详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.25.2. 查询User下拉列表

调用接口:

属性
url /api/m/user/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:否;如果为空,则默认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.26. UserCustomer(用户关注客户)

1.6.26.1. 查询UserCustomer详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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.27. UserEquipment(用户关注设备)

1.6.27.1. 查询UserEquipment详细列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码 Integer 大于 0,如果为空,则默认从第一页显示
page_size 每页记录数 Integer 大于 0,如果为空,则默认为 20
condition 查询条件 String 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": []
    }
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2018-12-28 10:48:30

results matching ""

    No results matching ""