1. API-IE
1.1. 文档说明
本文档为EVACS系统接口说明文档
1.2. 适用对象
本文档的面向读者是EVACS下的所有开发相关人员。
1.3. 接口列表
1.3.1. 获取项目列表
1.3.1.1. 功能描述
查询项目列表
1.3.1.2. 请求地址
属性 |
值 |
url |
/incresa/project/project_list |
http方法 |
post |
1.3.1.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
keyword |
string |
|
搜索关键字 |
否 |
page_index |
int |
|
页数 |
是 |
page_size |
int |
|
数据大小 |
是 |
data |
string |
|
是否返回所有数据all返回所有 |
否 |
1.3.1.4. 响应示例
{
"code": 200,
"mix_code": 263501,
"mix_ext": "",
"mix_msg": "",
"result": {
"all_count": 7,
"data": [
{
"algorithm_id": 23,
"created": "2013-10-10 23:40:00",
"cycle": 123,
"description": "",
"project_id": 112,
"project_name": "1212df"
},
{
"algorithm_id": 23,
"created": "2013-10-10 23:40:00",
"cycle": 123,
"description": "",
"project_id": 113,
"project_name": "1212df"
}
],
"page_index": 1,
"page_size": 2
}
}
1.3.2. 查询项目详情
1.3.2.1. 功能描述
查询项目详细信息
1.3.2.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_project |
http方法 |
get |
1.3.2.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
project_id |
int |
|
数据源id |
是 |
1.3.2.4. 响应示例
{
"code": 200,
"mix_code": 10001,
"mix_ext": "",
"mix_msg": "",
"msg": "search successfully!",
"result": {
"all_count": 1,
"data": [
{
"active": 1,
"algorithm_id": 1,
"created": "2019-06-25 18:08:41",
"cycle": 0.5,
"description": "",
"equipment_list": "1159,1161",
"equipment_name": [
"盈信纺织空压机2",
"海普空压机4"
],
"is_available": 0,
"project_id": 1,
"project_name": "test-inc",
"reference": "",
"script": "",
"template": ""
}
],
"page_index": 1,
"page_size": 50
}
}
1.3.3. 添加项目
1.3.3.1. 功能描述
添加项目
1.3.3.2. 请求参数
属性 |
值 |
url |
/incresa/project/get_project |
http方法 |
post |
1.3.3.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
project_name |
string |
|
项目名称 |
是 |
equipment_list |
string |
|
设备id |
是 |
created |
string |
|
创建时间 |
否 |
script |
string |
|
脚本 |
否 |
reference |
string |
|
参考 |
否 |
template |
string |
|
模板 |
否 |
algorithm_id |
string |
|
算法表示 |
是 |
cycle |
string |
|
周期 |
是 |
1.3.3.4. 响应示例
{
"result": {},
"code": 200,
"mix_msg": "",
"mix_ext": "",
"msg": "添加项目成功",
"mix_code": 160101
}
1.3.4. 修改项目
1.3.4.1. 功能描述
修改项目
1.3.4.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_project |
http方法 |
put |
1.3.4.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
project_id |
string |
|
项目id |
是 |
project_name |
string |
|
项目名称 |
是 |
equipment_list |
string |
|
设备id |
是 |
created |
string |
|
创建时间 |
否 |
script |
string |
|
脚本 |
否 |
reference |
string |
|
参考 |
否 |
template |
string |
|
模板 |
否 |
algorithm_id |
string |
|
算法表示 |
是 |
cycle |
string |
|
周期 |
是 |
1.3.4.4. 响应示例
{
"result": {},
"code": 200,
"mix_msg": "",
"mix_ext": "",
"msg": "修改成功",
"mix_code": 160102
}
1.3.5. 删除项目
1.3.5.1. 功能描述
删除项目
1.3.5.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_project |
http方法 |
delete |
1.3.5.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
project_id |
string |
|
项目id |
是 |
1.3.5.4. 响应示例
{
"code": 200,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "",
"msg": "删除成功!",
"result": ""
}
1.3.6. 启动项目
1.3.6.1. 功能描述
启动项目
1.3.6.2. 请求地址
属性 |
值 |
url |
/incresa/project/start_project |
http方法 |
post |
1.3.6.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
project_id |
string |
|
项目id |
是 |
active |
string |
|
1为启动0为停止 |
是 |
1.3.6.4. 响应示例
{
"code": 500,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "active database success ",
"msg": "active success!",
"result": ""
}
1.3.7. 获取设备列表
1.3.7.1. 功能描述
获取设备列表
1.3.7.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_equipment |
http方法 |
post |
1.3.7.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
1.3.7.4. 响应示例
{
"code": 200,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "",
"msg": "The request is successful!",
"result": {
"all_data": [
{
"equipment_id": 1030,
"equipment_name": "汇田工贸2号空压机"
},
{
"equipment_id": 1029,
"equipment_name": "汇田工贸1号空压机"
},
{
"equipment_id": 1028,
"equipment_name": "汤姆森气站-空压机"
},
{
"equipment_id": 1001,
"equipment_name": "咸宁三环"
}
]
}
}
1.3.8. 获取设备映射表
1.3.8.1. 功能描述
获取设备mapping
1.3.8.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_mapping |
http方法 |
post |
1.3.8.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
1.3.8.4. 响应示例
{
"code": 200,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "",
"msg": "The request is successful!",
"result": {
"all_data": [
[
"com_AirFilterUsedTime",
"",
"空滤器器使用时间"
],
[
"com_LubOilUsedTime",
"",
"润滑油使用时间"
],
[
"com_GreaseUsedTime",
"",
"润滑脂使用时间"
]
]
}
}
1.3.9. 获取引擎列表
1.3.9.1. 功能描述
获取引擎列表
1.3.9.2. 请求地址
属性 |
值 |
url |
/incresa/engine/get_engine |
http方法 |
get |
1.3.9.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
keyword |
string |
|
搜索关键字 |
否 |
page_size |
int |
|
每页条数 |
是 |
page_index |
int |
|
页数 |
是 |
1.3.9.4. 响应示例
{
"code": 200,
"mix_code": 10001,
"mix_ext": "",
"mix_msg": "",
"msg": "search successfully!",
"result": [
{
"active": false,
"create": "2013-10-10 23:40:00",
"cycle": 123,
"description": "",
"id": 1,
"interval": 123,
"limit": 1,
"name": "11123",
"reference": "",
"script": "",
"template": "",
"types": "1"
}
]
}
1.3.10. 获取引擎详情
1.3.10.1. 功能描述
获取引擎详情
1.3.10.2. 请求地址
属性 |
值 |
url |
/incresa/engine/get_engine |
http方法 |
get |
1.3.10.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
engine_id |
int |
|
数据管道id |
是 |
1.3.10.4. 响应示例
{
"code": 200,
"mix_code": 10001,
"mix_ext": "",
"mix_msg": "",
"msg": "search successfully!",
"result": {
"all_count": 1,
"data": [
{
"created": "2019-06-25 18:09:21",
"cycle": 10,
"description": "",
"engine_id": 1,
"engine_name": "testin",
"interval": 10,
"is_available": 1,
"limit": 200,
"project_id": 1,
"project_name": "test-inc",
"reference": "",
"script": "[{"id":"Y01-2","name":"供气压力","algorithm_id":1,"value":["output"]},{"id":"Y02-2","name":"排气温度","algorithm_id":1,"value":["input"]},{"id":"Y12-2","name":"风机停温度","algorithm_id":1,"value":["input"]},{"id":"Y11-2","name":"风机启温度","algorithm_id":1,"value":["output"]}]",
"template": "",
"types": "MO"
}
],
"page_index": 1,
"page_size": 50
}
}
1.3.11. 添加引擎
1.3.11.1. 功能描述
添加引擎
1.3.11.2. 请求地址
属性 |
值 |
url |
/incresa/engine/get_engine |
http方法 |
post |
1.3.11.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
engine_name |
string |
|
引擎名称 |
是 |
project_id |
string |
|
项目id |
是 |
is_available |
string |
|
是否启用 |
是 |
created |
string |
|
创建时间 |
否 |
script |
string |
|
脚本 |
否 |
reference |
string |
|
参考 |
否 |
template |
string |
|
模板 |
否 |
types |
string |
|
引擎类型 |
否 |
limit |
string |
|
最大限制 |
否 |
cycle |
string |
|
引擎周期 |
是 |
interval |
string |
|
数据区间 |
否 |
1.3.11.4. 响应示例
{
"result": {},
"code": 200,
"mix_msg": "",
"msg": "添加引擎成功",
"mix_code": 160201,
"mix_ext": ""
}
1.3.12. 修改引擎
1.3.12.1. 功能描述
修改引擎
1.3.12.2. 请求地址
属性 |
值 |
url |
/incresa/engine/get_engine |
http方法 |
put |
1.3.12.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
engine_id |
string |
|
引擎id |
是 |
engine_name |
string |
|
引擎名称 |
是 |
project_id |
string |
|
项目id |
是 |
is_available |
string |
|
是否启用 |
是 |
created |
string |
|
创建时间 |
否 |
script |
string |
|
脚本 |
否 |
reference |
string |
|
参考 |
否 |
template |
string |
|
模板 |
否 |
types |
string |
|
引擎类型 |
否 |
limit |
string |
|
最大限制 |
否 |
cycle |
string |
|
引擎周期 |
是 |
interval |
string |
|
数据区间 |
否 |
1.3.12.4. 响应示例
{
"result": {},
"code": 200,
"mix_msg": "",
"msg": "修改引擎成功",
"mix_code": 160202,
"mix_ext": ""
}
1.3.13. 删除引擎
1.3.13.1. 功能描述
删除引擎
1.3.13.2. 请求地址
属性 |
值 |
url |
/incresa/engine/get_engine |
http方法 |
delete |
1.3.13.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
engine_id |
int |
|
引擎id |
是 |
1.3.13.4. 响应示例
{
"result": {},
"code": 200,
"mix_msg": "",
"msg": "删除引擎成功",
"mix_code": 160203,
"mix_ext": ""
}
1.3.14. 获取结果
1.3.14.1. 功能描述
获取计算结果
1.3.14.2. 请求地址
属性 |
值 |
url |
/incresa/result/get_result |
http方法 |
post |
1.3.14.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
equipment_name |
string |
|
设备名称 |
否 |
project_name |
string |
|
项目名称 |
否 |
algorithm_id |
int |
|
算法表示 |
否 |
page_index |
int |
|
页数 |
是 |
page_size |
int |
|
每页个数 |
是 |
1.3.14.4. 响应示例
{
"code": 200,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "",
"msg": "search success!",
"result": {
"all_count": 2,
"data": [
{
"algorithm_id": 1,
"created": "2019-07-04 15:44:45",
"description": "",
"equipment_id": "1162",
"equipment_name": "海普空压机2",
"project_id": 1,
"project_name": "1",
"result_id": 3524,
"result_name": "1result",
"value": "{'cycle_flag': 1, 'cycle_start_time': 1562224480, 'cycle_end_time': 1562226285, 'zero_reference_line': 91920071.73, 'incresa_value': 0.11, 'total_incresa': 0.35, 'cycle_times': 3, 'cycle': 0.5}"
},
{
"algorithm_id": 2,
"created": "2019-07-04 15:38:58",
"description": "",
"equipment_id": "1162",
"equipment_name": "海普空压机2",
"project_id": 10,
"project_name": "1",
"result_id": 3522,
"result_name": "10result",
"value": "{'skew_value': 37.61, 'cycle_times': 7, 'cycle': 0.2, 'standard_value': [0.45, 100.0, 400.0]}"
}
],
"page_index": 1,
"page_size": 50
}
}
1.3.15. 获取结果详情
1.3.15.1. 功能描述
获取某一项目某一设备的计算结果详情
1.3.15.2. 请求地址
属性 |
值 |
url |
/incresa/result/get_result |
http方法 |
post |
1.3.15.3. 请求参数
参数名称 |
数据类型 |
长度/字节 |
描述 |
是否必选 |
token |
string |
|
用户身份令牌 |
是 |
equipment_id |
int |
|
设备id |
是 |
project_id |
int |
|
项目id |
是 |
page_index |
int |
|
页数 |
是 |
page_size |
int |
|
每页个数 |
是 |
1.3.15.4. 响应示例
{
"code": 200,
"mix_code": 163501,
"mix_ext": "",
"mix_msg": "",
"msg": "search success!",
"result": {
"all_count": 2,
"data": [
{
"algorithm_id": 1,
"created": "2019-07-04 13:33:31",
"description": "",
"equipment_id": "1161",
"equipment_name": "海普空压机2",
"project_id": 1,
"project_name": "1",
"result_id": 3501,
"result_name": "1result",
"value": "{'cycle_flag': 1, 'cycle_start_time': 1562216605, 'cycle_end_time': 1562218410, 'incresa_value': 0.092, 'total_incresa': 0.941, 'cycle_times': 39, 'cycle': 0.5, 'zero_reference_line': 117656478.27}"
},
{
"algorithm_id": 1,
"created": "2019-07-04 15:44:45",
"description": "",
"equipment_id": "1161",
"equipment_name": "海普空压机2",
"project_id": 1,
"project_name": "1",
"result_id": 3524,
"result_name": "1result",
"value": "{'cycle_flag': 1, 'cycle_start_time': 1562224480, 'cycle_end_time': 1562226285, 'zero_reference_line': 91920071.73, 'incresa_value': 0.11, 'total_incresa': 0.35, 'cycle_times': 3, 'cycle': 0.5}"
}
],
"page_index": 1,
"page_size": 50
}
}
1.3.16. 获取用户信息
1.3.16.1. 功能描述
查询用户信息
1.3.16.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_info |
http方法 |
post |
1.3.16.3. 请求参数
无
1.3.16.4. 响应示例
{
"code": 200,
"mix_code": 163001,
"mix_ext": "",
"mix_msg": "",
"msg": "获取用户信息成功",
"result": {
"account_list": "",
"address": null,
"boss_sync": 0,
"client_list": "ADMIN,APP,MixAgent,MixPassport,MixPortal,MixPro,MixReport,MixWorks",
"created": "2018-06-14 20:00:00",
"customer_id": null,
"description": null,
"email": "admin@mixlinker.com",
"extension": "",
"group_list": null,
"is_available": 1,
"is_super": 1,
"mobile": "13867953848",
"phone": null,
"position": null,
"realname": "",
"reference": "mixlinker.pro.admin",
"script": "",
"sex": "男",
"template": "",
"ticket": "qsjU19rmNRFR4gsMYzZDQLL72SZmmSGa",
"url": "http://192.168.1.99:9007",
"user_id": 1000,
"username": "admin"
}
}
1.3.17. 获取版本信息
1.3.17.1. 功能描述
查询版本信息
1.3.17.2. 请求地址
属性 |
值 |
url |
/incresa/project/get_version |
http方法 |
post |
1.3.17.3. 请求参数
无
1.3.17.4. 响应示例
{
"code": 200,
"mix_code": "",
"mix_ext": "",
"mix_msg": "",
"msg": "获取版本信息成功",
"result": "V0.0.1"
}