Simulations
Energy Asset - Simulations

Simulations relating to building simulation runs.

Supported Formats

json
>>>

GET /api/v2/buildings/:building_id/simulations(:.format)
Retrieve all simulation runs belonging to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity - The form data contains errors.

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
>>>

GET /api/v2/buildings/:building_id/simulations/:id(:.format)
Retrieve one simulation run that belongs to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity - The form data contains errors.

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
>>>

POST /api/v2/buildings/:building_id/simulations(:.format)
Enqueue one simulation run that belongs to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
recommendation_ids
optional

The unique IDs for the recommendations to be applied to the building.

Validations:

  • Must be an array of String