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

1.1. 请求地址

HOST:http://xxx.com/path/(具体以系统部署地址为准) 请求地址: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_id string 适配器id 必选
topic string 报文类型,r/n/i/../all(所有报文) 必选

1.4.1.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": [
        {
            "payload": {
                "csq": 30
            },
            "time": "2018-10-15 16:10:51",
            "topic": "g/A22016122100042/r"
        }
    ]
}

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

1.4.2.1. 功能描述

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

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

1.4.2.2. 请求参数

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

1.4.2.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": [
        {
            "payload": {
                "csq": 30
            },
            "time": "2018-10-15 16:10:51",
            "topic": "g/A22016122100042/r"
        }
    ]
}

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

1.4.3.1. 功能描述

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

1.4.3.2. 请求参数

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

1.4.3.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "data": [
            {
                "payload": {
                    "csq": 30
                },
                "time": "2018-10-15 16:10:51",
                "topic": "g/A22016122100042/r"
            },
            {
                "payload": {
                    "L1_3_0": 3159.9446,
                    "L1_3_14": 268.6875,
                    "L1_3_16": 502220.7813,
                    "L1_3_20": 916621,
                    "L1_3_4": 0,
                    "L1_3_6": 0.4047
                },
                "time": "2018-10-15 16:10:38",
                "topic": "g/A22016122100042/r"
            }
        ]
    }
}

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

1.4.4.1. 功能描述

属性
url /v1/apix/latestGridsByDuration
http方法 post
Content-Type multipart/form-data

1.4.4.2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
aprus_id string 适配器id 必选
start_time datetime 开始时间 可选
end_time datetime 结束时间 可选
page_size int 显示条数 必选
page_index int 当前页码 必选
topic string 报文类型,r/n/i/../all(所有报文) 必选

1.4.4.3. 响应参数

参数名称 数据类型 长度/字节 描述 是否必选
result array 数据结果集 必选
time string 各个时间点 必选
aprusid string 适配器id 必选
playload json 适配器键值对 必选
time datetime 采集时间 必选
topic string 报文标题 必选
page_index int 当前页码 必选
page_size int 显示条数 必选
total_pages int 页数 必选
total_records int 条数 必选
{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "data": [
            {
                "payload": {
                    "A1_3_7_14": 1,
                    "A1_3_7_3": 1,
                    "F1_3_74": "0000",
                    "F1_3_76": "0000",
                    "L1_3_0": 0.57,
                    "L1_3_1": 58,
                    "L1_3_7_0": 1,
                    "L1_3_7_1": 1,
                    "L1_3_9": 1,
                    "Z": 1
                },
                "time": "2018-06-12 11:39:31",
                "topic": "g/A22018060909002/r"
            },
            {
                "payload": {
                    "A1_3_7_14": 1,
                    "A1_3_7_3": 1,
                    "F1_3_74": "0000",
                    "F1_3_76": "0000",
                    "L1_3_0": 0.85,
                    "L1_3_1": 71,
                    "L1_3_7_0": 1,
                    "L1_3_7_1": 1,
                    "L1_3_9": 1,
                    "Z": 1
                },
                "time": "2018-06-12 11:39:30",
                "topic": "g/A22018060909002/r"
            }
        ],
        "page_index": 1,
        "page_size": 1,
        "total_pages": 10,
        "total_records": 10
    }
}

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

1.4.5.1. 功能描述

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

属性
url /v1/apix/mosaicByKey
http方法 post
Content-Type multipart/form-data

1.4.5.2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
equipment_id string 设备标识 必选
start_time dateime 开始时间
end_time datetime 结束时间
page_size int 每页条数 必选
page_index int 当前页 必选
keys json mosaic key值 数组

请求示例:

equipment_id: E_86106431386780
start_time:
end_time:
page_size: 15
page_index: 1
keys:["S01","S04","S06","S10"]

1.4.5.3. 响应参数

参数名称 数据类型 长度/字节 描述 是否必选
equipment_id string 设备标识 必选
start_time dateime 开始时间
end_time datetime 结束时间
page_size int 每页条数 必选
page_index int 当前页 必选
keys json - mosaic key值 数组 必选

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "page_index": 1,
        "page_size": 2,
        "total_pages": 5709172,
        "total_records": 11418344,
        "data": [
            {
                "time": "2018-10-15 16:10:49",
                "value": {
                    "Y01-1": 0.49,
                    "Y11-1": 75,
                    "Y19-1": 1479,
                    "Y21-1": 1479
                }
            },
            {
                "time": "2018-10-15 16:10:17",
                "value": {
                    "Y01-1": 0.51,
                    "Y11-1": 75,
                    "Y19-1": 1479,
                    "Y21-1": 1479
                }
            }
        ]
    }
}

1.4.6. 生成excel文件

1.4.6.1. 1. 功能描述

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

属性
url /v1/apix/mosaicImport
http方法 post
Content-Type multipart/form-data

1.4.6.2. 2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
equipment_id string 设备标识 必选
start_time dateime 开始时间
end_time datetime 结束时间
page_size int 每页条数 必选
page_index int 当前页 必选
keys json mosaic key值 数组 必选
title json 标题栏,各项值(设备号和采集时间除外) 必选

请求示例:

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

1.4.6.3. 3. 响应参数

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

响应示例:

{
    "code": 200,
    "message": "操作成功",
    "result": {
        "fileName": "2018-06-07equipment.xls",
        "path": "file/download/"
    }
}

1.4.7. 文件下载

1.4.7.1. 1. 功能描述

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

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

1.4.7.2. 2. 请求参数

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

1.4.7.3. 响应参数

响应示例:

{
    "code": 200,
    "message": "操作成功",
    "result": ""
}

1.4.8. 获取数据曲线数据

1.4.8.1. 功能描述

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

属性
url /v1/apix/dataLine
http方法 post
Content-Type multipart/form-data

1.4.8.2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
equipment_id string 设备id 必选
start_time datetime 开始时间
end_time datetime 结束时间
keys json Mosaic key值数组 必选

1.4.8.3. 响应参数

参数名称 数据类型 长度/字节 描述 是否必选
data array 数据点 必选
datatime array 各个时间点 必选
interval array 时间间隔 必选

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "data": {
            "Y01-1": {
                "data": [
                    "0.49"
                ],
                "datetime": [
                    "2018-10-15 16:10:49"
                ],
                "interval": [
                    "0s"
                ],
                "max": [
                    "0"
                ],
                "min": [
                    "0"
                ]
            },
            "Y11-1": {
                "data": [
                    "75"
                ],
                "datetime": [
                    "2018-10-15 16:10:49"
                ],
                "interval": [
                    "0s"
                ],
                "max": [
                    "75"
                ],
                "min": [
                    "75"
                ]
            },
            "Y19-1": {
                "data": [
                    "1479"
                ],
                "datetime": [
                    "2018-10-15 16:10:49"
                ],
                "interval": [
                    "0s"
                ],
                "max": [
                    "1479"
                ],
                "min": [
                    "1479"
                ]
            },
            "Y21-1": {
                "data": [
                    "1479"
                ],
                "datetime": [
                    "2018-10-15 16:10:49"
                ],
                "interval": [
                    "0s"
                ],
                "max": [
                    "1479"
                ],
                "min": [
                    "1479"
                ]
            }
        }
    }
}

1.4.9. 获取最新最新的mosaic

1.4.9.1. 功能描述

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

1.4.9.2. 请求参数

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

1.4.9.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": [
        {
            "time": "2018-10-15 16:10:49",
            "value": {
                "Y01-1": 0.49,
                "Y02-1": 78,
                "Y03-1": 53.3,
                "Y04-1": 1,
                "Y06-1": 0.15,
                "Y07-1": 388,
                "Y08-1": 12,
                "Y09-1": 0,
                "Y10-1": 0,
                "Y11-1": 75,
                "Y12-1": 65,
                "Y13-1": 0.5,
                "Y14-1": 0.55,
                "Y15-1": 5,
                "Y16-1": 1479,
                "Y17-1": 1479,
                "Y18-1": 1479,
                "Y19-1": 1479,
                "Y20-1": 1479,
                "Y21-1": 1479,
                "Y22-1": 120,
                "Y23-1": 45,
                "Y24-1": 50,
                "Y25-1": 20,
                "Y26-1": 0.51,
                "Y27-1": 75,
                "Y28-1": 88,
                "Z": 1,
                "Z-1": 1
            }
        }
    ]
}

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

1.4.10.1. 功能描述

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

1.4.10.2. 请求参数

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

1.4.10.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": [
        {
            "time": "2018-10-15 14:45:51",
            "value": {
                "Y01-1": 0.54,
                "Y02-1": 71,
                "Y03-1": 0,
                "Y04-1": 0,
                "Y06-1": 0.4,
                "Y07-1": 393,
                "Y08-1": 9,
                "Y09-1": 0,
                "Y10-1": 0,
                "Y11-1": 75,
                "Y12-1": 65,
                "Y13-1": 0.5,
                "Y14-1": 0.55,
                "Y15-1": 5,
                "Y16-1": 1478,
                "Y17-1": 1478,
                "Y18-1": 1478,
                "Y19-1": 1478,
                "Y20-1": 1478,
                "Y21-1": 1478,
                "Y22-1": 120,
                "Y23-1": 45,
                "Y24-1": 50,
                "Y25-1": 20,
                "Y26-1": 0.51,
                "Y27-1": 75,
                "Y28-1": 88,
                "Z": 0,
                "Z-1": 1
            }
        }
    ]
}

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

1.4.11.1. 功能描述

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

属性
url /v1/apix/latestMosaicByItems
http方法 post
Content-Type multipart/form-data

1.4.11.2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
equipment_id string 设备id 必选
items int Mosaic 条数 必选

1.4.11.3. 响应参数

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

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "data": [
            {
                "time": "2018-10-15 16:10:49",
                "value": {
                    "Y01-1": 0.49,
                    "Y02-1": 78,
                    "Y03-1": 53.3,
                    "Y04-1": 1,
                    "Y06-1": 0.15,
                    "Y07-1": 388,
                    "Y08-1": 12,
                    "Y09-1": 0,
                    "Y10-1": 0,
                    "Y11-1": 75,
                    "Y12-1": 65,
                    "Y13-1": 0.5,
                    "Y14-1": 0.55,
                    "Y15-1": 5,
                    "Y16-1": 1479,
                    "Y17-1": 1479,
                    "Y18-1": 1479,
                    "Y19-1": 1479,
                    "Y20-1": 1479,
                    "Y21-1": 1479,
                    "Y22-1": 120,
                    "Y23-1": 45,
                    "Y24-1": 50,
                    "Y25-1": 20,
                    "Y26-1": 0.51,
                    "Y27-1": 75,
                    "Y28-1": 88,
                    "Z": 1,
                    "Z-1": 1
                }
            },
            {
                "time": "2018-10-15 16:10:17",
                "value": {
                    "Y01-1": 0.51,
                    "Y02-1": 79,
                    "Y03-1": 0,
                    "Y04-1": 0,
                    "Y06-1": 0.21,
                    "Y07-1": 389,
                    "Y08-1": 9,
                    "Y09-1": 0,
                    "Y10-1": 0,
                    "Y11-1": 75,
                    "Y12-1": 65,
                    "Y13-1": 0.5,
                    "Y14-1": 0.55,
                    "Y15-1": 5,
                    "Y16-1": 1479,
                    "Y17-1": 1479,
                    "Y18-1": 1479,
                    "Y19-1": 1479,
                    "Y20-1": 1479,
                    "Y21-1": 1479,
                    "Y22-1": 120,
                    "Y23-1": 45,
                    "Y24-1": 50,
                    "Y25-1": 20,
                    "Y26-1": 0.51,
                    "Y27-1": 75,
                    "Y28-1": 88,
                    "Z": 0,
                    "Z-1": 1
                }
            }
        ]
    }
}

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

1.4.12.1. 功能描述

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

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

1.4.12.2. 请求参数

参数名称 数据类型 长度/字节 描述 是否必选
client_id string 适配器id 可选
payload_type string 适配器报文类型 可选
start_time datetime 开始时间 可选
end_time datetime 结束时间 可选
page_size Int 显示条数 必选
page_index int 当前页 必选

1.4.12.3. 响应参数

参数名称 数据类型 长度/字节 描述 是否必选
result array 数据结果集 必选
time datetime 采集时间 必选
path string 多媒体路径 必选
page_size int 显示条数 必选
page_index int 当前页 必选
total_records int 总条数 必选
total_pages int 总页数 必选

响应示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "data": {
            "result": [{
                "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/c62e874b59eb88f26252e83e6dca6fed.mp3",
                "time": "2018-10-11 19:17:36"
            }, {
                "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/92f7a74f4c6263bb07c5b4bb338223fb.png",
                "time": "2018-10-11 19:15:22"
            }, {
                "path": "http://pro.gogogo.mixiot.top/proqy/storage/uploads/multimedia/2018/10/11/cdb01f3550936766eaeceed647268966.mp4",
                "time": "2018-10-11 19:01:12"
            }]
        },
        "page_index": 3,
        "page_size": 2,
        "total_pages": 37,
        "total_records": 110
    }
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2019-09-03 20:07:12

results matching ""

    No results matching ""