接口列表
API Base地址为:https://open.digital.motion.abb.com.cn,以下统称为 DEV_CENTER_BASE_URL
Authorization的获取详见鉴权章节
接口说明¶
接口统一返回格式
{
"payload": null, /*返回的业务数据,对象{} 或者集合[] */
"message": null, /*操作消息*/
"success": true, /*本次请求是否成功 true 或者 false*/
"code": "" /* 响应码, 见响应码对照表 */
}
返回时区为UTC时区
"2021-08-01T02:03:45Z"
设备类型介绍:
设备类型 | 描述 |
---|---|
Drive | 传动 |
Motor | 电机 |
PowerTrain | 传动链 |
注:传动链设备是一个虚拟设备,由一个电机和传动组成,订阅接口、设备管理接口、设备数据接口暂不支持此设备类型
接口列表¶
2.1 组织信息接口列表¶
2.1.1 查询所属组织信息¶
接口说明
获取所在组织的信息
URL:
GET /devcenter/extapi/v1/organization
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/organization' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
无
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 组织ID |
Name | String | 组织名称 |
OrgType | String | 组织类型[ABB|CP|EU] |
Industry | String | 组织所属行业 |
Province | String | 组织所在省份 |
City | String | 组织所在城市 |
District | String | 组织所在地区 |
Address | String | 组织所在地址 |
Contact | String | 组织联系人 |
Phone | String | 组织联系人电话 |
ServiceProviderName | String | EU服务商名称 |
ServiceProviderContactName | String | EU服务商联系人 |
ServiceProviderContactPhone | String | EU服务商联系人电话 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"Id": 12,
"Name": "xx",
"OrgType": "EU",
"Industry": "风电-海洋风力发电",
"Province": "",
"City": "",
"District": "",
"Address": "xx",
"Contact": "xx",
"Phone": "+861xx",
"ServiceProviderName": null,
"ServiceProviderContactName": null,
"ServiceProviderContactPhone": null
},
"message": "操作成功",
"success": true,
"code": 100200
}
2.1.2 查询所属组织的节点¶
接口说明
查询组织所有的设备组、工厂位置和自组织的信息,ABB、CP拥有子组织,但是没有设备组和工厂位置列表,EU组织拥有设备组和工厂位置列表
URL:
GET /devcenter/extapi/v1/organization/nodes
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/organization/nodes' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
无
Node 参数 | 参数类型 | 描述 |
---|---|---|
OrgId | Integer | 组织ID |
OrgName | String | 组织名称 |
OrgType | String | 组织类型 |
AssetGroups | List |
设备组列表(CP没有设备组,EU才有设备组) |
Plants | List |
工厂位置列表(CP没有工厂位置,EU才有工厂位置) |
SubOrgs | List |
服务客户组织(CP服务的EU组织|EU组织不存在服务客户) |
设备组参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备组ID |
Name | String | 设备组名称 |
工厂位置参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 工厂位置ID |
Name | String | 工厂位置名称 |
Province | String | 工厂位置所在省份 |
City | String | 工厂位置所在城市 |
District | String | 工厂位置所在地区 |
Address | String | 工厂位置所在地址 |
Latitude | Double | 工厂位置的纬度 |
Longitude | Double | 工厂位置的经度 |
ZipCode | String | 邮政编码 |
Description | String | 描述 |
CreatedOn | DateTime | 创建时间(ISO8601 标准时间) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"orgId": 2,
"orgName": "xxx",
"orgType": "CP",
"AssetGroups": [],
"Plants": [],
"serverOrgs":[{
"orgId": 2,
"orgName": "xxx",
"AssetGroups": [{
"id": 3,
"name": "xxx"
}],
"Plants":[{
"id": 0,
"name": "string",
"province": "string",
"city": "string",
"district": "string",
"address": "string",
"zipCode": "string",
"latitude": 0,
"longitude": 0,
"description": "string",
"createdOn": "2021-08-27T02:01:03Z",
}],
}]
},
"message": null,
"success": true,
"code": 100200
}
{
"payload": {
"orgId": 2,
"orgName": "xxx",
"orgType": "EU",
"AssetGroups": [{
"id": 3,
"name": "xxx"
}],
"Plants":[{
"id": 0,
"name": "string",
"province": "string",
"city": "string",
"district": "string",
"address": "string",
"zipCode": "string",
"latitude": 0,
"longitude": 0,
"description": "string",
"createdOn": "2021-08-27T02:01:03Z",
}],
"serverOrgs":[]
},
"message": null,
"success": true,
"code": 100200
}
2.1.3 查询EU组织的设备列表¶
接口说明
查询此组织下的设备列表,ABB查询所有EU的设备列表,CP查询被授权EU的设备列表,EU查询拥有的设备列表
URL:
GET /devcenter/extapi/v1/organization/{orgid}/assets
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/organization/{orgid}/assets' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
OrgId | Integer | EU组织ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备ID |
Name | String | 设备名称 |
SerialNumber | String | 设备序列号 |
OrganizationId | Integer | 组织ID |
OrganizationName | String | 组织名称 |
AssetGroupId | Integer | 设备组ID |
AssetGroupName | String | 设备组名称 |
AssetType | String | 设备类型[PowerTrain-传动链|Drive :传动|Motor:电机] |
SubAssets | List |
子设备列表 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": 1,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Drive",
"SubDevices": null
}, {
"id": 2,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Motor",
"SubDevices": null
}, {
"id": 3,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "PowerTrain",
"SubDevices": [{
"id": 12,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Drive",
"SubDevices": null
}, {
"id": 13,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Motor",
"SubDevices": null
}
]
}
],
"message": null,
"success": true,
"code": 100200
}
2.1.4 查询所属设备组的设备列表¶
接口说明
查询此组织下的设备列表,ABB查询所有EU的设备列表,CP查询被授权EU的设备列表,EU查询拥有的设备列表
URL:
GET /devcenter/extapi/v1/organization/{orgid}/assetgroup/{assetgroupid}/assets
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/organization/{orgid}/assetgroup/{assetgroupid}/assets' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
OrgId | Integer | EU组织ID |
assetgroupid | Integer | 设备组ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备ID |
Name | String | 设备名称 |
SerialNumber | String | 设备序列号 |
OrganizationId | Integer | 组织ID |
OrganizationName | String | 组织名称 |
AssetGroupId | Integer | 设备组ID |
AssetGroupName | String | 设备组名称 |
AssetType | String | 设备类型[PowerTrain-传动链|Drive :传动|Motor:电机] |
SubAssets | List |
子设备列表 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": 1,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Drive",
"SubDevices": null
}, {
"id": 2,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Motor",
"SubDevices": null
}, {
"id": 3,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "PowerTrain",
"SubDevices": [{
"id": 12,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Drive",
"SubDevices": null
}, {
"id": 13,
"name": "string",
"serialNumber": "string",
"organizationId": 0,
"organizationName": "string",
"assetGroupId": 0,
"assetGroupName": "string",
"assetType": "Motor",
"SubDevices": null
}
]
}
],
"message": null,
"success": true,
"code": 100200
}
2.1.5 创建新设备组¶
接口说明:
为EU创建新的设备组
URL:
POST /devcenter/extapi/v1/organization/assetgroup
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/Organization/assetgroup' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer xxxxxxx' \
-D '{
"orgId": 10,
"name": "xxxx",
}'
无
请求正文
属性 | 属性类型 | 描述 |
---|---|---|
orgid | Integer | EU组织ID |
name | String | 设备组名称(最大长度为20个字符) |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备组ID |
Name | String | 设备组名称 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id": 13,
"name": "xxxx"
},
"message": null,
"success": true,
"code": 100200
}
2.1.6 组织设备数量统计¶
接口说明:
统计当前组织下的设备总数,CP获取授权EU的统计数量,EU获取组织内的统计数量,仅CP用户请求返回字段DeviceStatistics
URL:
GET /devcenter/extapi/v1/organization/:orgid/asset/statistics
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/organization/:orgid/asset/statistics' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer xxxxxxx'
参数 | 参数类型 | 描述 |
---|---|---|
orgid | Integer | EU/CP组织ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
OrgId | Integer | 组织ID |
CustomerCount | Integer | 授权EU数量 |
Drive | Integer | 传动设备数 |
Motor | Integer | 电机设备数 |
Powertrain | Integer | 传动链设备数 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"DeviceStatistics": [
{
"OrgId": 1,
"CustomerCount": null,
"Drive": 1,
"Motor": 0,
"Powertrain": 0
},
{
"OrgId": 2,
"CustomerCount": null,
"Drive": 12,
"Motor": 0,
"Powertrain": 0
}
],
"OrgId": 3,
"CustomerCount": 2,
"Drive": 13,
"Motor": 0,
"Powertrain": 0
},
"message": "操作成功",
"success": true,
"code": 100200
}
2.2 订阅接口列表¶
2.2.1 设备绑定订阅¶
接口说明:
为设备绑定新的订阅(不支持传动链设备)
! NETA-21设备只能绑定高级订阅
URL:
POST /devcenter/extapi/v1/subscription/bind
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/subscription/bind' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx' \
-D '{
"assetId": 0,
"subscriptionCode": "string"
}'
请求参数:
无
请求正文
属性 | 属性类型 | 描述 |
---|---|---|
assetId | integer | 设备ID |
subscriptionCode | String | 订阅码 |
响应参数: 状态码:200
无
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例,状态码:200
{
"payload": {},
"message": "操作成功",
"success": true,
"code": 100200
}
2.3 设备管理接口列表¶
2.3.1 查询设备信息¶
接口说明:
查询设备的详细信息(暂不支持传动链设备)
URL:
GET /devcenter/extapi/v1/assetmanagement/asset/{id}
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/asset/{id}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
id | Integer | 设备ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备ID |
SerialNumber | String | 设备序列号 |
Name | String | 设备名称 |
AssetType | String | 设备类型[Drive :传动|Motor:电机] |
Organization | String | 所属组织 |
AssetGroup | String | 所属设备组 |
Plant | String | 所属位置名称 |
ModelType | String | 设备型号 |
FirmwareVersion | String | 设备固件版本 |
GatewayType | String | 网关型号 |
GatewaySerialNumber | String | 网关序列号 |
SIMICCID | String | SIMICCID号码 |
LatestDataReceived | DateTime | 最后接收数据的时间(ISO 8601标准时间) |
Address | String | 设备所在地址 |
Longitude | String | 设备地址所在经度 |
Latitude | String | 设备地址所在纬度 |
ExpertService | ExpertService | 专家服务信息 |
CreatedOn | DateTime | 添加时间(ISO 8601标准时间) |
CreatedUserId | Integer | 添加设备人用户ID(2023.05.19前添加的设备为空) |
CreatedUserPhone | String | 添加设备人手机号(2023.05.19前添加的设备为空) |
专家服务参数 | 参数类型 | 描述 |
---|---|---|
ServiceStatus | Integer | 专家服务权益状态[0-权益合同期内|1-合同不存在|2-服务未激活|3-服务未设置] |
serviceType | Integer | 专家服务权益类型[0-未设置|1-一键呼叫|2-主动支持] |
serviceContractStartTime | Long | 专家服务权益合同开始时间(UTC时间戳) |
serviceContractExpiredTime | Long | 专家服务权益合同到期时间(UTC时间戳) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"Id": 12,
"Name": "xx",
"CreatedUserId": 12,
"CreatedUserPhone": "+861xx",
"SerialNumber": "xx",
"AssetType": "Drive",
"Organization": "xx",
"AssetGroupName": "xx",
"Plant": "",
"ModelType": "ACS880",
"FirmwareVersion": "AINL7 v3.42",
"GatewayType": "IOTPanel",
"GatewaySerialNumber": "xx",
"SIMICCID": "xx",
"LatestDataReceived": null,
"Address": "",
"Longitude": "",
"Latitude": "",
"CreatedOn": "2023-05-19T02:12:47Z",
"ExpertService": {
"ServiceStatus": 1,
"ServiceType": 0,
"ServiceContractStartTime": -1,
"ServiceContractExpiredTime": -1
}
},
"message": "操作成功",
"success": true,
"code": 100200
}
2.3.2 查询设备订阅信息¶
接口说明:
获取设备的绑定的订阅列表(暂不支持传动链设备)
URL:
GET /devcenter/extapi/v1/assetmanagement/subscription/{assetid}
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/subscription/{assetid}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
参数 | 参数类型 | 描述 |
---|---|---|
assetid | Integer | 设备ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 订阅的Id |
Code | String | 订阅码 |
Type | String | 订阅的类型[Official-正式|Trial-试用|Taste-体验] |
Level | String | 订阅的等级[Entry-入门版|Basic-基础班|Standard标准版|Premium高级版] |
Status | String | 订阅的状态[Nonactivated-未使用|Activated-激活|Expired-过期] |
ActivedDate | DateTime | 订阅的激活时间 |
ExpiredDate | DateTime | 订阅过期时间 |
Period | Integer | 订阅时长(单位-月) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": 12,
"code": "59C593F7EF614B9EAD20F3B1FF91CE5F",
"type": "Official",
"level": "Standard",
"status": "Activated",
"activedDate": "2021-07-05T15:32:23",
"expiredDate":"2022-07-05T15:32:23",
"period": 12
},{
"id": 13,
"code": "59C593F7EF614B9EAD20F3B1FF92CE5F",
"type": "Official",
"level": "Standard",
"status": "Expired",
"activedDate": "2020-06-01T15:32:23",
"expiredDate":"2021-06-01T15:32:23",
"period": 12
},{
"id": 14,
"code": "59C593F7EF614B9EAD20F3B1FF91EE5F",
"type": "Official",
"level": "Standard",
"status": "Nonactivated",
"activedDate": null,
"expiredDate": null,
"period": 12
}],
"message": null,
"success": true,
"code": 100200
}
2.3.3 创建传动设备¶
接口说明:
添加新的传动设备(暂不支持传动链设备)
-
当设备是IOT Panel的设备,请求正文填写"IOTPanel"的设备相关信息。
-
当设备是NETA-21的设备, 请求正文填写"NETA21"的设备相关信息。
URL:
POST /devcenter/extapi/v1/assetmanagement/asset
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/asset' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"name":"xxxx",
"assetGroupId":12,
"plantId":12,
"serialNumber": "xxxxxx",
"GatewayType": 1, // 1-NETA21|2-IOT Panel
"assetReference":{
"IOTPanel":{
"driveModel": "",
"deviceNodeId": "",
"simiccid": ""
},
"NETA21":{
"gatewaySN": "",
"deviceNodeId": ""
}
}
}'
无
请求正文:
参数 | 参数类型 | 描述 |
---|---|---|
Name | String | 设备名称(最大长度30) |
AssetGroupId | Integer | 设备组ID |
PlantId | Integer | 工厂ID |
SerialNumber | String | 设备序列号(最大长度30) |
GatewayType | Enum | 网关类型(1-NETA21|2-IOT Panel) |
AssetReference | Object | 设备相关信息 |
IOT Panel参数 | 参数类型 | 描述 |
---|---|---|
DriveModel | String | 设备类型 |
DeviceNodeId | String | 设备节点ID(示例:"01") |
SIMICCID | String | 设备的SIMICCID (示例:"89860320492081290952") |
NETA21 参数 | 参数类型 | 描述 |
---|---|---|
GatewaySN | String | 网关序列号 |
DeviceNodeId | String | 设备节点ID(示例:"192168102103") |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备ID |
SerialNumber | String | 设备序列号 |
Name | String | 设备名称 |
AssetType | String | 设备类型[Drive :传动|Motor:电机] |
Organization | String | 所属组织 |
AssetGroup | String | 所属设备组 |
Plant | String | 所属位置名称 |
ModelType | String | 设备型号 |
FirmwareVersion | String | 设备固件版本 |
GatewayType | String | 网关型号 |
GatewaySerialNumber | String | 网关序列号 |
SIMICCID | String | SIMICCID号码 |
LatestDataReceived | DateTime | 最后接收数据的时间(ISO 8601标准时间) |
CreatedOn | DateTime | 添加时间(ISO 8601标准时间) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id":12,
"serialNumber":"xxxx",
"name":"xxxx",
"assetType":"Drive",
"organization":"xxxx",
"assetGroup":"xxxx",
"plant":"xxxx",
"modelType":"xxxx",
"firmwareVersion":"xxxx",
"gatewayType":"xxx",
"gatewaySerialNumber":"xxx",
"SIMICCID":"xxxx",
"latestDataReceived":"xxxx",
"createdOn":"2021-08-03T15:13:23Z"
},
"message": null,
"success": true,
"code": 100200
}
2.3.4 更新设备名称¶
接口说明:
更新设备的名称
URL:
PUT /devcenter/extapi/v1/assetmanagement/asset
curl -X 'PUT' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/asset' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"id": 12,
"name": "xxxxxx"
}'
无
请求正文:
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备Id |
Name | String | 设备名称(最大长度30) |
响应参数: 状态码:200
无
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {},
"message": "操作成功",
"success": true,
"code": 100200
}
2.3.5 更换设备的设备组¶
接口说明:
将设备移动到其他设备组
URL:
PUT /devcenter/extapi/v1/assetmanagement/asset/move
curl -X 'PUT' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/asset/move' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"assetId": 12,
"assetGroupId": 13
}'
无
请求正文:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
AssetGroupId | Integer | 设备组Id |
响应参数: 状态码:200
无
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {},
"message": "操作成功",
"success": true,
"code": 100200
}
2.3.6 删除设备¶
接口说明:
删除设备(暂不支持传动链设备)
URL:
DELETE /devcenter/extapi/v1/assetmanagement/asset/{id}
curl -X 'DELETE' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetmanagement/asset/{id}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 设备Id |
响应参数: 状态码:200
无
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {},
"message": "操作成功",
"success": true,
"code": 100200
}
2.4 设备数据接口列表¶
2.4.1 查询设备的事件¶
接口说明:
查询设备的历史事件(暂不支持传动链设备),查询的时间间隔最大为7天,若时间间隔大于7天,则起止时间超出按照起始时间+7。
-
设备的订阅等级入门版、基础版,可查看设备的90天范围内的历史事件
-
设备的订阅等级标准版、高级版,可查看设备的365天范围内的历史事件
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/event
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/event?startTime='2021-09-02T12:12:12Z'&endTime='2021-09-09T12:12:12Z' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
StartTime | DateTime | 开始时间(ISO8601 标准时间) |
EndTime | DateTime | 结束时间(ISO8601 标准时间) |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Long | 事件ID |
EventType | String | 事件类型[Fault-故障|Warning-告警|Notification-通知] |
EventCode | String | 事件代码 |
EventDateTime | DateTime | 事件的时间(ISO8601 标准时间) |
EventStatus | String | 事件状态[Open-未处理|Close-已处理] |
Content | String | 事件内容 |
CloseReason | String | 事件处理方案 |
CloseAt | DateTime | 事件关闭时间(ISO8601 标准时间) |
DeviceWorkStatus | Integer | 设备工作状态[0-未知|1-运行|2-待机 |
IsHasEventLogger | bool | 是否有事件日志 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": 3233,
"eventType": "Fault",
"eventCode": "64ff",
"eventDateTime": "2021-04-19T01:52:11Z",
"eventStatus": "Close",
"content": "Fault reset",
"closeReason": "测试",
"closeAt": "2021-06-07T08:03:13.39072Z",
"deviceWorkStatus": 1,
"isHasEventLogger": false
}],
"message": null,
"success": true,
"code": 100200
}
2.4.2 查询事件的Logger¶
接口说明:
获取事件的日志文件,文件链接的有效时间为10分钟。
-
设备的订阅等级入门版、基础版,禁止查询事件的日志文件
-
设备的订阅等级标准版、高级版,允许查询事件的日志文件
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/event/{eventid}/eventlogger/file
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/event/{eventid}/eventlogger/file' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
EventId | Long | 事件ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
LoggerId | UUID | 事件日志ID |
LoggerFile | String | 事件日志文件临时下载链接(有效时间10分钟) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"LoggerId":"99F4832C-6FEE-474C-B7FC-FEC4794BFD2C",
"LoggerFile":"xxxxxxxxxxxxx"
}],
"message": null,
"success": true,
"code": 100200
}
2.4.3 查询设备参数配置列表¶
接口说明:
查询设备的Trends、Signals参数配置列表(暂不支持传动链设备)
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/trendsignal/config
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/trendsignal/config' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备组ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Trends | List |
趋势参数列表 |
Signals | List |
信号参数列表 |
Config参数 | 参数类型 | 描述 |
---|---|---|
Name | String | 参数名称 |
Code | String | 参数代码(用于查询此参数时序数据的标识) |
Label | String | 参数标签 |
Unit | String | 参数单位 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"trends":[{
"name": "Energy Consumption(kwh)",
"code": "EnergyConsumption",
"label": "Cumulative Energy Consumption",
"unit": "kWh"
}],
"signals":[{
"name": "NET FREQUENCY (Hz)",
"code": "01.01",
"label": "NET FREQUENCY (Hz)",
"unit": "Hz"
}]
},
"message": null,
"success": true,
"code": 100200
}
2.4.5 查询设备参数时序数据¶
接口说明:
查询设备的趋势数据和信号数据(暂不支持传动链设备),查询的时间间隔最大为30天(查询时间请使用UTC时间进行查询),若时间间隔大于30天,则起止时间超出按照起始时间+30。时间间隔大于1小时,返回的数据是5分钟聚合的数据,反之返回的是原始数据。
-
设备的订阅等级入门版、基础版,可查询90天的历史信号数据
-
设备的订阅等级标准版、高级版,可查询365天的历史信号数据
URL:
POST /devcenter/extapi/v1/assetdata/asset/trendsignal/data
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/asset/trendsignal/data' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"assetId": 11,
"parameters":["EnergyConsumption", "01.01"],
"startTime": "2021-09-02T12:12:12Z",
"endTime": "2021-09-09T12:12:12Z"
}'
请求参数:
无
请求正文
属性 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备组ID |
Parameters | List |
参数列表,传入参数配置的code |
StartTime | DateTime | 开始时间(ISO8601 标准时间) |
EndTime | DateTime | 结束时间(ISO8601 标准时间) |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
ParamDatas | List |
时序数据列表 |
ParamData参数 | 参数类型 | 描述 |
---|---|---|
Config | Config-Object | 参数配置 |
Avg | List | 平均值(若某个采集点没有值,数值是"-",否则是double类型的数值) |
Max | List | 最大值(若某个采集点没有值,数值是"-",否则是double类型的数值) |
Min | List | 最小值(若某个采集点没有值,数值是"-",否则是double类型的数值) |
Value | List | 参数值(若某个采集点没有值,数值是"-",否则是double类型的数值) |
Timestamp | List |
时间戳 |
Config参数 | 参数类型 | 描述 |
---|---|---|
Name | String | 参数名称 |
Code | String | 参数代码(用于查询此参数时序数据的标识) |
Label | String | 参数标签 |
Unit | String | 参数单位 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"ParamDatas": [{
"Config": {
"Name": "网络电流",
"Code": "linecurrent",
"Label": "网络电流",
"Unit": "A"
},
"Avg": [144.2571, 153.1152],
"Max": [541.3246, 584.433],
"Min": [17.4873, 17.696],
"Value": [0.0, 0.0],
"Timestamp": ["1631097300", "1631097600"]
}, {
"Config": {
"Name": "VOLTAGE (%)",
"Code": "01.05",
"Label": "VOLTAGE (%)",
"Unit": "%"
},
"Avg": [102.3053, 102.3],
"Max": [102.5125, 102.4909],
"Min": [101.867, 102.1777],
"Value": [102.3053, 102.3],
"Timestamp": ["1631097300", "1631097600"]
}
]
},
"message": null,
"success": true,
"code": 100200
}
2.4.6 查询设备最新健康指标¶
接口说明:
获取设备的健康指标数据(暂不支持传动链设备):
-
设备的订阅等级入门版,只能查看设备的整体状态指标
-
设备的订阅等级基础版,仅仅不能查运行压力的状态指标
-
设备的订阅等级标准版、高级版,可以查看所有的状态指标
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/condition
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/condition' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Conditions | List |
健康指标状态列表 |
Condition参数 | 参数类型 | 描述 |
---|---|---|
Type | String | 健康指标类型[Overall-总体|Availability-可用性|Environment-环境|Reliability-可靠性|Stress-运行压力] |
Status | String | 健康指标状态[Unknown|Good|Tolerable|Poor] |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"type": "Overall",
"status": "Unknown"
}, {
"type": "Availability",
"status": "Unknown"
}, {
"type": "Environment",
"status": "Unknown"
}, {
"type": "Reliability",
"status": "Unknown"
}, {
"type": "Stress",
"status": "Unknown"
}
],
"message": null,
"success": true,
"code": 100200
}
2.4.7 查询设备预测性维护分析结果¶
接口说明:
查询设备部件最新的寿命维护计划分析结果(暂不支持传动链设备),包含部件状态、维护计划时间点和最近30的日常寿命影响。 - 设备的订阅等级入门版、基础版,禁止查看最新的寿命维护计划分析结果
-
设备的订阅等级标准版、高级版,允许查看最新的寿命维护计划分析结果
-
预计无需计划性维护开始时间、开始计划预防性维护开始时间为空时,表明已是过去的时间。
注: - 目前预测性维护分析只支持ACS800、ACS880设备
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/cbm
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/cbm' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
DeviceUnitType | String | 设备部件类型[Fan-冷却|Capacitor-直流母线电容|IGBT-变流单元] |
DeviceUnitStatus | String | 设备部件的状态[Gray|Good|Yellow|Red] |
PredictedNoPlanDate | DateTime | 预计无需计划性维护开始时间(东八区标准时间) |
PredictedStartPlanDate | DateTime | 开始计划预防性维护开始时间(东八区标准时间) |
PredictedRunPlanDate | DateTime | 建议执行预防性维护开始时间(东八区标准时间) |
DeviceDayKPIs | List |
日常寿命影响列表 |
CBMDayKPI参数 | 参数类型 | 描述 |
---|---|---|
Date | DateTime | 时间(东八区标准时间) |
KPI | Double | 日常寿命影响KPI数值(0.0-未知, 0.01-绿色, 0.5-黄色, 1.0-红色) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"deviceUnitType":"Fan",
"deviceUnitStatus":"Good",
"predictedNoPlanDate": "2020-12-18",
"predictedStartPlanDate":"2029-08-28",
"predictedRunPlanDate":"2030-08-28",
"deviceDayKPIs":[{
"date": "2021-08-01",
"kpi": 0.01
}, {
"date": "2021-08-02",
"kpi": 0.0
}, {
"date": "2021-08-03",
"kpi": 0.5
}, {
"date": "2021-08-04",
"kpi": 0.5
}, {
"date": "2021-08-05",
"kpi": 0.0
}, {
"date": "2021-08-06",
"kpi": 0.01
}, {
"date": "2021-08-07",
"kpi": 0.0
}, {
"date": "2021-08-08",
"kpi": 0.01
}, {
"date": "2021-08-09",
"kpi": 0.01
}, {
"date": "2021-08-10",
"kpi": 0.01
}, {
"date": "2021-08-11",
"kpi": 0.01
}, {
"date": "2021-08-12",
"kpi": 0.0
}, {
"date": "2021-08-13",
"kpi": 0.01
}, {
"date": "2021-08-14",
"kpi": 0.01
}, {
"date": "2021-08-15",
"kpi": 0.0
}, {
"date": "2021-08-16",
"kpi": 0.01
}, {
"date": "2021-08-17",
"kpi": 0.0
}, {
"date": "2021-08-18",
"kpi": 0.5
}, {
"date": "2021-08-19",
"kpi": 0.5
}, {
"date": "2021-08-20",
"kpi": 0.5
}, {
"date": "2021-08-21",
"kpi": 0.0
}, {
"date": "2021-08-22",
"kpi": 0.5
}, {
"date": "2021-08-23",
"kpi": 0.5
}, {
"date": "2021-08-24",
"kpi": 0.5
}, {
"date": "2021-08-25",
"kpi": 0.5
}, {
"date": "2021-08-26",
"kpi": 0.0
}, {
"date": "2021-08-27",
"kpi": 0.01
}, {
"date": "2021-08-28",
"kpi": 0.0
}, {
"date": "2021-08-29",
"kpi": 0.01
}, {
"date": "2021-08-30",
"kpi": 0.01
}
]
}],
"message": null,
"success": true,
"code": 100200
}
2.4.6 更新设备部件调试日期¶
接口说明:
更新部件的调试日期(暂不支持传动链设备)。
-
设备的订阅等级入门版、基础版,禁止查看最新的寿命维护计划分析结果
-
设备的订阅等级标准版、高级版,允许查看最新的寿命维护计划分析结果
注:目前寿命维护计划分析只支持ACS800、ACS880设备
URL:
PUT /devcenter/extapi/v1/assetdata/asset/cbm/unit
curl -X 'PUT' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/asset/cbm/unit' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"assetId": 12,
"deviceUnitType": "1" // 1-Fan|2-IGBT|3-Capacitor
"commissioningdate": "2021-02-03T16:00:00Z" // UTC ISO 8601标准时间
}'
请求参数:
无
请求正文:
属性 | 属性类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
DeviceUnitType | Integer | 设备部件类型(1-Fan|2-IGBT|3-Capacitor) |
Commissioningdate | DateTime | 设备部件调试日期UTC ISO 8601标准时间 |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
DeviceUnitType | Integer | 设备部件类型(1-Fan|2-IGBT|3-Capacitor) |
Commissioningdate | DateTime | 设备部件调试日期UTC ISO 8601标准时间 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"assetId": 0,
"deviceUnitType": "string",
"commissioningdate": "string"
},
"message": "操作成功",
"success": true,
"code": 100200
}
2.4.7 创建用户传动报告¶
接口说明:
创建单设备的传动报告(暂不支持传动链设备),报告时间间隔的最小为7天,最大为90天,设备添加时间小于7天不能创建报告。
-
创建报告是一部生成,用户可通过报告查询接口查询报告的状态,或者订阅设备报告数据,接收报告生成的结果。
-
传动报告:单设备的用户报告;传动编组报告:多设备的用户报告。
-
设备的订阅等级入门版,禁止创建传动报告。
-
设备的订阅等级基础版、标准版、高级版,允许创建传动报告。
URL:
POST /devcenter/extapi/v1/assetdata/asset/report
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/asset/report' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"assetIds":[12],
"title": "xxxxxx",
"subTitle": "xxxxxx",
"reportType": "1", // 1-UserDriveReport, 2-UserFleetReport
"startDateTime": "2021-07-12", // 东八区日期
"endDateTime": "2021-08-12" // 东八区日期
}'
无
请求正文:
参数 | 参数类型 | 描述 |
---|---|---|
AssetIds | List |
设备ID List |
Title | String | 报告标题 |
SubTitle | String | 报告副标题 |
ReportType | Integer | 报告类型[1-UserDriveReport-传动报告|2-UserFleetReport-传动编组报告] |
StartDateTime | DateTime | 报告开始时间 东八区日期 |
EndDateTime | DateTime | 报告结束时间 东八区日期 |
报告类型 | 描述 |
---|---|
UserDriveReport | 用户传动报告-单设备报告 |
UserFleetReport | 用户传动编组报告-多设备报告 |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 报告ID |
Title | String | 报告标题(最大长度50) |
SubTitle | Integer | 报告副标题 (最大长度50) |
ReportType | String | 报告类型[UserDriveReport-传动报告|UserFleetReport-传动编组报告] |
StartDateTime | DateTime | 报告开始时间 ISO 8601标准时间 |
EndDateTime | DateTime | 报告结束时间 ISO 8601标准时间 |
Status | String | 报告状态[Failed|Creating|Created] |
CreatedOn | DateTime | 报告创建时间 ISO 8601标准时间 |
CreatedUser | String | 报告创建人 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id": 201,
"title": "xxxxxxxxxxx",
"subtitle": "xxxxx",
"reportType": "UserDriveReport",
"startDateTime": "2021-07-01T00:00:00Z",
"endDateTime": "2021-08-01T23:59:59Z",
"Status": "Creating",
"createdUser": "ABB专家",
"createdOn": "2021-08-25T05:22:56.804388"
},
"message": null,
"success": true,
"code": 100200
}
2.4.8 查询设备报告列表¶
接口说明
获取设备的报告列表(暂不支持传动链设备)
-
用户只能查询到最近7天的报告
-
设备的订阅等级入门版,禁止查询报告
-
设备的订阅等级基础版、标准版、高级版,允许查询用户报告
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/report
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/report' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 报告ID |
Title | String | 报告标题 |
SubTitle | Integer | 报告副标题 |
ReportType | String | 报告类型[UserDriveReport-传动报告|UserFleetReport-传动编组报告] |
StartDateTime | DateTime | 报告开始时间 ISO 8601标准时间 |
EndDateTime | DateTime | 报告结束时间 ISO 8601标准时间 |
Status | String | 报告状态[Failed|Creating|Created] |
CreatedOn | DateTime | 报告创建时间 ISO 8601标准时间 |
CreatedUser | String | 报告创建人 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": 200,
"title": "xxxxxxxxxxx",
"subtitle": "xxxxx",
"reportType": "UserFleetReport",
"startDateTime": "2021-07-01T00:00:00Z",
"endDateTime": "2021-08-01T23:59:59Z",
"createdUser": "ABB专家",
"createdOn": "2021-08-25T05:22:56.804388"
},{
"id": 201,
"title": "xxxxxxxxxxx",
"subtitle": "xxxxx",
"reportType": "UserDriveReport",
"startDateTime": "2021-07-01T00:00:00Z",
"endDateTime": "2021-08-01T23:59:59Z",
"createdUser": "ABB专家",
"createdOn": "2021-08-25T05:22:56.804388"
}],
"message": null,
"success": true,
"code": 100200
}
2.4.9 下载设备报告¶
接口说明:
接口返回报告的临时下载链接,下载链接有效时长为10分钟(暂不支持传动链设备)。
-
设备的订阅等级入门版,禁止下载报告
-
设备的订阅等级基础版、标准版、高级版,允许下载用户报告
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/report/download/{reportid}
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/report/download/{reportid}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
ReportId | Integer | 报告Id |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | Integer | 报告Id |
FileTemplink | String | 报告文件的临时下载链接 |
Status | String | 报告状态 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"Id": 201,
"fileTemplink": "https://xxxxxxxxxx/InstantAssetReport_xxxxxx_20210825052256946fe5795ce.docx?AccessKeyId=CG1HVIXSG8HFUKN13R84&Expires=1630556399&Signature=hlc5ZBdQgKpDzzjLoSrYDEBg8ZI%3D",
"status": "Created"
},
"message": null,
"success": true,
"code": 100200
}
2.4.10 获取设备参数备份列表¶
接口说明:
接口返回选定时间范围内对应设备的参数备份列表。
-
仅变频器设备支持参数备份列表
-
单次查询日期跨度不应超过365天,最早可查询日期不设限
-
变频器设备的订阅等级不设限
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/parameterbackup/list
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/parameterbackup/list?startUTCTime={startUTCTime}&endUTCTime={endUTCTime}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
StartUTCTime | DateTime | 开始时间 ISO 8601标准时间 |
EndUTCTime | DateTime | 结束时间 ISO 8601标准时间 |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | String | 参数备份Id |
BackupTime | DateTime | 参数备份时间(东八区标准时间) |
Name | String | 参数备份名称 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [
{
"Id": "1094",
"BackupTime": "2024-04-09T14:52:50.000",
"Name": "E2060248VS_06_51_26.txt"
}
],
"message": "操作成功",
"success": true,
"code": 100200
}
2.4.11 查看设备参数备份内容¶
接口说明:
基于参数备份Id和设备Id获得参数备份的结构化数据。
- 仅变频器设备支持查看设备参数备份内容
URL:
GET /devcenter/extapi/v1/assetdata/{assetid}/parameterbackup/{parametersetid}
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/{assetid}/parameterbackup/{parametersetid}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
AssetId | Integer | 设备Id |
Parametersetid | String | 参数备份Id |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Title | String | 参数Title |
ParaId | String | 变频器参数 |
Name | String | 变频器参数名称 |
Value | String | 参数值 |
Unit | String | 单位 |
Minimum | String | 最小值 |
Maximum | String | 最大值 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [
{
"Title": "01: 实际值",
"Parameters": [
{
"ParaId": "01.01",
"Name": "采用的电机速度 [rpm]",
"Value": "0",
"Unit": "rpm",
"Minimum": "-30000.00",
"Maximum": "30000.00"
},
{
"ParaId": "01.02",
"Name": "电机估算速度 [rpm]",
"Value": "0",
"Unit": "rpm",
"Minimum": "-30000.00",
"Maximum": "30000.00"
}
]
}
],
"message": "操作成功",
"success": true,
"code": 100200
}
2.5 设备数据订阅接口列表¶
2.5.1 创建设备数据订阅用户¶
接口说明:
创建一个设备数据订阅的用户,一个组织有且只能创建一个订阅用户。
注:创建订阅成功后,请保存用户密码,其他接口都无法查询密码,只能通过重置接口重置。
URL:
POST /devcenter/extapi/v1/subassetdata/subcustomer
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/subassetdata/subcustomer' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
无
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | UUID | 设备数据订阅用户ID |
UserName | String | 订阅的用户名称 |
Password | String | 订阅用户的密码(密码只有创建的时间时候可见,查询接口无法查看用户密码) |
Topic | String | 订阅的主题名称 |
SubDataTypes | List |
订阅的设备数据类型 |
CreatedOn | DateTime | 订阅用户创建时间 ISO 8601标准时间 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id": "2BDFCD86-BB29-4728-8164-BFF9DEBF6D81",
"userName": "xxxxxx",
"password": "*******",
"topic": "xxxxxxx",
"subDataTypes": [],
"createdOn": "2021-08-09T16:24:23Z"
},
"message": null,
"success": true,
"code": 100200
}
2.5.2 查询设备数据订阅用户的信息¶
接口说明:
查询设备数据订阅的用户信息。
URL:
GET /devcenter/extapi/v1/subassetdata/subcustomer
curl -X 'GET' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/subassetdata/subcustomer' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
无
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | UUID | 设备数据订阅用户ID |
UserName | String | 订阅的用户名称 |
Password | String | 订阅的用户密码(*****) |
Topic | String | 订阅的主题名称 |
SubDataTypes | List |
订阅的设备数据类型 |
CreatedOn | DateTime | 订阅用户创建时间 ISO 8601标准时间 |
设备数据类型 | 描述 |
---|---|
AssetEvent = 1 | 设备实时事件 |
AssetState = 2 | 设备状态(每间隔一个小时推送一次所有的设备的离线、在线的状态) |
AssetReport = 3 | 设备报告(当用户设备报告生成时,推送设备的报告的生成结果) |
AssetCBM = 4 | 设备预测性维护分析结果(每天推送设备的预测性维护分析结果) |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": [{
"id": "2BDFCD86-BB29-4728-8164-BFF9DEBF6D81",
"userName": "xxxxxx",
"topic": "xxxxxxx",
"password": "******",
"subDataTypes":["AssetEvent", "AssetState"],
"createdOn": "2021-08-09T16:24:23Z"
}],
"message": null,
"success": true,
"code": 100200
}
2.5.3 订阅设备数据¶
接口说明:
用户可以订阅设备的事件、设备状态、设备报告和设备预测性维护分析数。(暂不支持传动链设备)
用户也可以通过此接口更新订阅的设备数据类型列表。
若传入的设备数据类型不存在,正常返回,仅订阅存在的设备数据类型。
URL:
POST /devcenter/extapi/v1/subassetdata/subcustomer/{subcustomerid}/sub
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/assetdata/subassetdata/subcustomer/{subcustomerid}/sub' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
-D '{
"TopicName":"xxxxxxx",
"subDataTypes":[1, 2]
}'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
SubCustomerId | UUID | 订阅用户的ID |
请求正文:
属性 | 属性类型 | 描述 |
---|---|---|
TopicName | String | 订阅topic名称 |
SubDataTypes | List |
订阅的设备数据类型 |
设备数据类型 | 描述 |
---|---|
AssetEvent = 1 | 设备实时事件 |
AssetState = 2 | 设备状态(每间隔一个小时推送一次所有的设备的离线、在线的状态) |
AssetReport = 3 | 设备报告(当用户设备报告生成时,推送设备的报告的生成结果) |
AssetCBM = 4 | 设备预测性维护分析结果(每天推送设备的预测性维护分析结果) |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | UUID | 设备数据订阅用户ID |
UserName | String | 订阅的用户名称 |
SubDataTypes | List |
订阅的设备数据类型 |
Topic | String | 订阅的主题名称 |
CreatedOn | DateTime | 订阅用户创建时间 ISO 8601标准时间 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id": "2BDFCD86-BB29-4728-8164-BFF9DEBF6D81",
"userName": "xxxxxx",
"topic": "xxxxxxx",
"subDataTypes":["AssetEvent", "AssetState"],
"createdOn": "2021-08-09T16:24:23Z"
},
"message": null,
"success": true,
"code": 100200
}
2.5.4 删除设备数据订阅用户¶
接口说明:
删除设备数据的订阅用户,将也要删除此用户订阅的数据队列。
URL:
DELETE /devcenter/extapi/v1/subassetdata/subcustomer/{subcustomerid}
curl -X 'DELETE' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/subassetdata/subcustomer/{subcustomerid}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
SubCustomerId | UUID | 订阅用户的ID |
响应参数: 状态码:200
无
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {},
"message": "操作成功",
"success": true,
"code": 100200
}
2.5.5 重置设备数据订阅用户的密码¶
接口说明:
创建一个设备数据订阅的用户,一个组织有且只能创建一个订阅用户。
注:创建订阅成功后,请保存用户密码,其他接口都无法查询密码,只能通过重置接口重置。
URL:
POST /devcenter/extapi/v1/subassetdata/subcustomer/{subcustomerid}/reset
curl -X 'POST' \
'https://DEV_CENTER_BASE_URL/devcenter/extapi/v1/subassetdata/subcustomer/{subcustomerid}/reset' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxxxxx'
请求参数:
参数 | 参数类型 | 描述 |
---|---|---|
SubCustomerId | UUID | 订阅用户的ID |
响应参数: 状态码:200
参数 | 参数类型 | 描述 |
---|---|---|
Id | UUID | 设备数据订阅用户ID |
UserName | String | 订阅的用户名称 |
Password | String | 订阅用户的密码(密码只有创建和重置的时间时候可见,查询接口无法查看用户密码) |
Topic | String | 订阅的主题名称 |
SubDataTypes | List |
订阅的设备数据类型 |
CreatedOn | DateTime | 订阅用户创建时间 ISO 8601标准时间 |
状态码:400
返回错误
状态码:401
无权限访问
状态码:403
禁止访问
成功响应示例
{
"payload": {
"id": "2BDFCD86-BB29-4728-8164-BFF9DEBF6D81",
"userName": "xxxxxx",
"password": "*******",
"topic": "xxxxxxx",
"subDataTypes":["AssetEvent", "AssetState"],
"createdOn": "2021-08-09T16:24:23Z"
},
"message": null,
"success": true,
"code": 100200
}
响应码对照表¶
响应码 | 说明 |
---|---|
100200 | 成功 |
100400 | 参数错误 |
100403 | 禁止操作 |
101201 | 组织不存在 |
101202 | 服务客户组织不存在 |
101401 | 禁止操作此组织 |
102201 | 设备不存在 |
102202 | 设备类型暂不支持 |
102203 | 设备已存在 |
102204 | 设备在CMD未查到 |
102205 | 设备订阅已过期 |
102401 | 禁止操作此设备 |
102403 | 设备订阅等级不允许查询更多历史数据或禁止操作此设备功能 |
103201 | 设备组不存在 |
103401 | 禁止操作此设备组 |
104201 | 工厂不存在 |
104401 | 禁止操作此工厂 |
105201 | 订阅码不存在 |
105202 | 订阅码已过期 |
105203 | 订阅码和设备类型不匹配 |
105204 | 订阅码已使用 |
105205 | 订阅码的等级和设备类型不匹配 |
106201 | 设备数据订阅用户不存在 |
107201 | 设备报告不存在 |