Services relating to window_layouts of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/window_layouts/:id
Retrieve the window_layout with the specific ID.

Also see Windows.

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Examples

{"id":1,"display_name":"Continuous","sort_order":1,"created_at":"2022-05-16T15:14:14.440Z","updated_at":"2022-05-16T15:14:14.440Z","service_name":"Continuous"}
<?xml version="1.0" encoding="UTF-8"?>
<window-layout>
  <id type="integer">1</id>
  <display-name>Continuous</display-name>
  <sort-order type="integer">1</sort-order>
  <created-at type="dateTime">2022-05-16T15:14:14Z</created-at>
  <updated-at type="dateTime">2022-05-16T15:14:14Z</updated-at>
  <service-name>Continuous</service-name>
</window-layout>

GET /api/v1/window_layouts
Retrieve all window_layouts.

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Examples

[{"id":1,"display_name":"Continuous","sort_order":1,"created_at":"2022-05-16T15:14:14.440Z","updated_at":"2022-05-16T15:14:14.440Z","service_name":"Continuous"},{"id":2,"display_name":"Discrete","sort_order":2,"created_at":"2022-05-16T15:14:14.440Z","updated_at":"2022-05-16T15:14:14.440Z","service_name":"Discrete"}]
<?xml version="1.0" encoding="UTF-8"?>
<window-layouts type="array">
  <window-layout>
    <id type="integer">1</id>
    <display-name>Continuous</display-name>
    <sort-order type="integer">1</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:14Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:14Z</updated-at>
    <service-name>Continuous</service-name>
  </window-layout>
  <window-layout>
    <id type="integer">2</id>
    <display-name>Discrete</display-name>
    <sort-order type="integer">2</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:14Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:14Z</updated-at>
    <service-name>Discrete</service-name>
  </window-layout>
</window-layouts>