Smart Scene

API to manage smart scenes

List smart scenes

get

List all available smart scenes

Authorizations

hue-application-keystringRequired

Responses

200

Smart Scene Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/smart_scene

GET /clip/v2/resource/smart_scene HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "smart_scene",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "metadata": {
        "name": "text",
        "appdata": "text",
        "image": {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      },
      "group": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "week_timeslots": [
        {
          "timeslots": [
            {
              "start_time": {
                "kind": "time",
                "time": {
                  "hour": 1,
                  "minute": 1,
                  "second": 1
                }
              },
              "target": {
                "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
                "rtype": "device"
              }
            }
          ],
          "recurrence": [
            "monday"
          ]
        }
      ],
      "transition_duration": 1,
      "active_timeslot": {
        "timeslot_id": 1,
        "weekday": "monday"
      },
      "state": "active"
    }
  ]
}

Create a new smart scene

post

Creates a new smart scene

Authorizations

hue-application-keystringRequired

Body

typestring · enumOptionalPossible values:

transition_durationintegerOptional

duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

post/clip/v2/resource/smart_scene

POST /clip/v2/resource/smart_scene HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 468

{
  "type": "smart_scene",
  "metadata": {
    "name": "text",
    "appdata": "text",
    "image": {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  },
  "group": {
    "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
    "rtype": "device"
  },
  "week_timeslots": [
    {
      "timeslots": [
        {
          "start_time": {
            "kind": "time",
            "time": {
              "hour": 1,
              "minute": 1,
              "second": 1
            }
          },
          "target": {
            "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
            "rtype": "device"
          }
        }
      ],
      "recurrence": [
        "monday"
      ]
    }
  ],
  "transition_duration": 1,
  "recall": {
    "action": "activate"
  }
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get a smart scene

get

Get details of a single smart scene from its given {sceneId}

Authorizations

hue-application-keystringRequired

Path parameters

sceneIdstringRequired

ID of the smart scene.

Responses

200

Smart Scene Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/smart_scene/{sceneId}

GET /clip/v2/resource/smart_scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "smart_scene",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "metadata": {
        "name": "text",
        "appdata": "text",
        "image": {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      },
      "group": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "week_timeslots": [
        {
          "timeslots": [
            {
              "start_time": {
                "kind": "time",
                "time": {
                  "hour": 1,
                  "minute": 1,
                  "second": 1
                }
              },
              "target": {
                "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
                "rtype": "device"
              }
            }
          ],
          "recurrence": [
            "monday"
          ]
        }
      ],
      "transition_duration": 1,
      "active_timeslot": {
        "timeslot_id": 1,
        "weekday": "monday"
      },
      "state": "active"
    }
  ]
}

Update a smart scene

put

Update a single smart scene from its given {sceneId}

Authorizations

hue-application-keystringRequired

Path parameters

sceneIdstringRequired

ID of the scene.

Body

typestring · enumOptionalPossible values:

transition_durationintegerOptional

duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put/clip/v2/resource/smart_scene/{sceneId}

PUT /clip/v2/resource/smart_scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "type": "smart_scene",
  "metadata": {
    "name": "text",
    "appdata": "text"
  },
  "week_timeslots": [
    {
      "timeslots": [
        {
          "start_time": {
            "kind": "time",
            "time": {
              "hour": 1,
              "minute": 1,
              "second": 1
            }
          },
          "target": {
            "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
            "rtype": "device"
          }
        }
      ],
      "recurrence": [
        "monday"
      ]
    }
  ],
  "transition_duration": 1,
  "recall": {
    "action": "activate"
  }
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Delete a smart scene

delete

Delete a single smart scene from its given {sceneId}

Authorizations

hue-application-keystringRequired

Path parameters

sceneIdstringRequired

ID of the smart scene.

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

delete/clip/v2/resource/smart_scene/{sceneId}

DELETE /clip/v2/resource/smart_scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

PreviousScene NextRoom

Last updated 4 months ago

Was this helpful?