Appendix D: API
263
Named Scenes (aka Window Layouts)
Named Scenes (or Window Layouts) are collections of Access Client windows
which can saved and restored with all their positions and sizes. With the API,
users can currently get a list of available scenes, and they can restore (or open)
a scene. It is not possible to create new scenes or overwrite existing scenes
currently.
Get a list of scenes
To get a list of scenes, use a GET request to the /access/scenes URL. The API
will return an array of scenes. Each scene has an ID (member "id") and a
"name". One of the scenes may be the active one (the "is_active" member is
true for this scene).
Example
curl -c cookies.txt -b cookies.txt -H "Content-Type: application/json"
https://192.168.3.175:8443/api/v1/access/scenes
{"named_scenes":[{"id":22,"name":"Window Layout
1","is_active":false},{"id":23,"name":"Window Layout 2","is_active":true}]}
Restore a Named Scene
To restore a Named Scene, POST to the /access/open_scene URL. This request
has 2 parameters:
•
scene_id (required): The ID of the scene. To get the ID of a scene, see
above (Get a list of scenes).
•
audit_message (optional): A message for the audit log. Currently used for
CC-SG connections only.
Example
curl -c cookies.txt -b cookies.txt -H "Content-Type: application/json" -d
'{ "scene_id": 23 }' https://192.168.3.175:8443/api/v1/access/open_scene
{"result":true}
Summary of Contents for Raritan Dominion User Station
Page 10: ......
Page 63: ...Appendix A Managing Targets and Access Methods 53 VNC Access Settings...
Page 64: ...Appendix A Managing Targets and Access Methods 54 SSH Access Settings...
Page 65: ...Appendix A Managing Targets and Access Methods 55 WEB Access Settings...
Page 159: ...Appendix A Administration Features 149 5 Enter the bind credentials in the Bind section...
Page 204: ...Appendix A Administration Features 194 9 Click Save...
Page 211: ...Appendix A Maintenance Features 201 6 Click OK in the confirmation dialog...
Page 269: ...Appendix D API 259...
Page 280: ......