Skip to content

Get a scene ​

GET /clip/v2/resource/scene/scene_uuid

Get a scene by UUID, including its settings and associated image, where applicable.

Example request

json
{}

Parameters ​

The example request uses an empty object ({}); no body fields are defined.

Example response

json
{
  "code": 0,
  "data": {
    "arr": [],
    "obj": {
      "background": "",
      "colors": [
        4293551661,
        4292219417,
        4293890993,
        4283345655,
        4288215906
      ],
      "icon": "",
      "id": "3EBD2DB5-B946-4BBA-B678-C7B7C6BA4D0F",
      "is_active": 0,
      "name": "端午龙舟",
      "parent_id": "2F84620F-C289-4AA3-8A1E-D6DE9C33D1F5",
      "parent_type": "group_light",
      "picture_id": "E423E110-0398-4FFB-9E3D-E8E3A1CEEEEB",
      "picture_type": "file",
      "picture_url": "http://192.168.41.110:8000/20240829_173416_E423E110-0398-4FFB-9E3D-E8E3A1CEEEEB.png",
      "scene_type": 2,
      "sequence": 0,
      "type": "scene"
    }
  },
  "msg": "success"
}

Responses ​

Status codeMeaning
200OK

Response fields ​

HTTP 200 OK

FieldTypeRequiredDescription
codeintegerYesResult code.
msgstringYesResponse message.
dataobjectYesResponse payload.
data.objobjectYesReturned resource.
data.obj.idstringYesScene ID
data.obj.typestringYesAlways scene.
data.obj.parent_idstringYesParent resource
data.obj.parent_typestringYesAlways group_light.
data.obj.namestringYesName
data.obj.scene_typeintegerYes1 for a color scene; 2 for an image scene.
data.obj.is_activeintegerYes1 if active; otherwise 0.
data.obj.picture_idstringYesImage. Used for image scenes.
data.obj.picture_typestringYesAlways file.
data.obj.picture_urlstringYesImage URL
data.obj.iconstringYesFor BweeApp use only.
data.obj.backgroundstringYesFor BweeApp use only.
data.obj.sequenceintegerYesFor BweeApp use only.
data.obj.colorsinteger[]YesFor BweeApp use only.