1. MIX.IOT.2018.F.12.01-APIX API

1.1. 请求地址

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

1.2. 请求说明

固定传参

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

参考

Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

1.3. 响应说明

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

状态码说明：

1.4. 接口列表

code含义
500系统内部错误
400参数错误
200执行成功

1.4.1. 获取最新一个栅格数据

1.4.1.1. 功能描述

通过适配器id去获取最新的栅格数据

属性值
url/v1/apix/lastGrid
http方法get

1.4.1.2. 请求参数

参数名称数据类型长度/字节描述是否必选
aprus_idstring适配器id必选
topicstring报文类型,r/n/i/../all(所有报文)必选

1.4.1.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestring栅格写入时间必选
payloadjson栅格json数据必选
topicstring报文类型,r/n/i/../all(所有报文)必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": [
  5.         {
  6.             "payload": {
  7.                 "csq": 30
  8.             },
  9.             "time": "2018-10-15 16:10:51",
  10.             "topic": "g/A22016122100042/r"
  11.         }
  12.     ]
  13. }

1.4.2. 获取某个时刻的栅格数据

1.4.2.1. 功能描述

通过适配器id去获取完全与指定时间一致,或者指定之间后的第一个的栅格数据

属性值
url/v1/apix/gridBytime
http方法get

1.4.2.2. 请求参数

参数名称数据类型长度/字节描述是否必选
aprus_idstring适配器id必选
timedatetime时间必选
topicstring报文类型,r/n/i/../all(所有报文)必选

1.4.2.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestring栅格写入时间必选
payloadjson栅格json数据必选
topicstring报文类型,r/n/i/../all(所有报文)必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": [
  5.         {
  6.             "payload": {
  7.                 "csq": 30
  8.             },
  9.             "time": "2018-10-15 16:10:51",
  10.             "topic": "g/A22016122100042/r"
  11.         }
  12.     ]
  13. }

1.4.3. 获取指定数量的最新的grid

1.4.3.1. 功能描述

属性值
url/v1/apix/latestGridsByItems
http方法get

1.4.3.2. 请求参数

参数名称数据类型长度/字节描述是否必选
aprus_idstring适配器id必选
itemsint条数必选
topicstring报文类型,r/n/i/../all(所有报文)必选

1.4.3.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestring栅格写入时间必选
payloadjson栅格json数据必选
topicstring报文类型,r/n/i/../all(所有报文)必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "payload": {
  8.                     "csq": 30
  9.                 },
  10.                 "time": "2018-10-15 16:10:51",
  11.                 "topic": "g/A22016122100042/r"
  12.             },
  13.             {
  14.                 "payload": {
  15.                     "L1_3_0": 3159.9446,
  16.                     "L1_3_14": 268.6875,
  17.                     "L1_3_16": 502220.7813,
  18.                     "L1_3_20": 916621,
  19.                     "L1_3_4": 0,
  20.                     "L1_3_6": 0.4047
  21.                 },
  22.                 "time": "2018-10-15 16:10:38",
  23.                 "topic": "g/A22016122100042/r"
  24.             }
  25.         ]
  26.     }
  27. }

1.4.4. 获取一个时间段的栅格数据

1.4.4.1. 功能描述

属性值
url/v1/apix/latestGridsByDuration
http方法post
Content-Typemultipart/form-data

1.4.4.2. 请求参数

参数名称数据类型长度/字节描述是否必选
aprus_idstring适配器id必选
start_timedatetime开始时间可选
end_timedatetime结束时间可选
page_sizeint显示条数必选
page_indexint当前页码必选
topicstring报文类型,r/n/i/../all(所有报文)必选

1.4.4.3. 响应参数

参数名称数据类型长度/字节描述是否必选
resultarray数据结果集必选
timestring各个时间点必选
aprusidstring适配器id必选
playloadjson适配器键值对必选
timedatetime采集时间必选
topicstring报文标题必选
page_indexint当前页码必选
page_sizeint显示条数必选
total_pagesint页数必选
total_recordsint条数必选
  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "payload": {
  8.                     "A1_3_7_14": 1,
  9.                     "A1_3_7_3": 1,
  10.                     "F1_3_74": "0000",
  11.                     "F1_3_76": "0000",
  12.                     "L1_3_0": 0.57,
  13.                     "L1_3_1": 58,
  14.                     "L1_3_7_0": 1,
  15.                     "L1_3_7_1": 1,
  16.                     "L1_3_9": 1,
  17.                     "Z": 1
  18.                 },
  19.                 "time": "2018-06-12 11:39:31",
  20.                 "topic": "g/A22018060909002/r"
  21.             },
  22.             {
  23.                 "payload": {
  24.                     "A1_3_7_14": 1,
  25.                     "A1_3_7_3": 1,
  26.                     "F1_3_74": "0000",
  27.                     "F1_3_76": "0000",
  28.                     "L1_3_0": 0.85,
  29.                     "L1_3_1": 71,
  30.                     "L1_3_7_0": 1,
  31.                     "L1_3_7_1": 1,
  32.                     "L1_3_9": 1,
  33.                     "Z": 1
  34.                 },
  35.                 "time": "2018-06-12 11:39:30",
  36.                 "topic": "g/A22018060909002/r"
  37.             }
  38.         ],
  39.         "page_index": 1,
  40.         "page_size": 1,
  41.         "total_pages": 10,
  42.         "total_records": 10
  43.     }
  44. }

1.4.5. 根据key,获取一段时间的拼图数据

1.4.5.1. 功能描述

通过指定的几个key值，来获取一段时间内 分页mosaic数据

属性值
url/v1/apix/mosaicByKey
http方法post
Content-Typemultipart/form-data

1.4.5.2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备标识必选
start_timedateime开始时间
end_timedatetime结束时间
page_sizeint每页条数必选
page_indexint当前页必选
keysjsonmosaic key值 数组必选

请求示例：

  1. equipment_id: E_86106431386780
  2. start_time:
  3. end_time:
  4. page_size: 15
  5. page_index: 1
  6. keys:["S01","S04","S06","S10"]

1.4.5.3. 响应参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备标识必选
start_timedateime开始时间
end_timedatetime结束时间
page_sizeint每页条数必选
page_indexint当前页必选
keysjson-mosaic key值 数组必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "page_index": 1,
  6.         "page_size": 2,
  7.         "total_pages": 5709172,
  8.         "total_records": 11418344,
  9.         "data": [
  10.             {
  11.                 "time": "2018-10-15 16:10:49",
  12.                 "value": {
  13.                     "Y01-1": 0.49,
  14.                     "Y11-1": 75,
  15.                     "Y19-1": 1479,
  16.                     "Y21-1": 1479
  17.                 }
  18.             },
  19.             {
  20.                 "time": "2018-10-15 16:10:17",
  21.                 "value": {
  22.                     "Y01-1": 0.51,
  23.                     "Y11-1": 75,
  24.                     "Y19-1": 1479,
  25.                     "Y21-1": 1479
  26.                 }
  27.             }
  28.         ]
  29.     }
  30. }

1.4.6. 生成excel文件

1.4.6.1. 1. 功能描述

将当前页的历史数据生成excel文件，返回文件的路径和文件名称

属性值
url/v1/apix/mosaicImport
http方法post
Content-Typemultipart/form-data

1.4.6.2. 2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备标识必选
start_timedateime开始时间
end_timedatetime结束时间
page_sizeint每页条数必选
page_indexint当前页必选
keysjsonmosaic key值 数组必选
titlejson标题栏，各项值（设备号和采集时间除外）必选

请求示例：

  1. equipment_id: E_86106431386780
  2. start_time:
  3. end_time:
  4. page_size: 15
  5. page_index: 1
  6. keys:["SteamCumulativeFlow","SteamInstantaneousFlow","FeedWaterTotalFlow","FeedwaterInstantaneousFlow","WaterPressure","BoilerWaterTemperature","MeterReadings","FurnaceNegativePressure","TotalCumulativeFuelReading","CurrentBlowerInstantaneous","CurrentBlowerAverage","BlowerFrequency","CurrentInducedDraftFanInstantaneous","CurrentFanAverage","FanFrequency"]
  7. Title：["蒸汽累计流量","蒸汽瞬时流量","给水累计流量","给水瞬时流量","给水压力","锅炉给水温度","电能表读数","炉膛负压","燃料累计读数","鼓风机瞬时电流","鼓风机平均电流","鼓风机频率","引风机瞬时电流"]

1.4.6.3. 3. 响应参数

参数名称数据类型长度/字节描述是否必选
fileNamestring文件名必选
pathstring文件路径必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "操作成功",
  4.     "result": {
  5.         "fileName": "2018-06-07equipment.xls",
  6.         "path": "file/download/"
  7.     }
  8. }

1.4.7. 文件下载

1.4.7.1. 1. 功能描述

根据文件路径和文件名下在文件

属性值
url/v1/apix/downloadFile
http方法get

1.4.7.2. 2. 请求参数

参数名称数据类型长度/字节描述是否必选
fileNamestring文件名必选
pathstring文件路径必选

1.4.7.3. 响应参数

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "操作成功",
  4.     "result": ""
  5. }

1.4.8. 获取数据曲线数据

1.4.8.1. 功能描述

根据文件路径和文件名下在文件

属性值
url/v1/apix/dataLine
http方法post
Content-Typemultipart/form-data

1.4.8.2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备id必选
start_timedatetime开始时间
end_timedatetime结束时间
keysjsonMosaic key值数组必选

1.4.8.3. 响应参数

参数名称数据类型长度/字节描述是否必选
dataarray数据点必选
datatimearray各个时间点必选
intervalarray时间间隔必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "data": {
  6.             "Y01-1": {
  7.                 "data": [
  8.                     "0.49"
  9.                 ],
  10.                 "datetime": [
  11.                     "2018-10-15 16:10:49"
  12.                 ],
  13.                 "interval": [
  14.                     "0s"
  15.                 ],
  16.                 "max": [
  17.                     "0"
  18.                 ],
  19.                 "min": [
  20.                     "0"
  21.                 ]
  22.             },
  23.             "Y11-1": {
  24.                 "data": [
  25.                     "75"
  26.                 ],
  27.                 "datetime": [
  28.                     "2018-10-15 16:10:49"
  29.                 ],
  30.                 "interval": [
  31.                     "0s"
  32.                 ],
  33.                 "max": [
  34.                     "75"
  35.                 ],
  36.                 "min": [
  37.                     "75"
  38.                 ]
  39.             },
  40.             "Y19-1": {
  41.                 "data": [
  42.                     "1479"
  43.                 ],
  44.                 "datetime": [
  45.                     "2018-10-15 16:10:49"
  46.                 ],
  47.                 "interval": [
  48.                     "0s"
  49.                 ],
  50.                 "max": [
  51.                     "1479"
  52.                 ],
  53.                 "min": [
  54.                     "1479"
  55.                 ]
  56.             },
  57.             "Y21-1": {
  58.                 "data": [
  59.                     "1479"
  60.                 ],
  61.                 "datetime": [
  62.                     "2018-10-15 16:10:49"
  63.                 ],
  64.                 "interval": [
  65.                     "0s"
  66.                 ],
  67.                 "max": [
  68.                     "1479"
  69.                 ],
  70.                 "min": [
  71.                     "1479"
  72.                 ]
  73.             }
  74.         }
  75.     }
  76. }

1.4.9. 获取最新最新的mosaic

1.4.9.1. 功能描述

属性值
url/v1/apix/lastMosaic
http方法get

1.4.9.2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备id必选

1.4.9.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestringMosaic 生成时间必选
valuestringMosaic key-value值必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": [
  5.         {
  6.             "time": "2018-10-15 16:10:49",
  7.             "value": {
  8.                 "Y01-1": 0.49,
  9.                 "Y02-1": 78,
  10.                 "Y03-1": 53.3,
  11.                 "Y04-1": 1,
  12.                 "Y06-1": 0.15,
  13.                 "Y07-1": 388,
  14.                 "Y08-1": 12,
  15.                 "Y09-1": 0,
  16.                 "Y10-1": 0,
  17.                 "Y11-1": 75,
  18.                 "Y12-1": 65,
  19.                 "Y13-1": 0.5,
  20.                 "Y14-1": 0.55,
  21.                 "Y15-1": 5,
  22.                 "Y16-1": 1479,
  23.                 "Y17-1": 1479,
  24.                 "Y18-1": 1479,
  25.                 "Y19-1": 1479,
  26.                 "Y20-1": 1479,
  27.                 "Y21-1": 1479,
  28.                 "Y22-1": 120,
  29.                 "Y23-1": 45,
  30.                 "Y24-1": 50,
  31.                 "Y25-1": 20,
  32.                 "Y26-1": 0.51,
  33.                 "Y27-1": 75,
  34.                 "Y28-1": 88,
  35.                 "Z": 1,
  36.                 "Z-1": 1
  37.             }
  38.         }
  39.     ]
  40. }

1.4.10. 获取某一个时间刻的mosaic数据

1.4.10.1. 功能描述

属性值
url/v1/apix/mosaicByTime
http方法get

1.4.10.2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备id必选
timestringMosaic 生成时间必选

1.4.10.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestringMosaic 生成时间必选
valuestringMosaic key-value值必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": [
  5.         {
  6.             "time": "2018-10-15 14:45:51",
  7.             "value": {
  8.                 "Y01-1": 0.54,
  9.                 "Y02-1": 71,
  10.                 "Y03-1": 0,
  11.                 "Y04-1": 0,
  12.                 "Y06-1": 0.4,
  13.                 "Y07-1": 393,
  14.                 "Y08-1": 9,
  15.                 "Y09-1": 0,
  16.                 "Y10-1": 0,
  17.                 "Y11-1": 75,
  18.                 "Y12-1": 65,
  19.                 "Y13-1": 0.5,
  20.                 "Y14-1": 0.55,
  21.                 "Y15-1": 5,
  22.                 "Y16-1": 1478,
  23.                 "Y17-1": 1478,
  24.                 "Y18-1": 1478,
  25.                 "Y19-1": 1478,
  26.                 "Y20-1": 1478,
  27.                 "Y21-1": 1478,
  28.                 "Y22-1": 120,
  29.                 "Y23-1": 45,
  30.                 "Y24-1": 50,
  31.                 "Y25-1": 20,
  32.                 "Y26-1": 0.51,
  33.                 "Y27-1": 75,
  34.                 "Y28-1": 88,
  35.                 "Z": 0,
  36.                 "Z-1": 1
  37.             }
  38.         }
  39.     ]
  40. }

1.4.11. 获取最新的指定数量的多个拼图数据

1.4.11.1. 功能描述

通过适配器id去获取一段时间最新的栅格数据

属性值
url/v1/apix/latestMosaicByItems
http方法post
Content-Typemultipart/form-data

1.4.11.2. 请求参数

参数名称数据类型长度/字节描述是否必选
equipment_idstring设备id必选
itemsintMosaic 条数必选

1.4.11.3. 响应参数

参数名称数据类型长度/字节描述是否必选
timestringMosaic 生成时间必选
valuestringMosaic key-value值必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "time": "2018-10-15 16:10:49",
  8.                 "value": {
  9.                     "Y01-1": 0.49,
  10.                     "Y02-1": 78,
  11.                     "Y03-1": 53.3,
  12.                     "Y04-1": 1,
  13.                     "Y06-1": 0.15,
  14.                     "Y07-1": 388,
  15.                     "Y08-1": 12,
  16.                     "Y09-1": 0,
  17.                     "Y10-1": 0,
  18.                     "Y11-1": 75,
  19.                     "Y12-1": 65,
  20.                     "Y13-1": 0.5,
  21.                     "Y14-1": 0.55,
  22.                     "Y15-1": 5,
  23.                     "Y16-1": 1479,
  24.                     "Y17-1": 1479,
  25.                     "Y18-1": 1479,
  26.                     "Y19-1": 1479,
  27.                     "Y20-1": 1479,
  28.                     "Y21-1": 1479,
  29.                     "Y22-1": 120,
  30.                     "Y23-1": 45,
  31.                     "Y24-1": 50,
  32.                     "Y25-1": 20,
  33.                     "Y26-1": 0.51,
  34.                     "Y27-1": 75,
  35.                     "Y28-1": 88,
  36.                     "Z": 1,
  37.                     "Z-1": 1
  38.                 }
  39.             },
  40.             {
  41.                 "time": "2018-10-15 16:10:17",
  42.                 "value": {
  43.                     "Y01-1": 0.51,
  44.                     "Y02-1": 79,
  45.                     "Y03-1": 0,
  46.                     "Y04-1": 0,
  47.                     "Y06-1": 0.21,
  48.                     "Y07-1": 389,
  49.                     "Y08-1": 9,
  50.                     "Y09-1": 0,
  51.                     "Y10-1": 0,
  52.                     "Y11-1": 75,
  53.                     "Y12-1": 65,
  54.                     "Y13-1": 0.5,
  55.                     "Y14-1": 0.55,
  56.                     "Y15-1": 5,
  57.                     "Y16-1": 1479,
  58.                     "Y17-1": 1479,
  59.                     "Y18-1": 1479,
  60.                     "Y19-1": 1479,
  61.                     "Y20-1": 1479,
  62.                     "Y21-1": 1479,
  63.                     "Y22-1": 120,
  64.                     "Y23-1": 45,
  65.                     "Y24-1": 50,
  66.                     "Y25-1": 20,
  67.                     "Y26-1": 0.51,
  68.                     "Y27-1": 75,
  69.                     "Y28-1": 88,
  70.                     "Z": 0,
  71.                     "Z-1": 1
  72.                 }
  73.             }
  74.         ]
  75.     }
  76. }

1.4.12. 获取适配器的多媒体数据

1.4.12.1. 功能描述

通过适配器id去获取一段时间最新的栅格数据

属性值
url/v1/apix/getmultlist
http方法post
Content-Typemultipart/multipart/form-data

1.4.12.2. 请求参数

参数名称数据类型长度/字节描述是否必选
client_idstring适配器id可选
payload_typestring适配器报文类型可选
start_timedatetime开始时间可选
end_timedatetime结束时间可选
page_sizeInt显示条数必选
page_indexint当前页必选

1.4.12.3. 响应参数

参数名称数据类型长度/字节描述是否必选
resultarray数据结果集必选
timedatetime采集时间必选
pathstring多媒体路径必选
page_sizeint显示条数必选
page_indexint当前页必选
total_recordsint总条数必选
total_pagesint总页数必选

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "操作成功",
  4.     "result": {
  5.         "data": {
  6.             "result": [{
  7.                 "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/c62e874b59eb88f26252e83e6dca6fed.mp3",
  8.                 "time": "2018-10-11 19:17:36"
  9.             }, {
  10.                 "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/92f7a74f4c6263bb07c5b4bb338223fb.png",
  11.                 "time": "2018-10-11 19:15:22"
  12.             }, {
  13.                 "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/cdb01f3550936766eaeceed647268966.mp4",
  14.                 "time": "2018-10-11 19:01:12"
  15.             }]
  16.         },
  17.         "page_index": 3,
  18.         "page_size": 2,
  19.         "total_pages": 37,
  20.         "total_records": 110
  21.     }
  22. }