ListScenes

Updated at:

Lists all scenario interaction rules and their statuses.

Request syntax

GET /2020-04-30/scenes HTTP/1.1
Cookie: Cookie
Important 2020-04-30 is the version number of the edge OpenAPI. This value cannot be changed.

Request parameters

ParameterTypeRequiredDescription
CookieStringYesThe authentication cookie created by calling the CreateAuthCookie operation.

Return syntax

HTTP/1.1 StatusCode
Content-Type: application/json

Payload

Response parameters

ParameterTypeDescription
StatusCodeNumberThe HTTP status code. A status code of 200 indicates success. Other status codes indicate failure. For more information about error codes, see Status codes.
PayloadJSONThe retrieved scenario interaction rules.

The following shows the format of the response payload.

{    
    "Data": { // The returned data if success, otherwise null.
      "Scenes": [{
        "Id": "string",
        "Name": "string",
        "Running": true|false
      }]
    }
  }

Complete example

$ curl -i -b token.cookie -k https://127.0.0.1:9999/2020-04-30/scenes

HTTP/1.1 200 OK
Server: openresty/1.13.6.2
Date: Wed, 15 Apr 2020 08:02:06 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive

{"Data":{"Scenes":[{"Running":true,"Name":"scene_test_types","Id":"d14122632aaf4d1d8e325963****9528"}]}}