# 设备资源API
TIP
所以资源类API都需要在请求头中携带认证参数才可以正常返回。
# 认证参数
| 参数 | 数据类型 | 是否必须 | 值 |
|---|---|---|---|
| Authorization | String | 是 | Bearer {Access Token} |
# 1.获取设备列表
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| pageNum | int | 否 | 当前页，默认1 |
| pageSize | int | 否 | 每页数量，默认1000 |
| productId | int | 否 | 产品Id |
| projectId | int | 否 | 项目Id |
| deviceIdList | Array | 否 | 设备Id数组 |
| categoryId | String | 否 | 系统Id |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| total | Long | 设备总数 |
| list | Array | 设备数组 |
| pageNum | int | 当前页 |
| pageSize | int | 每页数量 |
| pages | int | 总页数 |
| deviceId | String | 设备唯一id |
| deviceName | String | 设备名称 |
| deviceAddr | String | 设备通讯ID |
| deviceCode | String | 设备编码 |
| viewConnStatus | Integer | 设备状态 0-离线 1-在线 2-告警 3-故障 |
| projectId | Integer | 项目id |
| projectName | String | 项目名称 |
| productId | Integer | 产品id |
| productName | String | 产品名称 |
| categoryId | Integer | 所属系统ID |
| categoryName | String | 所属系统名称 |
# 返回示例
展开查看
{
"msg": "操作成功",
"code": 200,
"data": {
"total": 2,
"list": [
{
"deviceId": 1,
"deviceName": "升级测试设备",
"deviceAddr": "test1",
"deviceCode": "feisjy_gateway01",
"viewConnStatus": 0,
"projectId": 1,
"projectName":"默认项目" ,
"productId": 1,
"productName": "升级产品",
"categoryId": 1,
"categoryName": "排水系统",
},
{
"deviceId": 2,
"deviceName": "测试设备_copy",
"addr": "test2",
"deviceCode": "test2",
"viewConnStatus": 1,
"projectId": 1,
"projectName":"默认项目" ,
"productId": 1,
"productName": "升级产品",
"categoryId": 1,
"categoryName": "排水系统",
}
],
"pageNum": 1,
"pageSize": 10,
"pages": 1
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 在线调试
分页获取设备列表
请求路径
http://iot.feisjy.com/open/device/getDevicePage
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 2.获取设备详情
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceId | Integer | 是 | 设备id |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| deviceId | String | 设备唯一id |
| deviceName | String | 设备名称 |
| addr | String | 设备通讯ID |
| deviceCode | String | 设备编码 |
| viewConnStatus | Integer | 设备状态 0-离线 1-在线 2-报警 3-故障 |
| projectId | Integer | 项目id |
| projectName | String | 项目名称 |
| productId | Integer | 产品id |
| productName | String | 产品名称 |
| categoryId | Integer | 所属系统ID |
| categoryName | String | 所属系统名称 |
| equipmentAccount | Object | 设备台账信息（内部参数见下） |
| manufacturer | String | 生产厂家 |
| factoryModel | String | 出厂型号 |
| factoryNumber | String | 出厂编号 |
| useAgeLimit | Integer | 使用年限 |
| factoryDate | String | 出厂日期 |
| purchaseDate | String | 购买日期 |
| installationDate | String | 安装日期 |
| acceptanceDate | String | 验收日期 |
| putIntoProductionDate | String | 投运日期 |
| deviceParameters | String | 设备参数 |
| influencesRange | String | 影响范围 |
| deviceImgPath | String | 设备图片URL |
| principal | String | 负责人 |
| contactInformation | String | 联系方式 |
| installationLocation | String | 安装位置 |
| property | Array | 点位对象数组（对象参数如下） |
| name | String | 点位名称 |
| value | String | 点位当前值 |
| group | String | 点位类型：yx-遥信；yc-遥测 |
| dataType | String | 数据类型：float、bool（0，1） |
| readWriteType | String | 读写类型，r：只读，rw：读写 |
| code | Integer | 点位编码 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data":{
"deviceId": 1,
"deviceName": "升级测试设备",
"deviceAddr": "test1",
"deviceCode": "feisjy_gateway01",
"viewConnStatus": 0,
"projectId": 1,
"projectName":"默认项目" ,
"productId": 1,
"productName": "升级产品",
"categoryId": 1,
"categoryName": "排水系统",
"baiduLatitude": 22.548457,
"baiduLongitude": 114.064552,
"geographicLocation": "广西壮族自治区柳州市城中区文昌路66文昌综合楼"
"equipmentAccount":{
"manufacturer": "测试厂家",
"factoryModel": "S001",
"factoryNumber": "C202203221133001",
"useAgeLimit": 10,
"factoryDate": "2022-03-21",
"purchaseDate": "2022-03-22",
"installationDate": "2022-03-23",
"acceptanceDate": "2022-03-24",
"putIntoProductionDate": "2022-03-25",
"deviceParameters": "功率",
"influencesRange": "五号厂区",
"principal": "张三",
"contactInformation": "17677607777",
"installationLocation": "五号厂房"
},
"property": [
{
"name": "温度",
"value": "100.0",
"group": "yc",
"dataType": "float",
"readWriteType": "rw"
"code": 1
},
{
"name": "湿度",
"value": "10.0",
"group": "yc",
"dataType": "float",
"readWriteType": "r"
"code": 2
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# 在线调试
获取设备详情
请求路径
http://iot.feisjy.com/open/device/getDeviceDetail
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 3.获取设备模型
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceId | Integer | 是 | 设备id数组 |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| yxList | List | 遥信列表 |
| ycList | List | 遥测列表 |
| deviceId | Integer | 设备ID |
| name | String | 设备名称 |
| code | Integer | 设备编码 |
| identifier | Integer | 唯一标识 |
| readWriteType | int | 0-只读；1-读写 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": {
"yxList": [
{
"deviceId": 12150,
"name": "通讯故障",
"code": 254,
"identifier": null,
"readWriteType": 1,
}
],
"ycList": [
{
"deviceId": 12150,
"name": "水位",
"code": 1,
"identifier": null,
"readWriteType": 0,
},
{
"deviceId": 12150,
"name": "瞬时流量",
"code": 3,
"identifier": null,
"readWriteType": 1,
},
{
"deviceId": 12150,
"name": "瞬时流速",
"code": 4,
"identifier": null,
"readWriteType": 1,
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 在线调试
获取设备数据模型
请求路径
http://iot.feisjy.com/open/device/getDeviceMeasuringPointData
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 4.获取设备实时数据
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceIdList | Array | 是 | 设备ID数组 |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| deviceId | Integer | 设备ID |
| code | Integer | 设备编码 |
| name | String | 设备名称 |
| value | String | 当前值 |
| group | String | 所属分组：yx(遥信)，yx(遥测) |
| dataType | String | 数据类型：float，bool，string |
| sampleTime | String | 采样时间（时间戳形式） |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": [
{
"deviceId": 1,
"property": [
{
"value":"0" ,
"sampleTime": "1621851565000",
"group":"yx" ,
"dataType":"bool" ,
"name": "测试遥信1",
"code": 1
},
{
"value": 16.3,
"sampleTime": "1621851565000",
"group": "yc",
"dataType":"float" ,
"name": "测试遥测1",
"code": 2
}
]
},
{
"deviceId": 2,
"property": [
{
"value":"1",
"sampleTime": "1622258268000",
"group":"yc" ,
"dataType":"float" ,
"name": "测试遥测1",
"code": 1
},
]
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 在线调试
获取设备实时数据
请求路径
http://iot.feisjy.com/open/device/getDeviceRealData
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 5.获取设备历史数据
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceId | Integer | 是 | 设备ID |
| propertyList | Array | 是 | 点位数组 |
| group | String | 是 | 点位分组yc/yx |
| code | Integer | 是 | 测点编码 |
| startTime | Long | 是 | 起始时间，毫秒级时间戳 |
| endTime | Long | 是 | 结束时间，毫秒级时间戳 |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| code | Integer | 测点编码 |
| deviceId | Integer | 设备ID |
| group | String | 分组 |
| historyData | Array | 历史数据 |
| sampleTime | Long | 毫秒级时间戳 |
| signalValue | String | 数据值 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": [
{
"code": 1,
"deviceId": 28163,
"historyData": [
{
"signalValue": "6760.3",
"signalCode": 1,
"sampleTime": "2023-02-22 19:30:14"
},
{
"signalValue": "6760.3",
"signalCode": 1,
"sampleTime": "2023-02-22 19:31:15"
},
{
"signalValue": "6760.3",
"signalCode": 1,
"sampleTime": "2023-02-22 19:32:16"
},
{
"signalValue": "6760.33",
"signalCode": 1,
"sampleTime": "2023-02-22 19:33:17"
},
{
"signalValue": "6760.33",
"signalCode": 1,
"sampleTime": "2023-02-22 19:34:18"
},
{
"signalValue": "6760.33",
"signalCode": 1,
"sampleTime": "2023-02-22 19:35:19"
},
{
"signalValue": "6760.35",
"signalCode": 1,
"sampleTime": "2023-02-22 19:36:20"
},
{
"signalValue": "6760.35",
"signalCode": 1,
"sampleTime": "2023-02-22 19:37:21"
}
],
"group": "yc"
},
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# 在线调试
获取设备历史数据
请求路径
http://iot.feisjy.com/open/device/getDeviceHistory
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 6.获得点位历史数据
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceId | Integer | 是 | 设备ID |
| code | Integer | 是 | 点位编码 |
| group | String | 是 | 点位分组（yx-遥信；yc-遥测） |
| startTime | Long | 是 | 起始时间，毫秒级时间戳 |
| endTime | Long | 是 | 结束时间，毫秒级时间戳 |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| historyDataList | Array | 历史数据数组 |
| historyDataListCount | Integer | 历史数据总数 |
| code | Integer | 遥信编码 |
| sampleTime | Long | 毫秒级时间戳 |
| value | Integer | 数据值 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": [
{
"code": 1,
"value": "6760.3",
"sampleTime": 1677065414000
},
{
"code": 1,
"value": "6760.3",
"sampleTime": 1677065475000
},
{
"code": 1,
"value": "6760.3",
"sampleTime": 1677065536000
},
{
"code": 1,
"value": "6760.33",
"sampleTime": 1677065597000
},
{
"code": 1,
"value": "6760.33",
"sampleTime": 1677065658000
},
{
"code": 1,
"value": "6760.33",
"sampleTime": 1677065719000
},
{
"code": 1,
"value": "6760.35",
"sampleTime": 1677065780000
},
{
"code": 1,
"value": "6760.35",
"sampleTime": 1677065841000
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# 在线调试
获取点位历史数据
请求路径
http://iot.feisjy.com/open/device/getPropertyHistory
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 7.获得设备告警
# 请求参数
| 参数 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| deviceIdList | Array | 否 | 设备Id数组 |
| projectId | Integer | 否 | 项目Id |
| pageNum | Integer | 否 | 当前页，默认1 |
| pageSize | Integer | 否 | 每页数量，默认20-最大1000 |
| startTime | Long | 否 | 开始时间 |
| endTime | Long | 否 | 结束时间 |
| level | String | 否 | 告警等级（notify-告知；secondary-次要；serious-严重；fault-紧急） |
# 返回参数
| 参数 | 数据类型 | 参数说明 |
|---|---|---|
| total | Int | 告警总数 |
| list | Array | 告警数组 |
| pageNum | int | 当前页 |
| pageSize | int | 每页数量 |
| pages | int | 总页数 |
| description | String | 告警描述 |
| level | String | 等级:notify-通知；alarm-告警；fault-故障 |
| tag | String | 恢复标记:notRecovered-未恢复；automaticRecovery-自动恢复；manualRecovery-手动恢复 |
| produceTime | Long | 告警时间,毫秒级时间戳 |
| recoveryTime | Long | 恢复时间，毫秒数时间戳 |
| outputParameter | Array | 输出参数对象数组（对象参数如下） |
| parameterName | String | 参数名称 |
| parameterType | Integer | 参数类型：0-文本；1-图片；2-文件 |
| parameterValue | String | 参数值 |
| outputProperty | Array | 输出点位数组（对象类型如下） |
| deviceId | Integer | 设备ID |
| group | String | 点位类型：yx-遥信；yc-遥测 |
| code | Integer | 点位编码 |
| value | String | 点位值 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": {
"total": 1,
"list": [
{
"description": "消防水压压力过低",
"level": 1,
"tag": 1,
"value": 1,
"produceTime": 1623725603240,
"recoveryTime": 1623725603240,
"outputParameter":[
{
"parameterName": "图片",
"parameterType": 1,
"parameterValue": "[\"https://iot.qhfct.com/data/eventPic/2022/03/22/d8675421aa16d8379b120ceefa3511a3.jpg\"]"
},
{
"parameterName": "详情",
"parameterType": 0,
"parameterValue": "犬类识别"
}
]
}
],
"pageNum": 1,
"pageSize": 10,
"pages": 1
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 在线调试
获取设备警告
请求路径
http://iot.feisjy.com/open/device/getDeviceAlertHistory
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
# 8.获取设备位置
# 请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| deviceIds | Array | 是 | 设备id列表 |
# 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| deviceId | Integer | 设备id |
| longitude | Double | WGS84 经度 |
| latitude | Double | WGS84 纬度 |
| baiduLongitude | Double | 百度 经度 |
| baiduLatitude | Double | 百度 经度 |
| location | String | 定位地址 |
# 返回示例
点击展开
{
"msg": "操作成功",
"code": 200,
"data": [
{
"deviceId": 1,
"longitude": 113.8835220336914,
"latitude": 22.780942916870117,
"baiduLongitude": 113.89484314141052,
"baiduLatitude": 22.784252340045242,
"location": "广东省深圳市****"
{
"deviceId": 2,
"longitude": 113.8835220336914,
"latitude": 22.780942916870117,
"baiduLongitude": 113.89484314141052,
"baiDuLatitude": 22.784252340045242,
"location": "广东省深圳市****"
}},
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
获取设备位置
请求路径
http://iot.feisjy.com/open/device/getDeviceLocation
请求方法
POSTAPI参数需要包含在请求的Body中，如果有认证参数需要包含在Headers中。
请求参数
返回结果
← 认证API