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

1.1. 文档说明

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

1.2. 适用对象

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

1.3. 修订记录

日期 文档版本 适用ADMIN版本 编写
2018-12-15 MIX.IOT.2018.F.21.01 1.5.0(不包括)及以下 Ken

新建 APIM 接口说明文档

日期 文档版本 适用ADMIN版本 编写
2019-06-18 MIX.IOT.2018.F.21.02 1.5.0(包括)及以上 Ken

去除get_menu_list接口,同时get_list接口增加field查询条件(替代get_menu_list接口)

get_list接口查询条件:condition参数调整为传递Json格式数据(直接传递字符串的格式已不支持)

get_list接口增加查询条件:or_where参数

get_list接口查询条件:is_all参数不建议使用,文档中去除说明(未来参数将去除)

get_list接口去除查询条件:start_time和end_time参数(由condition查询条件替代)

去除User(用户)查询:get_list接口

1.4. 请求地址

HOST:http://xxx.com/(具体以系统部署地址为准)

请求地址:HOST +下文接口中的url

1.5. 请求说明

固定传参

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

参考

Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

1.6. 响应说明

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

code 含义 备注
200 请求成功 code不为200,则说明请求失败
500 请求错误
401 令牌失效

1.7. 接口定义

1.7.1. Login(登录)

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
username 登录账户 String 登录账户:用户名
password 登录密码 String
system 登录系统 String PRO系统标识:MixPro
keep_alive 会话周期 String short/medium/long

keep_alive 参数说明:

token 时效 refresh_token 时效
default 2h 1d
short 1d 7d
medium 3d 30d
long 7d 90d

返回示例:

{
    "code": 200,
    "msg": "登录成功",
    "mix_code": 130002,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "user_id": 1000,
        "username": "admin",
        "is_super": 1,
        "mobile": "13812312300",
        "description": "",
        "extension": "9527",
        "email": "admin@mixlinker.com",
        "address": "",
        "reference": "mixlinker.pro.admin",
        "created": "2018-06-14 20:00:00",
        "ticket": "VXtqg4RfMM2rFsoXgKNhFjUHx2AtQAFh",
        "refresh_token": "vmONEv3tyOGsoQBhCQyOXqDyqZlVixetTPEXL12CVeDIlgXXOHb3UuM9HBUhvXpN",
        "keep_alive": "long",
        "token": "VXtqg4RfMM2rFsoXgKNhFjUHx2AtQAFh"
    }
}

备注:

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

Authorization:Bearer $token

1.7.2. Activity(作业)

1.7.2.1. 查询作业列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name
  1. condition 参数:

1.1 格式

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

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

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

1.2 举例

[["id", "=", "1001"], ["name", "LIKE", "名字"]]

  1. or_where 参数:

2.1 格式

["${key1},${key2} ", "${value}"] 即 ["查询值一,查询值二","查询内容"]

2.2 举例

["id,name", "1001"]

  1. field 参数:

3.1 格式

$field1,$field2 即 查询字段 1,查询字段 2

3.2 举例

group_id,group_name

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.3. Alert(报警)

1.7.3.1. 查询报警列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.4. AlertMosaic(报警挂板)

1.7.4.1. 查询报警挂板列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.5. Aprus(适配器)

1.7.5.1. 查询适配器列表

调用接口:

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

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.6. AprusType(适配器类型)

1.7.6.1. 查询适配器类型列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.7. Codebase(代码库)

1.7.7.1. 查询代码库列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.8. Collect(离线数据类型)

1.7.8.1. 查询离线数据类型列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.9. Config(适配器配置)

1.7.9.1. 查询适配器配置列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.10. Customer(客户)

1.7.10.1. 查询客户列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.11. Dashboard(显示板)

1.7.11.1. 查询显示板列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.12. Datasheet(数据表)

1.7.12.1. 查询数据表列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.13. Equipment(设备)

1.7.13.1. 查询设备列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.14. EquipmentGroup(设备组)

1.7.14.1. 查询设备组列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.15. EquipmentType(设备模板)

1.7.15.1. 查询设备模板列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.16. Event(事件)

1.7.16.1. 查询事件列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.17. Fault(故障)

1.7.17.1. 查询故障列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.18. FaultMosaic(故障挂板)

1.7.18.1. 查询故障挂板列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.19. Log(日志)

1.7.19.1. 查询日志列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.20. Mapping(映射表)

1.7.20.1. 查询映射表列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.21. Message(消息)

1.7.21.1. 查询消息列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.22. Service(服务)

1.7.22.1. 查询服务列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.23. Statistics(统计计算类型)

1.7.23.1. 查询统计计算类型列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.24. Statos(统计计算结果)

1.7.24.1. 查询Statos基本表-列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.24.2. 查询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,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

type 为以下几种类型:

类型 说明
ST 小时(基本统计)
ST_ED 昨天
ST_EW 上周
ST_EM 上月
ST_ED 去年
ST_CD 当天
ST_CM 当月
ST_CY 当年
ST_SM 累计

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.25. UserCustomer(用户关注客户)

1.7.25.1. 查询用户关注客户列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}

1.7.26. UserEquipment(用户关注设备)

1.7.26.1. 查询用户关注设备列表

调用接口:

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

请求参数:

字段 字段名称 字段类型 说明 是否必传
page_index 查询页码数 Integer 大于 0,默认为 1
page_size 每页记录数 Integer 大于 0,默认为 20
condition AND 查询条件 Json AND 自定义查询条件
or_where OR 查询条件 Json LIKE 模糊搜索条件
field 返回字段 String 多个字段逗号隔开,如:id,name

具体请求参数说明详见:1.7.2.1. 查询作业列表

返回参数:

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

返回示例:

{
    "code": 200,
    "msg": "查询成功",
    "mix_code": 130001,
    "mix_msg": "",
    "mix_ext": "",
    "result": {
        "page_index": "1",
        "page_size": "15",
        "total_pages": 1,
        "total_records": 0,
        "data": []
    }
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2019-11-13 19:54:53

results matching ""

    No results matching ""