获取设备列表 - 联犀-things

请求参数

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}]

排序

可选

tenantCode

string

可选

productID

string

可选

产品id 为空时获取所有产品

productIDs

array[string]

可选

产品id 为空时获取所有产品

deviceName

string

可选

过滤条件:模糊查询设备名

deviceNames

array[string]

可选

过滤条件:精准查询设备名

expTime

object (CompareInt64)

可选

cmpType

string

必需

"=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询

value

string

必需

ratedPower

object (CompareInt64)

可选

rssi

object (CompareInt64)

可选

deviceAlias

string

可选

过滤条件:模糊查询设备别名

deviceTypes

array[integer <int64>]

可选

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

position

object (Point)

可选

longitude

number <double>

经度

必需

<= 180

latitude

number <double>

纬度

必需

<= 90

range

integer <int64>

可选

过滤条件:距离坐标点固定范围内的设备单位：米

tags

array[object (Tag) {2}]

可选

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

key

string

必需

value

string

必需

withProperties

array[string]

可选

如果不为nil,如果为空,获取设备所有最新属性如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回

withProfiles

array[string]

可选

areaIDs

array[string]

项目区域ids

可选

areaIDPath

string

区域路径过滤

可选

isOnline

integer <int64>

可选

在线状态过滤 1离线 2在线

<= 2

productCategoryID

integer <int64>

可选

productCategoryIDs

array[integer <int64>]

可选

withShared

integer <int64>

可选

过滤分享的设备1: 同时获取分享的设备 2:只获取分享的设备

<= 2

withCollect

integer <int64>

可选

过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备

<= 2

versions

array[string]

可选

notVersion

string

可选

gateway

object (DeviceCore)

可选

productID

string

产品ID

必需

productName

string

可选

deviceName

string

设备名称

必需

groupID

string

可选

notGroupID

string

可选

parentGroupID

string

可选

groupPurpose

string

可选

设备分组用途不填默认为default

groupName

string

可选

notAreaID

string

可选

devices

array[object (DeviceCore) {3}]

可选

productID

string

产品ID

必需

productName

string

可选

deviceName

string

设备名称

必需

status

integer <int64>

可选

设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)

statuses

array[integer <int64>]

可选

withOwner

boolean

可选

同时获取拥有人的信息

withGateway

boolean

可选

同时返回子设备绑定的网关信息

hasOwner

integer <int64>

可选

是否被人拥有,1为是 2为否

userID

string

可选

netType

integer <int64>

可选

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

<= 8

withArea

boolean

同时返回区域信息

可选

isOnlyCore

boolean

只返回核心信息

可选

iccid

string

SIM卡卡号

可选

withGroups

array[string]

可选

示例

{
  "page": {
    "page": 0,
    "size": 0,
    "orders": [
      {
        "field": "string",
        "sort": 0
      }
    ]
  },
  "tenantCode": "string",
  "productID": "string",
  "productIDs": [
    "string"
  ],
  "deviceName": "string",
  "deviceNames": [
    "string"
  ],
  "expTime": {
    "cmpType": "string",
    "value": "string"
  },
  "ratedPower": {
    "cmpType": "string",
    "value": "string"
  },
  "rssi": {
    "cmpType": "string",
    "value": "string"
  },
  "deviceAlias": "string",
  "deviceTypes": [
    0
  ],
  "position": {
    "longitude": 180,
    "latitude": 90
  },
  "range": 0,
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "withProperties": [
    "string"
  ],
  "withProfiles": [
    "string"
  ],
  "areaIDs": [
    "string"
  ],
  "areaIDPath": "string",
  "isOnline": 2,
  "productCategoryID": 0,
  "productCategoryIDs": [
    0
  ],
  "withShared": 2,
  "withCollect": 2,
  "versions": [
    "string"
  ],
  "notVersion": "string",
  "gateway": {
    "productID": "string",
    "productName": "string",
    "deviceName": "string"
  },
  "groupID": "string",
  "notGroupID": "string",
  "parentGroupID": "string",
  "groupPurpose": "string",
  "groupName": "string",
  "notAreaID": "string",
  "devices": [
    {
      "productID": "string",
      "productName": "string",
      "deviceName": "string"
    }
  ],
  "status": 0,
  "statuses": [
    0
  ],
  "withOwner": true,
  "withGateway": true,
  "hasOwner": 0,
  "userID": "string",
  "netType": 8,
  "withArea": true,
  "isOnlyCore": true,
  "iccid": "string",
  "withGroups": [
    "string"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (DeviceInfoIndexResp)

可选

list

array[object (DeviceInfo) {53}]

设备信息

必需

page

integer <int64>

页码

可选

pageSize

integer <int64>

每页大小

可选

total

integer <int64>

可选

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "tenantCode": "string",
        "productID": "string",
        "projectID": "string",
        "productName": "string",
        "deviceType": 0,
        "productImg": "string",
        "areaID": "string",
        "deviceName": "string",
        "deviceAlias": "string",
        "secret": "string",
        "cert": "string",
        "imei": "string",
        "mac": "string",
        "categoryID": 0,
        "version": "string",
        "hardInfo": "string",
        "softInfo": "string",
        "mobileOperator": 10,
        "phone": "string",
        "iccid": "string",
        "position": {
          "longitude": 180,
          "latitude": 90
        },
        "address": "string",
        "adcode": "string",
        "tags": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "schemaAlias": {},
        "isOnline": 2,
        "firstLogin": "string",
        "firstBind": "string",
        "lastBind": "string",
        "lastLogin": "string",
        "expTime": "string",
        "logLevel": 5,
        "rssi": 0,
        "createdTime": "string",
        "status": 0,
        "isEnable": 0,
        "withProperties": {},
        "protocolConf": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "subProtocolConf": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "profiles": {},
        "owner": {
          "userID": "string",
          "userName": "string",
          "email": "string",
          "phone": "string",
          "lastIP": "string",
          "regIP": "string",
          "nickName": "string",
          "headImg": "string",
          "createdTime": "string"
        },
        "ratedPower": 0,
        "netType": 10,
        "needConfirmVersion": "string",
        "userID": "string",
        "lastIp": "string",
        "sort": 0,
        "desc": "string",
        "distributor": {
          "id": 0,
          "idPath": "string"
        },
        "gateway": {},
        "area": {
          "projectID": "string",
          "areaID": "string",
          "areaName": "string"
        },
        "groups": [
          {
            "id": 0,
            "parentID": 0,
            "name": "string",
            "purpose": "string"
          }
        ]
      }
    ],
    "page": 0,
    "pageSize": 0,
    "total": 0
  }
}