获取场景信息列表 - 联犀-企业版

请求参数

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

排序

可选

name

string

场景名模糊查询

可选

tag

string

可选

标签 admin: 管理员 normal: 普通

areaID

string

可选

sceneIDs

array[integer <int64>]

根据场景ID来过滤

可选

type

string

可选

触发类型 auto manual:手动触发

status

integer <int64>

可选

状态（1启用 2禁用 3异常）

alarmID

integer <int64>

告警id

可选

deviceMode

string

设备模式

可选

productID

string

产品id

可选

deviceName

string

设备名

可选

deviceFilterMode

integer <int64>

可选

设备过滤模式: 1,过滤触发或执行(默认) 2,过滤触发 3,过滤执行

hasActionType

string

过滤有某个执行类型

可选

isCommon

integer <int64>

是否是常用的

可选

isOnlyCore

integer <int64>

可选

不返回if,when和then

示例

{
    "page": {
        "page": 0,
        "size": 0,
        "orders": [
            {
                "field": "string",
                "sort": 0
            }
        ]
    },
    "name": "string",
    "tag": "string",
    "areaID": "string",
    "sceneIDs": [
        0
    ],
    "type": "string",
    "status": 0,
    "alarmID": 0,
    "deviceMode": "string",
    "productID": "string",
    "deviceName": "string",
    "deviceFilterMode": 0,
    "hasActionType": "string",
    "isCommon": 0,
    "isOnlyCore": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/things/rule/scene/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
            }
        ]
    },
    "name": "string",
    "tag": "string",
    "areaID": "string",
    "sceneIDs": [
        0
    ],
    "type": "string",
    "status": 0,
    "alarmID": 0,
    "deviceMode": "string",
    "productID": "string",
    "deviceName": "string",
    "deviceFilterMode": 0,
    "hasActionType": "string",
    "isCommon": 0,
    "isOnlyCore": 0
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (SceneInfoIndexResp)

可选

list

array[object (SceneInfo) {24}]

场景信息

必需

page

integer <int64>

页码

可选

pageSize

integer <int64>

每页大小

可选

total

integer <int64>

可选

示例

{
    "code": "200",
    "msg": "string",
    "data": {
        "list": [
            {
                "id": 0,
                "name": "string",
                "areaID": "string",
                "status": 0,
                "reason": "string",
                "tag": "string",
                "isCommon": 0,
                "type": "string",
                "flowPath": [
                    {
                        "type": "string",
                        "subType": "string",
                        "info": "string"
                    }
                ],
                "desc": "string",
                "createdTime": 0,
                "if": "string",
                "when": "string",
                "then": "string",
                "headImg": "string",
                "isUpdateHeadImg": true,
                "logo": "string",
                "lastRunTime": 0,
                "productID": "string",
                "deviceName": "string",
                "deviceAlias": "string",
                "deviceMode": "string",
                "body": "string",
                "updatedTime": 0
            }
        ],
        "page": 0,
        "pageSize": 0,
        "total": 0
    }
}