获取通用物模型列表

请求参数

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

排序

可选

type

integer <int64>

可选

物模型类型 1:property属性 2:event事件 3:action行为

types

array[integer <int64>]

可选

identifiers

array[string]

过滤标识符列表

可选

productIDs

array[string]

可选

提取产品共有的物模型

name

string

可选

productCategoryID

integer <int64>

可选

productCategoryWithFather

boolean

可选

isCanSceneLinkage

integer <int64>

是否可以场景联动

可选

funcGroup

integer <int64>

可选

功能分类: 1:普通功能 2:系统功能

userPerm

integer <int64>

可选

用户权限操作: 1:r(只读) 3:rw(可读可写)

groupID

integer <int64>

可选

groupIDs

array[integer <int64>]

可选

projectID

string

可选

过滤项目下共有的物模型

areaID

string

可选

areaIDPath

string

可选

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

propertyMode

string

可选

属性类型可用读写类型: r(只读) rw(可读可写)

controlMode

integer <int64>

可选

控制模式: 1: 可以群控,可以单控 2:只能单控

productSceneMode

string

可选

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

示例

{
  "page": {
    "page": 0,
    "size": 0,
    "orders": [
      {
        "field": "string",
        "sort": 0
      }
    ]
  },
  "type": 0,
  "types": [
    0
  ],
  "identifiers": [
    "string"
  ],
  "productIDs": [
    "string"
  ],
  "name": "string",
  "productCategoryID": 0,
  "productCategoryWithFather": true,
  "isCanSceneLinkage": 0,
  "funcGroup": 0,
  "userPerm": 0,
  "groupID": 0,
  "groupIDs": [
    0
  ],
  "projectID": "string",
  "areaID": "string",
  "areaIDPath": "string",
  "propertyMode": "string",
  "controlMode": 0,
  "productSceneMode": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/things/schema/common/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 ''

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (CommonSchemaIndexResp)

可选

list

array[object (CommonSchemaInfo) {15}]

必需

分页信息,只获取一个则不填

page

integer <int64>

页码

可选

pageSize

integer <int64>

每页大小

可选

total

integer <int64>

可选

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "type": 0,
        "identifier": "string",
        "extendConfig": "string",
        "name": "string",
        "desc": "string",
        "required": 0,
        "affordance": "string",
        "isCanSceneLinkage": 0,
        "funcGroup": 0,
        "userPerm": 0,
        "isHistory": 0,
        "isPassword": 0,
        "order": 0,
        "controlMode": 0
      }
    ],
    "page": 0,
    "pageSize": 0,
    "total": 0
  }
}