获取产品信息列表

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

page

object (PageInfo)

可选

page

integer <int64>

页码

可选

size

integer <int64>

每页大小

可选

orders

array[object (OrderBy) {2}]

排序

可选

productName

string

过滤产品名称

可选

deviceType

integer <int64>

可选

过滤设备类型:0:全部,1:设备,2:网关,3:子设备

<= 3

deviceTypes

array[integer <int64>]

可选

设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备

productIDs

array[string]

过滤产品id列表

可选

tags

array[object (Tag) {2}]

可选

key tag过滤查询,非模糊查询为tag的名,value为tag对应的值

key

string

必需

value

string

必需

protocolCode

string

协议code

可选

protocolType

string

协议类型

可选

withProtocol

boolean

同时返回协议详情

可选

withCategory

boolean

同时返回品类详情

可选

sceneModes

array[string]

可选

场景模式读写类型: r(只读) rw(可读可写) none(不参与场景)

sceneMode

string

可选

场景模式读写类型: r(只读) rw(可读可写) none(不参与场景)

status

integer <int64>

可选

产品状态 1:启用 2:禁用 3:开发中

statuses

array[integer <int64>]

可选

产品状态 1:启用 2:禁用 3:开发中

netType

integer <int64>

可选

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE

<= 10

projectID

string

可选

项目id,只获取项目下有设备的

areaID

string

可选

过滤区域下有设备的产品

areaIDPath

string

可选

过滤区域id路径下有设备的产品

categoryIDs

array[integer <int64>]

产品品类

可选

示例

{
    "page": {
        "page": 0,
        "size": 0,
        "orders": [
            {
                "field": "string",
                "sort": 0
            }
        ]
    },
    "productName": "string",
    "deviceType": 3,
    "deviceTypes": [
        0
    ],
    "productIDs": [
        "string"
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "protocolCode": "string",
    "protocolType": "string",
    "withProtocol": true,
    "withCategory": true,
    "sceneModes": [
        "string"
    ],
    "sceneMode": "string",
    "status": 0,
    "statuses": [
        0
    ],
    "netType": 10,
    "projectID": "string",
    "areaID": "string",
    "areaIDPath": "string",
    "categoryIDs": [
        0
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/things/product/info/index' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": {
        "page": 0,
        "size": 0,
        "orders": [
            {
                "field": "string",
                "sort": 0
            }
        ]
    },
    "productName": "string",
    "deviceType": 3,
    "deviceTypes": [
        0
    ],
    "productIDs": [
        "string"
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "protocolCode": "string",
    "protocolType": "string",
    "withProtocol": true,
    "withCategory": true,
    "sceneModes": [
        "string"
    ],
    "sceneMode": "string",
    "status": 0,
    "statuses": [
        0
    ],
    "netType": 10,
    "projectID": "string",
    "areaID": "string",
    "areaIDPath": "string",
    "categoryIDs": [
        0
    ]
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (ProductInfoIndexResp)

可选

list

array[object (ProductInfo) {26}]

产品信息

必需

page

integer <int64>

页码

可选

pageSize

integer <int64>

每页大小

可选

total

integer <int64>

可选

示例

{
    "code": "200",
    "msg": "string",
    "data": {
        "list": [
            {
                "createdTime": "string",
                "productID": "string",
                "productName": "string",
                "productImg": "string",
                "isUpdateProductImg": true,
                "authMode": 2,
                "deviceType": 4,
                "deviceSchemaMode": 4,
                "categoryID": 0,
                "netType": 10,
                "protocolCode": "string",
                "subProtocolCode": "string",
                "autoRegister": 3,
                "secret": "string",
                "trialTime": "string",
                "desc": "string",
                "tags": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "sceneMode": "string",
                "status": 0,
                "bindLevel": 0,
                "protocolConf": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "subProtocolConf": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "protocol": {
                    "id": 0,
                    "name": "string",
                    "code": "string",
                    "type": "string",
                    "transProtocol": "string",
                    "desc": "string",
                    "endpoints": [
                        "string"
                    ],
                    "etcdKey": "string",
                    "isEnableSyncProduct": 0,
                    "isEnableSyncDevice": 0,
                    "configFields": [
                        {
                            "id": 0,
                            "group": "string",
                            "key": "string",
                            "label": "string",
                            "isRequired": true,
                            "sort": 0
                        }
                    ],
                    "configInfos": [
                        {
                            "id": 0,
                            "config": {},
                            "desc": "string"
                        }
                    ],
                    "productFields": [
                        {
                            "id": 0,
                            "group": "string",
                            "key": "string",
                            "label": "string",
                            "isRequired": true,
                            "sort": 0
                        }
                    ],
                    "deviceFields": [
                        {
                            "id": 0,
                            "group": "string",
                            "key": "string",
                            "label": "string",
                            "isRequired": true,
                            "sort": 0
                        }
                    ]
                },
                "category": {
                    "id": 0,
                    "parentID": 0,
                    "idPath": [
                        0
                    ],
                    "name": "string",
                    "desc": "string",
                    "headImg": "string",
                    "isUpdateHeadImg": true,
                    "isLeaf": 0,
                    "deviceCount": 0,
                    "children": [
                        {}
                    ]
                },
                "config": {
                    "productID": "string",
                    "devInit": {
                        "tenantCode": "string",
                        "projectID": "string",
                        "areaID": "string",
                        "deptID": "string"
                    }
                },
                "customUi": {}
            }
        ],
        "page": 0,
        "pageSize": 0,
        "total": 0
    }
}