ThingsKit物联网平台API文档-设备管理（产品）

云腾小编

2024年10月8日2024年9月29日

选项列表（各页面的列表选项）

接口地址:/api/yt/device_profile/me/list{?deviceType}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceType	设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSOR	query	false	string
transportType	传输协议	query	false	string
isSceneLinkage	是否来自边端（场景联动页面使用）	query	false	boolean

响应参数:

参数名称	参数说明	类型
name	产品(设备配置)名称	String
description	告警通知配置	String
tenantId	租户ID	String
transportType	传输协议	String
provisionType	设备创建策略	String
deviceType	产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR	DeviceTypeEnum
tbProfileId	TB设备配置ID	String
defaultRuleChainId	关联规则链，默认关联根规则链	String
alarmProfile	告警通知配置	AlarmProfileDTO
defaultQueueName	默认消息队列	String
image	设备配置/产品图片	String
isDefault	是否默认设备配置	boolean
type	TB设备配置类型，默认DEFAULT	String
thingsModel	物模型	ThingsModelDTO
deviceCount	产品下的设备数量	Integer
categoryId	品类id	String
categoryName	品类名称	String
firmwareId	OTA升级固件ID	String
softwareId	OTA升级软件ID	String
isEdge	是否来自边端	Integer

响应示例:

[
    {
        "id": "0167de20-5ddb-11ef-b746-1f75222e5f46",
        "name": "default",
        "description": "Default device profile",
        "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
        "transportType": "DEFAULT",
        "provisionType": "DISABLED",
        "deviceType": "SENSOR",
        "tbProfileId": "0167de20-5ddb-11ef-b746-1f75222e5f46",
        "profileData": {
            "configuration": {
                "type": "DEFAULT"
            },
            "transportConfiguration": {
                "type": "DEFAULT"
            },
            "provisionConfiguration": {
                "type": "DISABLED",
                "provisionDeviceSecret": null
            },
            "alarms": null,
            "thingsModel": null
        },
        "type": "DEFAULT",
        "default": true
    }
]

详情（获取产品详情）

接口地址:/api/yt/device_profile/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	path	true	string

响应参数:

参数名称	参数说明	类型
name	产品(设备配置)名称	String
description	告警通知配置	String
tenantId	租户ID	String
transportType	传输协议	String
provisionType	设备创建策略	String
deviceType	产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR	DeviceTypeEnum
tbProfileId	TB设备配置ID	String
defaultRuleChainId	关联规则链，默认关联根规则链	String
alarmProfile	告警通知配置	AlarmProfileDTO
defaultQueueName	默认消息队列	String
image	设备配置/产品图片	String
isDefault	是否默认设备配置	boolean
type	TB设备配置类型，默认DEFAULT	String
thingsModel	物模型集合	ThingsModelDTO
deviceCount	产品下的设备数量	Integer
categoryId	品类id	String
categoryName	品类名称	String
firmwareId	OTA升级固件ID	String
softwareId	OTA升级软件ID	String
isEdge	是否来自边端	Integer

响应示例:

{
    "id": "01944550-5ddb-11ef-b746-1f75222e5f46",
    "name": "默认MQTT直连设备",
    "description": "Default device profile",
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "transportType": "DEFAULT",
    "provisionType": "DISABLED",
    "deviceType": "DIRECT_CONNECTION",
    "tbProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
    "profileData": {
        "configuration": {
            "type": "DEFAULT"
        },
        "transportConfiguration": {
            "type": "DEFAULT"
        },
        "provisionConfiguration": {
            "type": "DISABLED",
            "provisionDeviceSecret": null
        },
        "alarms": null,
        "thingsModel": [
            {
                "functionType": "properties",
                "functionName": "温度",
                "identifier": "CurrentTemperature",
                "callType": null,
                "accessMode": "r",
                "eventType": null,
                "functionJson": {
                    "dataType": {
                        "type": "INT",
                        "specs": {
                            "unit": "°C",
                            "unitName": "摄氏度 / °C",
                            "valueRange": {
                                "max": 32767,
                                "min": -32768
                            }
                        },
                        "specsList": []
                    }
                },
                "extensionDesc": {
                    "bitMask": 7,
                    "scaling": 10,
                    "writeOnly": false,
                    "operationType": "holdingRegister_r_03",
                    "registerAddress": "01",
                    "originalDataType": "INT16_AB"
                },
                "status": 1,
                "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
                "remark": null
            },
            {
                "functionType": "properties",
                "functionName": "湿度",
                "identifier": "CurrentHumidity",
                "callType": null,
                "accessMode": "r",
                "eventType": null,
                "functionJson": {
                    "dataType": {
                        "type": "INT",
                        "specs": {
                            "unit": "%RH",
                            "unitName": "相对湿度 / %RH",
                            "valueRange": {
                                "max": 32767,
                                "min": -32768
                            }
                        },
                        "specsList": []
                    }
                },
                "extensionDesc": {
                    "bitMask": 7,
                    "scaling": 10,
                    "writeOnly": false,
                    "operationType": "holdingRegister_r_03",
                    "registerAddress": "00",
                    "originalDataType": "INT16_AB"
                },
                "status": 1,
                "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
                "remark": null
            }
        ]
    },
    "type": "DEFAULT",
    "deviceCount": 2,
    "default": false
}

产品列表（分页查询）

接口地址:/api/yt/device_profile{?name,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
orderType	orderType,可用值:ASC,DESC	false	string

响应参数:

参数名称	参数说明	类型
name	产品(设备配置)名称	String
description	告警通知配置	String
tenantId	租户ID	String
transportType	传输协议	String
provisionType	设备创建策略	String
deviceType	产品类型：GATEWAY,DIRECT_CONNECTION,SENSOR	DeviceTypeEnum
tbProfileId	TB设备配置ID	String
defaultRuleChainId	关联规则链，默认关联根规则链	String
alarmProfile	告警通知配置	AlarmProfileDTO
defaultQueueName	默认消息队列	String
image	设备配置/产品图片	String
isDefault	是否默认设备配置	boolean
type	TB设备配置类型，默认DEFAULT	String
thingsModel	物模型	ThingsModelDTO
deviceCount	产品下的设备数量	Integer
categoryId	品类id	String
categoryName	品类名称	String
firmwareId	OTA升级固件ID	String
softwareId	OTA升级软件ID	String
isEdge	是否来自边端	Integer

响应示例:

{
    "total": 4,//数据总数
    "items": [
        {
            "id": "01944550-5ddb-11ef-b746-1f75222e5f46",//产品id
            "name": "默认MQTT直连设备",//产品名称
            "description": "Default device profile",//秒速
            "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",//租户id
            "transportType": "DEFAULT",//传输协议
            "provisionType": "DISABLED",//创建设备策略
            "deviceType": "DIRECT_CONNECTION",//产品类型
            "tbProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",//tb产品id
            "profileData": {
                "configuration": {
                    "type": "DEFAULT"
                },
                "transportConfiguration": {
                    "type": "DEFAULT"
                },
                "provisionConfiguration": {
                    "type": "DISABLED",
                    "provisionDeviceSecret": null
                },
                "alarms": null,//告警
                "thingsModel": [//物模型集合
                    {
                        "functionType": "properties",
                        "functionName": "温度",
                        "identifier": "CurrentTemperature",
                        "callType": null,
                        "accessMode": "r",
                        "eventType": null,
                        "functionJson": {
                            "dataType": {
                                "type": "INT",
                                "specs": {
                                    "unit": "°C",
                                    "unitName": "摄氏度 / °C",
                                    "valueRange": {
                                        "max": 32767,
                                        "min": -32768
                                    }
                                },
                                "specsList": []
                            }
                        },
                        "extensionDesc": {
                            "bitMask": 7,
                            "scaling": 10,
                            "writeOnly": false,
                            "operationType": "holdingRegister_r_03",
                            "registerAddress": "01",
                            "originalDataType": "INT16_AB"
                        },
                        "status": 1,
                        "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
                        "remark": null
                    },
                    {
                        "functionType": "properties",
                        "functionName": "湿度",
                        "identifier": "CurrentHumidity",
                        "callType": null,
                        "accessMode": "r",
                        "eventType": null,
                        "functionJson": {
                            "dataType": {
                                "type": "INT",
                                "specs": {
                                    "unit": "%RH",
                                    "unitName": "相对湿度 / %RH",
                                    "valueRange": {
                                        "max": 32767,
                                        "min": -32768
                                    }
                                },
                                "specsList": []
                            }
                        },
                        "extensionDesc": {
                            "bitMask": 7,
                            "scaling": 10,
                            "writeOnly": false,
                            "operationType": "holdingRegister_r_03",
                            "registerAddress": "00",
                            "originalDataType": "INT16_AB"
                        },
                        "status": 1,
                        "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
                        "remark": null
                    }
                ]
            },
            "type": "DEFAULT",
            "categoryName": "默认MQTT直连设备",
            "isEdge": 0,
            "default": false
        }
    ]
}

保存物模型（新增物模型）

接口地址:/api/yt/things_model

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
    "functionType": "properties",
    "functionName": "测试",
    "identifier": "test",
    "functionJson": {
        "dataType": {
            "type": "INT",
            "specs": {
                "valueRange": {
                    "min": 0,
                    "max": 10
                },
                "unit": "m㎡",
                "unitName": "平方毫米 / m㎡",
                "step": 1
            }
        }
    },
    "accessMode": "rw",
    "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
functionType	功能类型	body	true	FunctionTypeEnum
functionName	功能名称	body	true	string
identifier	功能标识	body	true	string
functionJson	功能json	body	true	JsonNode
accessMode	读写模式：读r 写w	body	true	string
deviceProfileId	设备配置ID	body	true	string
extensionDesc	TCP/UDP属性扩展描述	body	false	JsonNode
callType	调用方式：同步sync 异步async	body	false	CallTypeEnum
eventType	事件类型：信息info 告警alert 故障error	body	false	DeviceEventTypeEnum

响应参数:

参数名称	参数说明	数据类型
id	主键	string
tenantId	租户id	string
functionType	功能类型	FunctionTypeEnum
functionName	功能名称	string
identifier	功能标识	string
accessMode	读写模式：读r 写w	string
functionJson	功能json	JsonNode
deviceProfileId	设备配置ID	string
extensionDesc	TCP/UDP属性扩展描述	JsonNode
callType	调用方式：同步sync 异步async	CallTypeEnum
eventType	事件类型：信息info 告警alert 故障error	DeviceEventTypeEnum

响应示例:

{
    "id": "a060bced-039c-4aa0-9547-b6639f31b32f",
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "functionType": "properties",
    "functionName": "测试",
    "identifier": "test",
    "accessMode": "rw",
    "functionJson": {
        "dataType": {
            "type": "INT",
            "specs": {
                "valueRange": {
                    "min": 0,
                    "max": 10
                },
                "unit": "m㎡",
                "unitName": "平方毫米 / m㎡",
                "step": 1
            }
        }
    },
    "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46"
}

修改物模型（编辑物模型）

接口地址:/api/yt/things_model

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
    "functionType": "properties",
    "functionName": "测试",
    "identifier": "test",
    "functionJson": {
        "dataType": {
            "type": "INT",
            "specs": {
                "valueRange": {
                    "min": 0,
                    "max": 10
                },
                "unit": "m㎡",
                "unitName": "平方毫米 / m㎡",
                "step": 1
            }
        }
    },
    "accessMode": "rw",
    "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46",
    "id": "a060bced-039c-4aa0-9547-b6639f31b32f"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	主键	body	true	string
functionType	功能类型	body	true	FunctionTypeEnum
functionName	功能名称	body	true	string
identifier	功能标识	body	true	string
accessMode	读写模式：读r 写w	body	true	string
functionJson	功能json	body	false	JsonNode
deviceProfileId	设备配置ID	body	false	string
extensionDesc	TCP/UDP属性扩展描述	body	false	JsonNode
callType	调用方式：同步sync 异步async	body	false	CallTypeEnum
eventType	事件类型：信息info 告警alert 故障error	body	false	DeviceEventTypeEnum

响应参数:

参数名称	参数说明	数据类型
id	主键	string
tenantId	租户id	string
functionType	功能类型	FunctionTypeEnum
functionName	功能名称	string
identifier	功能标识	string
accessMode	读写模式：读r 写w	string
functionJson	功能json	JsonNode
deviceProfileId	设备配置ID	string
extensionDesc	TCP/UDP属性扩展描述	JsonNode
callType	调用方式：同步sync 异步async	CallTypeEnum
eventType	事件类型：信息info 告警alert 故障error	DeviceEventTypeEnum

响应示例:

{
    "id": "a060bced-039c-4aa0-9547-b6639f31b32f",
    "enabled": false,
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "functionType": "properties",
    "functionName": "测试",
    "identifier": "test",`
    "accessMode": "rw",
    "functionJson": {
        "dataType": {
            "type": "INT",
            "specs": {
                "valueRange": {
                    "min": 0,
                    "max": 10
                },
                "unit": "m㎡",
                "unitName": "平方毫米 / m㎡",
                "step": 1
            }
        }
    },
    "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46"
}

删除

接口地址:/api/yt/things_model

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
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

响应示例:

[
	{
		"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": ""
	}
]

物模型分页（获取物模型）

接口地址:/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

响应参数:

参数名称	参数说明	数据类型
id	主键	string
tenantId	租户id	string
functionType	功能类型	FunctionTypeEnum
functionName	功能名称	string
identifier	功能标识	string
accessMode	读写模式：读r 写w	string
functionJson	功能json	JsonNode
deviceProfileId	设备配置ID	string
extensionDesc	TCP/UDP属性扩展描述	JsonNode
callType	调用方式：同步sync 异步async	CallTypeEnum
eventType	事件类型：信息info 告警alert 故障error	DeviceEventTypeEnum

响应示例:

{
    "total": 2,
    "items": [
        {
            "id": "4d2e7652-f896-454d-8e2e-4f05c16ac67e",
            "creator": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
            "createTime": "2024-08-19 13:38:49",
            "updater": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
            "updateTime": "2024-08-21 11:37:27",
            "enabled": false,
            "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
            "functionType": "properties",
            "functionName": "温度",
            "identifier": "CurrentTemperature",
            "extensionDesc": {
                "writeOnly": false,
                "bitMask": 7,
                "operationType": "holdingRegister_r_03",
                "originalDataType": "INT16_AB",
                "registerAddress": "01",
                "scaling": 10
            },
            "accessMode": "r",
            "functionJson": {
                "dataType": {
                    "type": "INT",
                    "specs": {
                        "valueRange": {
                            "min": -32768,
                            "max": 32767
                        },
                        "unit": "°C",
                        "unitName": "摄氏度 / °C"
                    }
                }
            },
            "status": 1,
            "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46"
        },
        {
            "id": "fbb0d98b-fac7-41ef-a9d0-7660f83ea179",
            "creator": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
            "createTime": "2024-08-19 13:38:49",
            "updateTime": "2024-08-19 14:03:31",
            "enabled": false,
            "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
            "functionType": "properties",
            "functionName": "湿度",
            "identifier": "CurrentHumidity",
            "extensionDesc": {
                "writeOnly": false,
                "bitMask": 7,
                "operationType": "holdingRegister_r_03",
                "originalDataType": "INT16_AB",
                "registerAddress": "00",
                "scaling": 10
            },
            "accessMode": "r",
            "functionJson": {
                "dataType": {
                    "type": "INT",
                    "specs": {
                        "unit": "%RH",
                        "unitName": "相对湿度 / %RH",
                        "valueRange": {
                            "min": -32768,
                            "max": 32767
                        }
                    },
                    "specsList": []
                }
            },
            "status": 1,
            "deviceProfileId": "01944550-5ddb-11ef-b746-1f75222e5f46"
        }
    ]
}

物模型发布

接口地址:/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	产品ID	path	true	string

请求示例：

响应参数:

参数名称	参数说明	数据类型
functionType	functionType,可用值:events(事件),properties（属性）,services（服务）	string
functionName	功能名称	string
identifier	标识符类型	string
accessMode	读写模式：rw读写 r只读	string

响应示例:

[{
		"functionName": "温度",
		"identifier": "temperature",
		"functionType": "properties",
		"accessMode": "rw",
		"specs": {
			"dataType": {
				"type": "DOUBLE",
				"specs": {
					"unit": {
						"value": "°C",
						"label": "摄氏度 / °C",
						"key": "°C"
					},
					"unitName": "摄氏度 / °C"
				}
			}
		},
		"extensionDesc": null
	},
	{
		"functionName": "湿度",
		"identifier": "humidity",
		"functionType": "properties",
		"accessMode": "rw",
		"specs": {
			"dataType": {
				"type": "DOUBLE",
				"specs": {
					"unit": {
						"value": "%RH",
						"label": "相对湿度 / %RH",
						"key": "%RH"
					},
					"unitName": "相对湿度 / %RH"
				}
			}
		},
		"extensionDesc": null
	}
]

2022年1月22日

云腾五洲科技2022年春节放假通知

2022年3月17日

团队就地解散！苹果汽车彻底“凉凉”了；华为最新全屋智能售价4万，简直比去年便宜太多；全球股市大反弹，抄底人赚翻？| 物联网头条

2022年3月19日

ThingsKit物联网平台API文档-设备管理（产品）

选项列表（各页面的列表选项）

详情（获取产品详情）

产品列表（分页查询）

保存物模型（新增物模型）

修改物模型（编辑物模型）

删除

获取产品服务

物模型分页（获取物模型）

物模型发布

获取物模型TSL（重要）

Related Articles

云腾五洲科技2022年春节放假通知

团队就地解散！苹果汽车彻底“凉凉”了；华为最新全屋智能售价4万，简直比去年便宜太多；全球股市大反弹，抄底人赚翻？| 物联网头条

罗永浩拿上亿分手费？传交个朋友天价买账号；百度被裁员工爆料：团队曾超额完成业绩；华为自研编程语言可试用；中芯国际换帅 | 物联网头条