User Tools

Action disabled: source

Back to JESS API

Get IDD Type Reference


Use GET /idd/<version>/doc/<type> to retrieve the URL of the online E+ Input Output Reference of the specified type in the given version of IDD


Synopsis

Return object

A successful /idd/<version>/doc/<type> transaction returns a URL to the online EnergyPlus reference manual of the selected type defined in the IDD file of the selected version. An example is shown below.

https://bigladdersoftware.com/epx/docs/8-9/input-output-reference/group-variable-refrigerant-flow-equipment.html#airconditionervariablerefrigerantflowfluidtemperaturecontrol

Example using curl://

Send the /idd/<version>/doc/<type> command using curl:

curl https://api.ensims.com/jess_web/api/idd/9.3/doc/AirflowNetwork:SimulationControl

On success, the IDD type's definition will be returned in a JSON object. If the requested version does not exist, or the specified type cannot be found, an HTTP 404 Not Found error will be returned.

Example using Python Requests

Make sure Requests is correctly installed in your Python environment, and run the following lines:

import requests

# The IDD data does not require security
r = requests.get('https://api.ensims.com/jess_web/api/idd/8.9/doc/AirflowNetwork:SimulationControl')

# Show returned object  
r.json()


Site Tools