Skip to content

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 NameParameter DescriptionRequest TypeRequiredData Typeschema
Authorizationheaderfalsestring
fidFamily ID, required when home mode is enabled, otherwise notqueryfalsestring
pageCurrent page numberqueryfalseinteger(int32)
pageSizeNumber of items per pagequeryfalseinteger(int32)

Response Status:

Status CodeDescriptionschema
200OKApiResult«PageInfo«Scene Param»»
401Unauthorized
403Forbidden
404Not Found

Response Parameters:

Parameter NameParameter DescriptionTypeschema
codeinteger(int32)integer(int32)
dataPageInfo«Scene Param»PageInfo«Scene Param»
  endRowinteger(int64)
  hasNextPageboolean
  hasPreviousPageboolean
  isFirstPageboolean
  isLastPageboolean
  listarrayScene Param Res
    fidFamily IDstring
    isCommonIs commonboolean
    sceneInfoScene informationScene InfoScene Info
      iconScene iconstring
      idScene primary key IDinteger
      metaDataListLinkage dataarrayLinkage Data
        actionListExecute actionsarrayExecute Action
          actionIdExecute action IDinteger
          codeThing model identifierstring
          dataTypeThing model data typestring
          idThing model function IDinteger
          nameThing model function namestring
          subNamestring
          subTypeRead/write typestring
          typeThing model function typestring
          unitThing model unitstring
          valueThing model valueobject
        deviceKeyDevice/Group IDstring
        deviceNameDevice name/Group namestring
        deviceTypeDevice type, 1: Normal device, 2: Groupinteger
        logoImageScene LOGOstring
        productKeyProduct KEYstring
      nameScene namestring
      sceneIdScene IDstring
      uidEnd-user IDstring
  navigateFirstPageinteger(int32)
  navigateLastPageinteger(int32)
  navigatePagesinteger(int32)
  navigatepageNumsarrayinteger
  nextPageinteger(int32)
  pageNuminteger(int32)
  pageSizeinteger(int32)
  pagesinteger(int32)
  prePageinteger(int32)
  sizeinteger(int32)
  startRowinteger(int64)
  totalinteger(int64)
extMsgstring
msgstring

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": ""
}