ThingsKitAppearance
产品创建 | 编辑 ¶
接口地址:/api/yt/device_profile
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"deviceType": "",
"id": "",
"image": "",
"name": "",
"provisionType": "",
"scriptId": "",
"tbProfileId": "",
"tenantId": "",
"transportType": ""
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceProfileDTOReq | DeviceProfileDTOReq | body | true | DeviceProfileDTOReq |
| alarmProfile | 告警通知配置 | false | AlarmProfileDTO | |
| alarmContactId | 告警联系人 通知多人“,”号分隔 | true | string | |
| createTime | 创建时间 | false | string | |
| creator | 创建用户 | false | string | |
| defaultConfig | 租户默认配置 | false | string | |
| description | 租户描述 | false | string | |
| enabled | 租户状态：启用/禁用 | false | boolean | |
| icon | 租户图标 | false | string | |
| id | ID | false | string | |
| messageMode | 消息通知方式：多种方式“,”号分隔 MessageTypeEnum | true | string | |
| name | 告警配置名称 | true | string | |
| organizationId | 组织ID | true | string | |
| organizationName | 组织名称 | false | string | |
| remark | 告警配置备注 | false | string | |
| roleIds | 租户角色列表 | false | array | |
| status | 状态：0禁用 1启用 | false | integer | |
| tenantExpireTime | 租户到期时间 | false | string | |
| tenantId | 租户ID | false | string | |
| tenantProfileId | 租户配置 | false | string | |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
| updateTime | 更新时间 | false | string | |
| updater | 更新用户 | false | string | |
| createTime | 创建时间 | false | string(date-time) | |
| creator | 创建用户 | false | string | |
| default | false | boolean | ||
| defaultQueueName | 默认消息队列 | false | string | |
| defaultRuleChainId | 关联规则链，默认关联根规则链 | false | string | |
| description | 描述 | false | string | |
| deviceCount | 产品下的设备数量 | false | integer(int32) | |
| deviceType | 产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | true | string | |
| id | ID | false | string | |
| image | 设备配置/产品图片 | false | string | |
| name | 产品(设备配置)名称 | false | string | |
| profileData | false | DeviceProfileDataReq | ||
| alarms | JSON array of alarm rules configuration per device profile | false | array | |
| alarmType | String value representing type of the alarm | false | string | |
| clearRule | JSON object representing clear alarm rule | false | AlarmRuleReq | |
| alarmDetails | String value representing the additional details for an alarm rule | false | string | |
| condition | JSON object representing the alarm rule condition | false | AlarmConditionReq | |
| condition | JSON array of alarm condition filters | false | array | |
| key | JSON object for specifying alarm condition by specific key | false | AlarmConditionFilterKeyReq | |
| key | String value representing the key | false | string | |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | false | string | |
| predicate | JSON object representing filter condition | false | KeyFilterPredicate | |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | false | object | |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | false | string | |
| spec | JSON object representing alarm condition type | false | AlarmConditionSpec | |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | false | DashboardIdReq | |
| id | ID of the entity, time-based UUID v1 | true | string | |
| schedule | JSON object representing time interval during which the rule is active | false | AlarmScheduleReq | |
| createRules | Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details | false | AlarmRuleReq | |
| alarmDetails | String value representing the additional details for an alarm rule | false | string | |
| condition | JSON object representing the alarm rule condition | false | AlarmConditionReq | |
| condition | JSON array of alarm condition filters | false | array | |
| key | JSON object for specifying alarm condition by specific key | false | AlarmConditionFilterKeyReq | |
| key | String value representing the key | false | string | |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | false | string | |
| predicate | JSON object representing filter condition | false | KeyFilterPredicate | |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | false | object | |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | false | string | |
| spec | JSON object representing alarm condition type | false | AlarmConditionSpec | |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | false | DashboardIdReq | |
| id | ID of the entity, time-based UUID v1 | true | string | |
| schedule | JSON object representing time interval during which the rule is active | false | AlarmScheduleReq | |
| id | String value representing the alarm rule id | false | string | |
| propagate | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | false | boolean | |
| propagateRelationTypes | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | false | array | |
| propagateToOwner | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | false | boolean | |
| propagateToTenant | Propagation flag to specify if alarm should be propagated to the tenant entity | false | boolean | |
| configuration | JSON object of device profile configuration | false | DeviceProfileConfiguration | |
| provisionConfiguration | JSON object of provisioning strategy type per device profile | false | DeviceProfileProvisionConfigurationReq | |
| transportConfiguration | JSON object of device profile transport configuration | false | DeviceProfileTransportConfiguration | |
| provisionType | 设备创建策略 | false | string | |
| scriptId | 解析脚本ID | false | string | |
| tbProfileId | TB设备配置ID | false | string | |
| tenantId | 租户ID | false | string | |
| thingsModel | 物模型 | false | 物模型 | |
| accessMode | 读写模式：读r 写w | false | string | |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | false | string | |
| createTime | 创建时间 | false | string | |
| creator | 创建用户 | false | string | |
| defaultConfig | 租户默认配置 | false | string | |
| description | 租户描述 | false | string | |
| deviceProfileId | 设备配置ID | false | string | |
| enabled | 租户状态：启用/禁用 | false | boolean | |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | false | string | |
| functionJson | 功能json | false | JsonNode | |
| functionName | 功能名称 | false | string | |
| functionType | 功能类型,可用值:events,properties,services | false | string | |
| icon | 租户图标 | false | string | |
| id | ID | false | string | |
| identifier | 功能标识 | false | string | |
| name | 租户名称 | false | string | |
| remark | 备注 | false | string | |
| roleIds | 租户角色列表 | false | array | |
| status | 状态：0待发布 1发布 | false | integer | |
| tenantExpireTime | 租户到期时间 | false | string | |
| tenantId | 租户ID | false | string | |
| tenantProfileId | 租户配置 | false | string | |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
| updateTime | 更新时间 | false | string | |
| updater | 更新用户 | false | string | |
| transportType | 传输协议 | true | string | |
| type | TB设备配置类型，默认DEFAULT | false | string | |
| updateTime | 更新时间 | false | string(date-time) | |
| updater | 更新用户 | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| alarmProfile | 告警通知配置 | AlarmProfileDTO |
| alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| icon | 租户图标 | string |
| id | ID | string |
| messageMode | 消息通知方式：多种方式“,”号分隔 MessageTypeEnum | string |
| name | 告警配置名称 | string |
| organizationId | 组织ID | string |
| organizationName | 组织名称 | string |
| remark | 告警配置备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0禁用 1启用 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| default | boolean | |
| defaultQueueName | 默认消息队列 | string |
| defaultRuleChainId | 关联规则链，默认关联根规则链 | string |
| description | 描述 | string |
| deviceCount | 产品下的设备数量 | integer(int32) |
| deviceType | 产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
| id | ID | string |
| image | 设备配置/产品图片 | string |
| name | 产品(设备配置)名称 | string |
| profileData | DeviceProfileDataRes | |
| alarms | JSON array of alarm rules configuration per device profile | array |
| alarmType | String value representing type of the alarm | string |
| clearRule | JSON object representing clear alarm rule | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| createRules | Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| id | String value representing the alarm rule id | string |
| propagate | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | boolean |
| propagateRelationTypes | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | array |
| propagateToOwner | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | boolean |
| propagateToTenant | Propagation flag to specify if alarm should be propagated to the tenant entity | boolean |
| configuration | JSON object of device profile configuration | DeviceProfileConfiguration |
| provisionConfiguration | JSON object of provisioning strategy type per device profile | DeviceProfileProvisionConfigurationRes |
| provisionDeviceSecret | string | |
| transportConfiguration | JSON object of device profile transport configuration | DeviceProfileTransportConfiguration |
| provisionType | 设备创建策略 | string |
| scriptId | 解析脚本ID | string |
| tbProfileId | TB设备配置ID | string |
| tenantId | 租户ID | string |
| thingsModel | 物模型 | 物模型 |
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| transportType | 传输协议 | string |
| type | TB设备配置类型，默认DEFAULT | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
{
"alarmProfile": {
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"createTime": "",
"creator": "",
"default": true,
"defaultQueueName": "",
"defaultRuleChainId": "",
"description": "",
"deviceCount": 0,
"deviceType": "",
"id": "",
"image": "",
"name": "",
"profileData": {
"alarms": [
{
"alarmType": "High Temperature Alarm",
"clearRule": {
"alarmDetails": "",
"condition": {
"condition": [
{
"key": {
"key": "temp",
"type": "TIME_SERIES"
},
"predicate": {},
"value": {},
"valueType": "NUMERIC"
}
],
"spec": {}
},
"dashboardId": {
"entityType": "DASHBOARD",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"schedule": {
"type": ""
}
},
"createRules": {},
"id": "highTemperatureAlarmID",
"propagate": true,
"propagateRelationTypes": [],
"propagateToOwner": true,
"propagateToTenant": true
}
],
"configuration": {},
"provisionConfiguration": {
"provisionDeviceSecret": ""
},
"transportConfiguration": {}
},
"provisionType": "",
"scriptId": "",
"tbProfileId": "",
"tenantId": "",
"thingsModel": {
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"transportType": "",
"type": "",
"updateTime": "",
"updater": ""
}
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
删除 ¶
接口地址:/api/yt/device_profile
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"ids": [],
"tenantId": ""
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deleteDTO | DeleteDTO | body | true | DeleteDTO |
| ids | 删除ID列表 | true | array | |
| tenantId | 租户ID | false | string |
导出 ¶
接口地址:/api/yt/device_profile/export
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
暂无
导入配置 ¶
接口地址:/api/yt/device_profile/import
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
暂无
默认设备配置 ¶
接口地址:/api/yt/device_profile/me/default
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
暂无
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| createdTime | Timestamp of the profile creation, in milliseconds | integer(int64) |
| default | Used to mark the default profile. Default profile is used when the device profile is not specified during device creation. | boolean |
| defaultDashboardId | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details. | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| defaultQueueName | Reference to the rule engine queue. If present, the specified queue will be used to store all unprocessed messages related to device, including telemetry, attribute updates, etc. Otherwise, the 'Main' queue will be used to store those messages. | string |
| defaultRuleChainId | Reference to the rule chain. If present, the specified rule chain will be used to process all messages related to device, including telemetry, attribute updates, etc. Otherwise, the root rule chain will be used to process those messages. | RuleChainId |
| entityType | string,可用值:RULE_CHAIN | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| description | Device Profile description. | string |
| firmwareId | Reference to the firmware OTA package. If present, the specified package will be used as default device firmware. | OtaPackageId |
| entityType | string,可用值:OTA_PACKAGE | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| id | JSON object with the device profile Id. Specify this field to update the device profile. Referencing non-existing device profile Id will cause error. Omit this field to create new device profile. | DeviceProfileId |
| entityType | string,可用值:DEVICE_PROFILE | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| image | Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view. | string |
| name | Unique Device Profile Name in scope of Tenant. | string |
| profileData | Complex JSON object that includes addition device profile configuration (transport, alarm rules, etc). | DeviceProfileDataRes |
| alarms | JSON array of alarm rules configuration per device profile | array |
| alarmType | String value representing type of the alarm | string |
| clearRule | JSON object representing clear alarm rule | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| createRules | Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| id | String value representing the alarm rule id | string |
| propagate | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | boolean |
| propagateRelationTypes | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | array |
| propagateToOwner | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | boolean |
| propagateToTenant | Propagation flag to specify if alarm should be propagated to the tenant entity | boolean |
| configuration | JSON object of device profile configuration | DeviceProfileConfiguration |
| provisionConfiguration | JSON object of provisioning strategy type per device profile | DeviceProfileProvisionConfigurationRes |
| provisionDeviceSecret | string | |
| transportConfiguration | JSON object of device profile transport configuration | DeviceProfileTransportConfiguration |
| provisionDeviceKey | Unique provisioning key used by 'Device Provisioning' feature. | string |
| provisionType | Provisioning strategy.,可用值:ALLOW_CREATE_NEW_DEVICES,CHECK_PRE_PROVISIONED_DEVICES,DISABLED | string |
| softwareId | Reference to the software OTA package. If present, the specified package will be used as default device software. | OtaPackageId |
| entityType | string,可用值:OTA_PACKAGE | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| tenantId | JSON object with Tenant Id that owns the profile. | TenantId |
| entityType | string,可用值:TENANT | string |
| id | ID of the entity, time-based UUID v1 | string(uuid) |
| transportType | Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.,可用值:COAP,DEFAULT,LWM2M,MQTT,SNMP,TCP | string |
| type | Type of the profile. Always 'DEFAULT' for now. Reserved for future use.,可用值:DEFAULT | string |
响应示例:
javascript
{
"default": false,
"defaultDashboardId": {
"entityType": "DASHBOARD",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"defaultQueueName": "",
"defaultRuleChainId": {
"entityType": "RULE_CHAIN",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"description": "",
"firmwareId": {
"entityType": "OTA_PACKAGE",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"id": {
"entityType": "DEVICE_PROFILE",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"image": "",
"name": "Moisture Sensor",
"profileData": {
"alarms": [
{
"alarmType": "High Temperature Alarm",
"clearRule": {
"alarmDetails": "",
"condition": {
"condition": [
{
"key": {
"key": "temp",
"type": "TIME_SERIES"
},
"predicate": {},
"value": {},
"valueType": "NUMERIC"
}
],
"spec": {}
},
"dashboardId": {
"entityType": "DASHBOARD",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"schedule": {
"type": ""
}
},
"createRules": {},
"id": "highTemperatureAlarmID",
"propagate": true,
"propagateRelationTypes": [],
"propagateToOwner": true,
"propagateToTenant": true
}
],
"configuration": {},
"provisionConfiguration": {
"provisionDeviceSecret": ""
},
"transportConfiguration": {}
},
"provisionDeviceKey": "",
"provisionType": "",
"softwareId": {
"entityType": "OTA_PACKAGE",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"transportType": "",
"type": ""
}
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
选项列表 ¶
接口地址:/api/yt/device_profile/me/list{?deviceType}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceType | 设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | query | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| body | object | |
| statusCode | 可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATES | string |
| statusCodeValue | integer(int32) |
响应示例:
javascript
{
"body": {},
"statusCode": "",
"statusCodeValue": 0
}
1
2
3
4
5
2
3
4
5
详情 ¶
接口地址:/api/yt/device_profile/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| id | id | path | true | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| alarmProfile | 告警通知配置 | AlarmProfileDTO |
| alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| icon | 租户图标 | string |
| id | ID | string |
| messageMode | 消息通知方式：多种方式“,”号分隔 MessageTypeEnum | string |
| name | 告警配置名称 | string |
| organizationId | 组织ID | string |
| organizationName | 组织名称 | string |
| remark | 告警配置备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0禁用 1启用 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| default | boolean | |
| defaultQueueName | 默认消息队列 | string |
| defaultRuleChainId | 关联规则链，默认关联根规则链 | string |
| description | 描述 | string |
| deviceCount | 产品下的设备数量 | integer(int32) |
| deviceType | 产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
| id | ID | string |
| image | 设备配置/产品图片 | string |
| name | 产品(设备配置)名称 | string |
| profileData | DeviceProfileDataRes | |
| alarms | JSON array of alarm rules configuration per device profile | array |
| alarmType | String value representing type of the alarm | string |
| clearRule | JSON object representing clear alarm rule | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| createRules | Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| id | String value representing the alarm rule id | string |
| propagate | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | boolean |
| propagateRelationTypes | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | array |
| propagateToOwner | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | boolean |
| propagateToTenant | Propagation flag to specify if alarm should be propagated to the tenant entity | boolean |
| configuration | JSON object of device profile configuration | DeviceProfileConfiguration |
| provisionConfiguration | JSON object of provisioning strategy type per device profile | DeviceProfileProvisionConfigurationRes |
| provisionDeviceSecret | string | |
| transportConfiguration | JSON object of device profile transport configuration | DeviceProfileTransportConfiguration |
| provisionType | 设备创建策略 | string |
| scriptId | 解析脚本ID | string |
| tbProfileId | TB设备配置ID | string |
| tenantId | 租户ID | string |
| thingsModel | 物模型 | 物模型 |
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| transportType | 传输协议 | string |
| type | TB设备配置类型，默认DEFAULT | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
{
"alarmProfile": {
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"createTime": "",
"creator": "",
"default": true,
"defaultQueueName": "",
"defaultRuleChainId": "",
"description": "",
"deviceCount": 0,
"deviceType": "",
"id": "",
"image": "",
"name": "",
"profileData": {
"alarms": [
{
"alarmType": "High Temperature Alarm",
"clearRule": {
"alarmDetails": "",
"condition": {
"condition": [
{
"key": {
"key": "temp",
"type": "TIME_SERIES"
},
"predicate": {},
"value": {},
"valueType": "NUMERIC"
}
],
"spec": {}
},
"dashboardId": {
"entityType": "DASHBOARD",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"schedule": {
"type": ""
}
},
"createRules": {},
"id": "highTemperatureAlarmID",
"propagate": true,
"propagateRelationTypes": [],
"propagateToOwner": true,
"propagateToTenant": true
}
],
"configuration": {},
"provisionConfiguration": {
"provisionDeviceSecret": ""
},
"transportConfiguration": {}
},
"provisionType": "",
"scriptId": "",
"tbProfileId": "",
"tenantId": "",
"thingsModel": {
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"transportType": "",
"type": "",
"updateTime": "",
"updater": ""
}
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
查询 ¶
接口地址:/api/yt/device_profile{?name,orderFiled,orderType,page,pageSize,transportType}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| page | page | true | int |
| pageSize | pageSize | true | int |
| name | name | false | string |
| transportType | transportType | false | string |
| orderFiled | orderFiled | false | string |
| orderType | orderType,可用值:ASC,DESC | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| alarmProfile | 告警通知配置 | AlarmProfileDTO |
| alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
| createTime | 创建时间 | string |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| enabled | 租户状态：启用/禁用 | boolean |
| icon | 租户图标 | string |
| id | ID | string |
| messageMode | 消息通知方式：多种方式“,”号分隔 MessageTypeEnum | string |
| name | 告警配置名称 | string |
| organizationId | 组织ID | string |
| organizationName | 组织名称 | string |
| remark | 告警配置备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0禁用 1启用 | integer |
| tenantExpireTime | 租户到期时间 | string |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string |
| updater | 更新用户 | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| default | boolean | |
| defaultQueueName | 默认消息队列 | string |
| defaultRuleChainId | 关联规则链，默认关联根规则链 | string |
| description | 描述 | string |
| deviceCount | 产品下的设备数量 | integer(int32) |
| deviceType | 产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR | string |
| id | ID | string |
| image | 设备配置/产品图片 | string |
| name | 产品(设备配置)名称 | string |
| profileData | DeviceProfileDataRes | |
| alarms | JSON array of alarm rules configuration per device profile | array |
| alarmType | String value representing type of the alarm | string |
| clearRule | JSON object representing clear alarm rule | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| createRules | Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details | AlarmRuleRes |
| alarmDetails | String value representing the additional details for an alarm rule | string |
| condition | JSON object representing the alarm rule condition | AlarmConditionRes |
| condition | JSON array of alarm condition filters | array |
| key | JSON object for specifying alarm condition by specific key | AlarmConditionFilterKeyRes |
| key | String value representing the key | string |
| type | The key type,可用值:ATTRIBUTE,CONSTANT,ENTITY_FIELD,TIME_SERIES | string |
| predicate | JSON object representing filter condition | KeyFilterPredicate |
| value | Value used in Constant comparison. For other types, such as TIME_SERIES or ATTRIBUTE, the predicate condition is used | object |
| valueType | String representation of the type of the value,可用值:BOOLEAN,DATE_TIME,NUMERIC,STRING | string |
| spec | JSON object representing alarm condition type | AlarmConditionSpec |
| dashboardId | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | DashboardIdRes |
| entityType | string,可用值:DASHBOARD | string |
| id | ID of the entity, time-based UUID v1 | string |
| schedule | JSON object representing time interval during which the rule is active | AlarmScheduleRes |
| type | 可用值:ANY_TIME,CUSTOM,SPECIFIC_TIME | string |
| id | String value representing the alarm rule id | string |
| propagate | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | boolean |
| propagateRelationTypes | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | array |
| propagateToOwner | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | boolean |
| propagateToTenant | Propagation flag to specify if alarm should be propagated to the tenant entity | boolean |
| configuration | JSON object of device profile configuration | DeviceProfileConfiguration |
| provisionConfiguration | JSON object of provisioning strategy type per device profile | DeviceProfileProvisionConfigurationRes |
| provisionDeviceSecret | string | |
| transportConfiguration | JSON object of device profile transport configuration | DeviceProfileTransportConfiguration |
| provisionType | 设备创建策略 | string |
| scriptId | 解析脚本ID | string |
| tbProfileId | TB设备配置ID | string |
| tenantId | 租户ID | string |
| thingsModel | 物模型 | 物模型 |
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer |
| tenantExpireTime | 租户到期时间 | string |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string |
| updater | 更新用户 | string |
| transportType | 传输协议 | string |
| type | TB设备配置类型，默认DEFAULT | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"alarmProfile": {
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"createTime": "",
"creator": "",
"default": true,
"defaultQueueName": "",
"defaultRuleChainId": "",
"description": "",
"deviceCount": 0,
"deviceType": "",
"id": "",
"image": "",
"name": "",
"profileData": {
"alarms": [
{
"alarmType": "High Temperature Alarm",
"clearRule": {
"alarmDetails": "",
"condition": {
"condition": [
{
"key": {
"key": "temp",
"type": "TIME_SERIES"
},
"predicate": {},
"value": {},
"valueType": "NUMERIC"
}
],
"spec": {}
},
"dashboardId": {
"entityType": "DASHBOARD",
"id": "784f394c-42b6-435a-983c-b7beff2784f9"
},
"schedule": {
"type": ""
}
},
"createRules": {},
"id": "highTemperatureAlarmID",
"propagate": true,
"propagateRelationTypes": [],
"propagateToOwner": true,
"propagateToTenant": true
}
],
"configuration": {},
"provisionConfiguration": {
"provisionDeviceSecret": ""
},
"transportConfiguration": {}
},
"provisionType": "",
"scriptId": "",
"tbProfileId": "",
"tenantId": "",
"thingsModel": {
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
},
"transportType": "",
"type": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
保存物模型 ¶
接口地址:/api/yt/things_model
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
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
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
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| 物模型 | 物模型 | body | true | 物模型 |
| accessMode | 读写模式：读r 写w | false | string | |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | false | string | |
| createTime | 创建时间 | false | string(date-time) | |
| creator | 创建用户 | false | string | |
| defaultConfig | 租户默认配置 | false | string | |
| description | 租户描述 | false | string | |
| deviceProfileId | 设备配置ID | false | string | |
| enabled | 租户状态：启用/禁用 | false | boolean | |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | false | string | |
| functionJson | 功能json | false | JsonNode | |
| functionName | 功能名称 | false | string | |
| functionType | 功能类型,可用值:events,properties,services | false | string | |
| icon | 租户图标 | false | string | |
| id | ID | false | string | |
| identifier | 功能标识 | false | string | |
| name | 租户名称 | false | string | |
| remark | 备注 | false | string | |
| roleIds | 租户角色列表 | false | array | |
| status | 状态：0待发布 1发布 | false | integer(int32) | |
| tenantExpireTime | 租户到期时间 | false | string(date-time) | |
| tenantId | 租户ID | false | string | |
| tenantProfileId | 租户配置 | false | string | |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
| updateTime | 更新时间 | false | string(date-time) | |
| updater | 更新用户 | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
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
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
修改物模型 ¶
接口地址:/api/yt/things_model
请求方式:PUT
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
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
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
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| 物模型 | 物模型 | body | true | 物模型 |
| accessMode | 读写模式：读r 写w | false | string | |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | false | string | |
| createTime | 创建时间 | false | string(date-time) | |
| creator | 创建用户 | false | string | |
| defaultConfig | 租户默认配置 | false | string | |
| description | 租户描述 | false | string | |
| deviceProfileId | 设备配置ID | false | string | |
| enabled | 租户状态：启用/禁用 | false | boolean | |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | false | string | |
| functionJson | 功能json | false | JsonNode | |
| functionName | 功能名称 | false | string | |
| functionType | 功能类型,可用值:events,properties,services | false | string | |
| icon | 租户图标 | false | string | |
| id | ID | false | string | |
| identifier | 功能标识 | false | string | |
| name | 租户名称 | false | string | |
| remark | 备注 | false | string | |
| roleIds | 租户角色列表 | false | array | |
| status | 状态：0待发布 1发布 | false | integer(int32) | |
| tenantExpireTime | 租户到期时间 | false | string(date-time) | |
| tenantId | 租户ID | false | string | |
| tenantProfileId | 租户配置 | false | string | |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
| updateTime | 更新时间 | false | string(date-time) | |
| updater | 更新用户 | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
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
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
删除 ¶
接口地址:/api/yt/things_model
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"ids": [],
"tenantId": ""
}
1
2
3
4
2
3
4
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deleteDTO | DeleteDTO | body | true | DeleteDTO |
| ids | 删除ID列表 | true | array | |
| tenantId | 租户ID | false | string |
获取产品服务 ¶
接口地址:/api/yt/things_model/get_services/{deviceProfileId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceProfileId | deviceProfileId | path | true | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
[
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
]
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
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
分页 ¶
接口地址:/api/yt/things_model/page{?deviceProfileId,functionType,nameOrIdentifier,orderFiled,orderType,page,pageSize}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceProfileId | deviceProfileId | query | true | string |
| page | page | query | true | string |
| pageSize | pageSize | query | true | string |
| nameOrIdentifier | nameOrIdentifier | query | false | string |
| functionType | functionType,可用值:events,properties,services | query | false | string |
| orderFiled | orderFiled | query | false | string |
| orderType | orderType,可用值:ASC,DESC | query | false | string |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| accessMode | 读写模式：读r 写w | string |
| callType | 调用方式：同步sync 异步async,可用值:ASYNC,SYNC | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| deviceProfileId | 设备配置ID | string |
| enabled | 租户状态：启用/禁用 | boolean |
| eventType | 事件类型：信息info 告警alert 故障error,可用值:ALERT,ERROR,INFO | string |
| functionJson | 功能json | JsonNode |
| functionName | 功能名称 | string |
| functionType | 功能类型,可用值:events,properties,services | string |
| icon | 租户图标 | string |
| id | ID | string |
| identifier | 功能标识 | string |
| name | 租户名称 | string |
| remark | 备注 | string |
| roleIds | 租户角色列表 | array |
| status | 状态：0待发布 1发布 | integer(int32) |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"accessMode": "",
"callType": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"deviceProfileId": "",
"enabled": false,
"eventType": "",
"functionJson": {},
"functionName": "",
"functionType": "",
"icon": "",
"id": "",
"identifier": "",
"name": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater ": ""
}
],
"total": 0
}
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
物模型发布 ¶
接口地址:/api/yt/things_model/{deviceProfileId}
请求方式:PUT
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| deviceProfileId | deviceProfileId | path | true | string |
获取物模型TSL ¶
接口地址:/api/yt/things_model/{functionType}/{deviceProfileId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| functionType | functionType,可用值:events,properties,services | path | true | string |
| deviceProfileId | deviceProfileId | path | true | string |
响应参数:
暂无
响应示例:
javascript
null
1