根据ProductKey查询产品

请求参数

Query 参数

productKey

string

可选

示例值:

SETTLEPD

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization-Type

string

必需

默认值:

X-Authorization

string

必需

默认值:

Body 参数application/json

string

产品ID

必需

name

string

产品名称

必需

productKey

string

产品密钥

必需

heartbeat

integer <int64>

心跳间隔

必需

protocolType

string

可选

设备协议类型，如Iot, 104等

dataTopology

string

必需

拓扑，如父设备，子设备

dataTopologyName

string

拓扑名

必需

group

string

组别

必需

description

string

描述

必需

basicProperties

array[object (BaseProperty) {6}]

基本属性

可选

identifier

string

标识

必需

name

string

名称

必需

value

string

值

可选

group

string

分组

可选

dataType

enum<string>

数据类型

必需

枚举值:

LONGDOUBLESTRINGBOOL

unit

string

单位

可选

properties

array[object (DevicePropertyDto) {16}]

物模型属性

可选

identifier

string

属性标识

必需

name

string

属性名

必需

desc

string

属性描述

可选

sort

string

是否排序

可选

valueInfo

object (AbstractValueInfo)

值描述信息

可选

value

object

值

可选

保存时不用传入

integer <int64>

值的最后更新时间

可选

保存时不用传入

accessMode

string

属性权限

可选

可选的权限才能修改属性

propertyType

string

属性类型

可选

如：遥测、遥信

extension

object

扩展字段

可选

map<sting,object>

store

boolean

是否存储

可选

filter

boolean

是否过滤

可选

filterRule

object (FilterRuleDto)

过滤规则

可选

kind

string

属性分类

可选

如：动作定值或者运行参数

groupName

string

分组名称

可选

groupIdentifier

string

分组标识

可选

serves

array[object (DeviceServeDto) {9}]

物模型服务

可选

identifier

string

标识

可选

method

string

可选

方法标识（可不填。无方法标识时，调用服务后下发给设备的是服务标识；有方法标识时，实际下发的是方法标识）

pId

string

可选

父设备的id（只有一个父设备时可不填，多个父设备时必填）

name

string

服务名

可选

desc

string

服务描述

可选

sort

integer <int32>

是否排序

可选

inputs

array[object (PropertyDto) {7}]

入参

可选

defaultValue

object

可选

map<string,object>类型，入参的默认值

outputs

array[object (PropertyDto) {7}]

出参

可选

events

array[object (DeviceEventDto) {6}]

物模型事件

可选

identifier

string

事件标识

必需

name

string

事件名

必需

desc

string

事件描述

可选

sort

integer <int32>

排序

可选

eventInfos

array[object (PropertyDto) {7}]

入参

可选

values

object

值

可选

currentVersion

string

当前版本号

必需

creationTime

integer

产品创建时间

可选

methodMappings

object

必需

mappingId

string

方法映射标识

必需

name

string

方法名称

必需

mappingType

enum<string>

服务类型

必需

可选[service,propertyWrite]

枚举值:

servicepropertyWrite

identifier

string

属性标识

可选

属性写入对应的属性标识

value

属性写入的值

可选

serviceId

string

服务名称

可选

param

array [object {5}]

服务参数

可选

服务调用对应的参数值集合

desc

string

描述

可选

lastOperTime

string

最后操作时间

可选

operResult

string

操作结果

可选

protocol104Config

object (104产品规约设置)

104产品配置

可选

telemetries

object (遥测结构)

必需

telesignals

object (遥信结构)

必需

telecommands

object (遥控结构)

必需

teleadjustings

object (遥调结构)

必需

fixedValues

object (定值结构)

必需

示例

{
    "id": "string",
    "name": "string",
    "productKey": "string",
    "heartbeat": 0,
    "protocolType": "string",
    "dataTopology": "string",
    "dataTopologyName": "string",
    "group": "string",
    "description": "string",
    "basicProperties": [
        {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "group": "string",
            "dataType": "LONG",
            "unit": "string"
        }
    ],
    "properties": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": "string",
            "valueInfo": {
                "valueType": "string",
                "unit": "string",
                "coefficient": 0,
                "precision": 0,
                "min": 0,
                "max": 0,
                "maxLength": 0,
                "falseText": "string",
                "trueText": "string",
                "elements": {},
                "elementType": {},
                "properties": [
                    {
                        "identifier": "string",
                        "name": "string",
                        "desc": "string",
                        "sort": "string",
                        "valueInfo": {},
                        "value": {},
                        "ts": 0
                    }
                ]
            },
            "value": {},
            "ts": 0,
            "accessMode": "string",
            "propertyType": "string",
            "extension": {},
            "store": true,
            "filter": true,
            "filterRule": {
                "regions": [
                    {
                        "left": 0,
                        "right": 0
                    }
                ],
                "deadZone": 0,
                "ignoreDuplicate": true
            },
            "kind": "string",
            "groupName": "string",
            "groupIdentifier": "string"
        }
    ],
    "serves": [
        {
            "identifier": "string",
            "method": "string",
            "pId": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "inputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "defaultValue": {},
            "outputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ]
        }
    ],
    "events": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "eventInfos": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "values": {}
        }
    ],
    "currentVersion": "string",
    "creationTime": 0,
    "methodMappings": {
        "mappingId": "string",
        "name": "string",
        "mappingType": "service",
        "identifier": "string",
        "value": "string",
        "serviceId": "string",
        "param": [
            {
                "identifier": "string",
                "value": "string",
                "default": true,
                "dataType": "string",
                "name": "string"
            }
        ],
        "desc": "string",
        "lastOperTime": "string",
        "operResult": "string"
    },
    "protocol104Config": {
        "telemetries": {
            "identifier": "string",
            "pointAddr": "string",
            "coefficient": "string",
            "precision": "string",
            "unit": "string",
            "description": "string"
        },
        "telesignals": {
            "identifier": "string",
            "pointAddr": "string",
            "description": "string",
            "soe": true
        },
        "telecommands": {
            "identifier": "string",
            "pointAddr": "string",
            "controlType": "string",
            "description": "string"
        },
        "teleadjustings": {
            "identifier": "string",
            "pointAddr": "string",
            "adjustType": "string",
            "unit": "string",
            "description": "string"
        },
        "fixedValues": {
            "identifier": "string",
            "pointAddr": "string",
            "unit": "string",
            "description": "string"
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://iot-dev.utapp.cn/api/productV2/getProductByProductKey?productKey=SETTLEPD' \
--header 'Authorization-Type;' \
--header 'X-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "name": "string",
    "productKey": "string",
    "heartbeat": 0,
    "protocolType": "string",
    "dataTopology": "string",
    "dataTopologyName": "string",
    "group": "string",
    "description": "string",
    "basicProperties": [
        {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "group": "string",
            "dataType": "LONG",
            "unit": "string"
        }
    ],
    "properties": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": "string",
            "valueInfo": {
                "valueType": "string",
                "unit": "string",
                "coefficient": 0,
                "precision": 0,
                "min": 0,
                "max": 0,
                "maxLength": 0,
                "falseText": "string",
                "trueText": "string",
                "elements": {},
                "elementType": {},
                "properties": [
                    {
                        "identifier": "string",
                        "name": "string",
                        "desc": "string",
                        "sort": "string",
                        "valueInfo": {},
                        "value": {},
                        "ts": 0
                    }
                ]
            },
            "value": {},
            "ts": 0,
            "accessMode": "string",
            "propertyType": "string",
            "extension": {},
            "store": true,
            "filter": true,
            "filterRule": {
                "regions": [
                    {
                        "left": 0,
                        "right": 0
                    }
                ],
                "deadZone": 0,
                "ignoreDuplicate": true
            },
            "kind": "string",
            "groupName": "string",
            "groupIdentifier": "string"
        }
    ],
    "serves": [
        {
            "identifier": "string",
            "method": "string",
            "pId": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "inputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "defaultValue": {},
            "outputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ]
        }
    ],
    "events": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "eventInfos": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "values": {}
        }
    ],
    "currentVersion": "string",
    "creationTime": 0,
    "methodMappings": {
        "mappingId": "string",
        "name": "string",
        "mappingType": "service",
        "identifier": "string",
        "value": "string",
        "serviceId": "string",
        "param": [
            {
                "identifier": "string",
                "value": "string",
                "default": true,
                "dataType": "string",
                "name": "string"
            }
        ],
        "desc": "string",
        "lastOperTime": "string",
        "operResult": "string"
    },
    "protocol104Config": {
        "telemetries": {
            "identifier": "string",
            "pointAddr": "string",
            "coefficient": "string",
            "precision": "string",
            "unit": "string",
            "description": "string"
        },
        "telesignals": {
            "identifier": "string",
            "pointAddr": "string",
            "description": "string",
            "soe": true
        },
        "telecommands": {
            "identifier": "string",
            "pointAddr": "string",
            "controlType": "string",
            "description": "string"
        },
        "teleadjustings": {
            "identifier": "string",
            "pointAddr": "string",
            "adjustType": "string",
            "unit": "string",
            "description": "string"
        },
        "fixedValues": {
            "identifier": "string",
            "pointAddr": "string",
            "unit": "string",
            "description": "string"
        }
    }
}'

返回响应

🟢200成功

application/json

Body

string

产品ID

必需

name

string

产品名称

必需

productKey

string

产品密钥

必需

heartbeat

integer <int64>

心跳间隔

必需

protocolType

string

可选

设备协议类型，如Iot, 104等

dataTopology

string

必需

拓扑，如父设备，子设备

dataTopologyName

string

拓扑名

必需

group

string

组别

必需

description

string

描述

必需

basicProperties

array[object (BaseProperty) {6}]

基本属性

可选

identifier

string

标识

必需

name

string

名称

必需

value

string

值

可选

group

string

分组

可选

dataType

enum<string>

数据类型

必需

枚举值:

LONGDOUBLESTRINGBOOL

unit

string

单位

可选

properties

array[object (DevicePropertyDto) {16}]

物模型属性

可选

identifier

string

属性标识

必需

name

string

属性名

必需

desc

string

属性描述

可选

sort

string

是否排序

可选

valueInfo

object (AbstractValueInfo)

值描述信息

可选

value

object

值

可选

保存时不用传入

integer <int64>

值的最后更新时间

可选

保存时不用传入

accessMode

string

属性权限

可选

可选的权限才能修改属性

propertyType

string

属性类型

可选

如：遥测、遥信

extension

object

扩展字段

可选

map<sting,object>

store

boolean

是否存储

可选

filter

boolean

是否过滤

可选

filterRule

object (FilterRuleDto)

过滤规则

可选

kind

string

属性分类

可选

如：动作定值或者运行参数

groupName

string

分组名称

可选

groupIdentifier

string

分组标识

可选

serves

array[object (DeviceServeDto) {9}]

物模型服务

可选

identifier

string

标识

可选

method

string

可选

方法标识（可不填。无方法标识时，调用服务后下发给设备的是服务标识；有方法标识时，实际下发的是方法标识）

pId

string

可选

父设备的id（只有一个父设备时可不填，多个父设备时必填）

name

string

服务名

可选

desc

string

服务描述

可选

sort

integer <int32>

是否排序

可选

inputs

array[object (PropertyDto) {7}]

入参

可选

defaultValue

object

可选

map<string,object>类型，入参的默认值

outputs

array[object (PropertyDto) {7}]

出参

可选

events

array[object (DeviceEventDto) {6}]

物模型事件

可选

identifier

string

事件标识

必需

name

string

事件名

必需

desc

string

事件描述

可选

sort

integer <int32>

排序

可选

eventInfos

array[object (PropertyDto) {7}]

入参

可选

values

object

值

可选

currentVersion

string

当前版本号

必需

creationTime

integer

产品创建时间

可选

methodMappings

object

必需

mappingId

string

方法映射标识

必需

name

string

方法名称

必需

mappingType

enum<string>

服务类型

必需

可选[service,propertyWrite]

枚举值:

servicepropertyWrite

identifier

string

属性标识

可选

属性写入对应的属性标识

value

属性写入的值

可选

serviceId

string

服务名称

可选

param

array [object {5}]

服务参数

可选

服务调用对应的参数值集合

desc

string

描述

可选

lastOperTime

string

最后操作时间

可选

operResult

string

操作结果

可选

protocol104Config

object (104产品规约设置)

104产品配置

可选

telemetries

object (遥测结构)

必需

telesignals

object (遥信结构)

必需

telecommands

object (遥控结构)

必需

teleadjustings

object (遥调结构)

必需

fixedValues

object (定值结构)

必需

示例

{
    "id": "string",
    "name": "string",
    "productKey": "string",
    "heartbeat": 0,
    "protocolType": "string",
    "dataTopology": "string",
    "dataTopologyName": "string",
    "group": "string",
    "description": "string",
    "basicProperties": [
        {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "group": "string",
            "dataType": "LONG",
            "unit": "string"
        }
    ],
    "properties": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": "string",
            "valueInfo": {
                "valueType": "string",
                "unit": "string",
                "coefficient": 0,
                "precision": 0,
                "min": 0,
                "max": 0,
                "maxLength": 0,
                "falseText": "string",
                "trueText": "string",
                "elements": {},
                "elementType": {},
                "properties": [
                    {
                        "identifier": "string",
                        "name": "string",
                        "desc": "string",
                        "sort": "string",
                        "valueInfo": {},
                        "value": {},
                        "ts": 0
                    }
                ]
            },
            "value": {},
            "ts": 0,
            "accessMode": "string",
            "propertyType": "string",
            "extension": {},
            "store": true,
            "filter": true,
            "filterRule": {
                "regions": [
                    {
                        "left": 0,
                        "right": 0
                    }
                ],
                "deadZone": 0,
                "ignoreDuplicate": true
            },
            "kind": "string",
            "groupName": "string",
            "groupIdentifier": "string"
        }
    ],
    "serves": [
        {
            "identifier": "string",
            "method": "string",
            "pId": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "inputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "defaultValue": {},
            "outputs": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ]
        }
    ],
    "events": [
        {
            "identifier": "string",
            "name": "string",
            "desc": "string",
            "sort": 0,
            "eventInfos": [
                {
                    "identifier": "string",
                    "name": "string",
                    "desc": "string",
                    "sort": "string",
                    "valueInfo": {
                        "valueType": "string",
                        "unit": "string",
                        "coefficient": 0,
                        "precision": 0,
                        "min": 0,
                        "max": 0,
                        "maxLength": 0,
                        "falseText": "string",
                        "trueText": "string",
                        "elements": {},
                        "elementType": {},
                        "properties": [
                            {}
                        ]
                    },
                    "value": {},
                    "ts": 0
                }
            ],
            "values": {}
        }
    ],
    "currentVersion": "string",
    "creationTime": 0,
    "methodMappings": {
        "mappingId": "string",
        "name": "string",
        "mappingType": "service",
        "identifier": "string",
        "value": "string",
        "serviceId": "string",
        "param": [
            {
                "identifier": "string",
                "value": "string",
                "default": true,
                "dataType": "string",
                "name": "string"
            }
        ],
        "desc": "string",
        "lastOperTime": "string",
        "operResult": "string"
    },
    "protocol104Config": {
        "telemetries": {
            "identifier": "string",
            "pointAddr": "string",
            "coefficient": "string",
            "precision": "string",
            "unit": "string",
            "description": "string"
        },
        "telesignals": {
            "identifier": "string",
            "pointAddr": "string",
            "description": "string",
            "soe": true
        },
        "telecommands": {
            "identifier": "string",
            "pointAddr": "string",
            "controlType": "string",
            "description": "string"
        },
        "teleadjustings": {
            "identifier": "string",
            "pointAddr": "string",
            "adjustType": "string",
            "unit": "string",
            "description": "string"
        },
        "fixedValues": {
            "identifier": "string",
            "pointAddr": "string",
            "unit": "string",
            "description": "string"
        }
    }
}