Appearance
Query Common Scenes
Interface Address:/v2/cep/enduserapi/selectCommonSceneList
Request Method:GET
Request Data Type:application/x-www-form-urlencoded
Response Data Type:*/*
Interface Description:Query Common Scenes
Request Parameters:
| Parameter Name | Parameter Description | Request Type | Required | Data Type | schema |
|---|---|---|---|---|---|
| Authorization | header | false | string | ||
| fid | Family ID, required when home mode is enabled, otherwise not | query | false | string | |
| page | Current page number | query | false | integer(int32) | |
| pageSize | Number of items per page | query | false | integer(int32) |
Response Status:
| Status Code | Description | schema |
|---|---|---|
| 200 | OK | ApiResult«PageInfo«Scene Param»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response Parameters:
| Parameter Name | Parameter Description | Type | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageInfo«Scene Param» | PageInfo«Scene Param» | |
| endRow | integer(int64) | ||
| hasNextPage | boolean | ||
| hasPreviousPage | boolean | ||
| isFirstPage | boolean | ||
| isLastPage | boolean | ||
| list | array | Scene Param Res | |
| fid | Family ID | string | |
| isCommon | Is common | boolean | |
| sceneInfo | Scene information | Scene Info | Scene Info |
| icon | Scene icon | string | |
| id | Scene primary key ID | integer | |
| metaDataList | Linkage data | array | Linkage Data |
| actionList | Execute actions | array | Execute Action |
| actionId | Execute action ID | integer | |
| code | Thing model identifier | string | |
| dataType | Thing model data type | string | |
| id | Thing model function ID | integer | |
| name | Thing model function name | string | |
| subName | string | ||
| subType | Read/write type | string | |
| type | Thing model function type | string | |
| unit | Thing model unit | string | |
| value | Thing model value | object | |
| deviceKey | Device/Group ID | string | |
| deviceName | Device name/Group name | string | |
| deviceType | Device type, 1: Normal device, 2: Group | integer | |
| logoImage | Scene LOGO | string | |
| productKey | Product KEY | string | |
| name | Scene name | string | |
| sceneId | Scene ID | string | |
| uid | End-user ID | string | |
| navigateFirstPage | integer(int32) | ||
| navigateLastPage | integer(int32) | ||
| navigatePages | integer(int32) | ||
| navigatepageNums | array | integer | |
| nextPage | integer(int32) | ||
| pageNum | integer(int32) | ||
| pageSize | integer(int32) | ||
| pages | integer(int32) | ||
| prePage | integer(int32) | ||
| size | integer(int32) | ||
| startRow | integer(int64) | ||
| total | integer(int64) | ||
| extMsg | string | ||
| msg | string |
Response Example:
javascript
{
"code": 0,
"data": {
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"fid": "",
"isCommon": true,
"sceneInfo": {
"icon": "",
"id": 0,
"metaDataList": [
{
"actionList": [
{
"actionId": 0,
"code": "",
"dataType": "",
"id": 0,
"name": "",
"subName": "",
"subType": "",
"type": "",
"unit": "",
"value": {}
}
],
"deviceKey": "",
"deviceName": "",
"deviceType": 0,
"logoImage": "",
"productKey": ""
}
],
"name": "",
"sceneId": "",
"uid": ""
}
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
},
"extMsg": "",
"msg": ""
}