User Tools


Back to JESS API

Get IDD Type Definition


Use GET /idd/<version>/<type> to retrieve the definition of the specified type in the given version of IDD


Synopsis

Return object

A successful /idd/<version>/<type> transaction returns an object containing the definition of the selected type defined in the IDD file of the selected version. An example is shown below.

{
    "data": {
        "fields": [
            {
                "id": "A1",
                "required": true,
                "defs": {
                    "field": [
                        "Name"
                    ],
                    "required-field": [
                        ""
                    ],
                    "note": [
                        "Enter a unique name for this object."
                    ]
                }
            },
            {
                "id": "A2",
                "required": false,
                "defs": {
                    "field": [
                        "AirflowNetwork Control"
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "MultizoneWithDistribution",
                        "MultizoneWithoutDistribution",
                        "MultizoneWithDistributionOnlyDuringFanOperation",
                        "NoMultizoneOrDistribution"
                    ],
                    "default": [
                        "NoMultizoneOrDistribution"
                    ],
                    "note": [
                        "NoMultizoneOrDistribution: Only perform Simple calculations (objects ZoneInfiltration:*,",
                        "ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing,",
                        "ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower);",
                        "MultizoneWithoutDistribution: Use AirflowNetwork objects to simulate multizone",
                        "Airflows driven by wind during simulation time,",
                        "and objects of ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing",
                        "ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube,",
                        "ZoneThermalChimney, and ZoneCoolTower:Shower are ignored;",
                        "MultizoneWithDistributionOnlyDuringFanOperation: Perform distribution system",
                        "calculations during system fan on time",
                        "and Simple calculations during system Fan off time;",
                        "MultizoneWithDistribution: Perform distribution system calculations during system",
                        "fan on time and multizone Airflow driven by wind during system fan off time."
                    ]
                }
            },
            {
                "id": "A3",
                "required": false,
                "defs": {
                    "field": [
                        "Wind Pressure Coefficient Type"
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "Input",
                        "SurfaceAverageCalculation"
                    ],
                    "default": [
                        "SurfaceAverageCalculation"
                    ],
                    "note": [
                        "Input: User must enter AirflowNetwork:MultiZone:WindPressureCoefficientArray,",
                        "AirflowNetwork:MultiZone:ExternalNode, and",
                        "AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.",
                        "SurfaceAverageCalculation: used only for rectangular buildings.",
                        "If SurfaceAverageCalculation is selected,",
                        "AirflowNetwork:MultiZone:WindPressureCoefficientArray, AirflowNetwork:MultiZone:ExternalNode,",
                        "and AirflowNetwork:MultiZone:WindPressureCoefficientValues objects are not used."
                    ]
                }
            },
            {
                "id": "A4",
                "required": false,
                "defs": {
                    "field": [
                        "Height Selection for Local Wind Pressure Calculation"
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "ExternalNode",
                        "OpeningHeight"
                    ],
                    "default": [
                        "OpeningHeight"
                    ],
                    "note": [
                        "If ExternalNode is selected, the height given in the",
                        "AirflowNetwork:MultiZone:ExternalNode object will be used.",
                        "If OpeningHeight is selected, the surface opening height (centroid) will be used to",
                        "calculate local wind pressure",
                        "This field is ignored when the choice of the Wind Pressure Coefficient Type field is",
                        "SurfaceAverageCalculation."
                    ]
                }
            },
            {
                "id": "A5",
                "required": false,
                "defs": {
                    "field": [
                        "Building Type"
                    ],
                    "note": [
                        "Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation,",
                        "otherwise this field may be left blank."
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "LowRise",
                        "HighRise"
                    ],
                    "default": [
                        "LowRise"
                    ]
                }
            },
            {
                "id": "N1",
                "required": false,
                "defs": {
                    "field": [
                        "Maximum Number of Iterations"
                    ],
                    "type": [
                        "integer"
                    ],
                    "units": [
                        "dimensionless"
                    ],
                    "default": [
                        "500"
                    ],
                    "minimum>": [
                        "10"
                    ],
                    "maximum": [
                        "30000"
                    ],
                    "note": [
                        "Determines the maximum number of iterations used to converge on a solution. If this limit",
                        "is exceeded, the program terminates."
                    ]
                }
            },
            {
                "id": "A6",
                "required": false,
                "defs": {
                    "field": [
                        "Initialization Type"
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "LinearInitializationMethod",
                        "ZeroNodePressures"
                    ],
                    "default": [
                        "ZeroNodePressures"
                    ]
                }
            },
            {
                "id": "N2",
                "required": false,
                "defs": {
                    "field": [
                        "Relative Airflow Convergence Tolerance"
                    ],
                    "type": [
                        "real"
                    ],
                    "units": [
                        "dimensionless"
                    ],
                    "default": [
                        "1.E-4"
                    ],
                    "minimum>": [
                        "0"
                    ],
                    "note": [
                        "This tolerance is defined as the absolute value of the sum of the mass Flow Rates",
                        "divided by the sum of the absolute value of the mass Flow Rates. The mass Flow Rates",
                        "described here refer to the mass Flow Rates at all Nodes in the AirflowNetwork model.",
                        "The solution converges when both this tolerance and the tolerance in the next field",
                        "(Absolute Airflow Convergence Tolerance) are satisfied."
                    ]
                }
            },
            {
                "id": "N3",
                "required": false,
                "defs": {
                    "field": [
                        "Absolute Airflow Convergence Tolerance"
                    ],
                    "type": [
                        "real"
                    ],
                    "units": [
                        "kg/s"
                    ],
                    "default": [
                        "1.E-6"
                    ],
                    "minimum>": [
                        "0"
                    ],
                    "note": [
                        "This tolerance is defined as the absolute value of the sum of the mass flow rates. The mass",
                        "flow rates described here refer to the mass flow rates at all nodes in the AirflowNetwork",
                        "model. The solution converges when both this tolerance and the tolerance in the previous",
                        "field (Relative Airflow Convergence Tolerance) are satisfied."
                    ]
                }
            },
            {
                "id": "N4",
                "required": false,
                "defs": {
                    "field": [
                        "Convergence Acceleration Limit"
                    ],
                    "type": [
                        "real"
                    ],
                    "units": [
                        "dimensionless"
                    ],
                    "note": [
                        "Used only for AirflowNetwork:SimulationControl"
                    ],
                    "minimum": [
                        "-1"
                    ],
                    "maximum": [
                        "1"
                    ],
                    "default": [
                        "-0.5"
                    ]
                }
            },
            {
                "id": "N5",
                "required": false,
                "defs": {
                    "field": [
                        "Azimuth Angle of Long Axis of Building"
                    ],
                    "type": [
                        "real"
                    ],
                    "units": [
                        "deg"
                    ],
                    "minimum": [
                        "0.0"
                    ],
                    "maximum": [
                        "180.0"
                    ],
                    "default": [
                        "0.0"
                    ],
                    "note": [
                        "Degrees clockwise from true North.",
                        "Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation."
                    ]
                }
            },
            {
                "id": "N6",
                "required": false,
                "defs": {
                    "field": [
                        "Ratio of Building Width Along Short Axis to Width Along Long Axis"
                    ],
                    "type": [
                        "real"
                    ],
                    "minimum>": [
                        "0.0"
                    ],
                    "maximum": [
                        "1.0"
                    ],
                    "default": [
                        "1.0"
                    ],
                    "note": [
                        "Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation."
                    ]
                }
            },
            {
                "id": "A7",
                "required": false,
                "defs": {
                    "field": [
                        "Height Dependence of External Node Temperature"
                    ],
                    "note": [
                        "If Yes, external node temperature is height dependent.",
                        "If No, external node temperature is based on zero height."
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "Yes",
                        "No"
                    ],
                    "default": [
                        "No"
                    ]
                }
            },
            {
                "id": "A8",
                "required": false,
                "defs": {
                    "field": [
                        "Solver"
                    ],
                    "note": [
                        "Select the solver to use for the pressure network solution"
                    ],
                    "type": [
                        "choice"
                    ],
                    "key": [
                        "SkylineLU",
                        "ConjugateGradient"
                    ],
                    "default": [
                        "SkylineLU"
                    ]
                }
            }
        ],
        "required": false,
        "unique": true,
        "defs": {
            "min-fields": [
                "12"
            ],
            "unique-object": [
                ""
            ],
            "memo": [
                "This object defines the global parameters used in an Airflow Network simulation."
            ]
        }
    },
    "html": "<div class='panel panel-default'><div class='panel-heading'><h3>AirflowNetwork:SimulationControl <sup><span class='label label-primary'>Unique</span></sup> </h3><a target='_blank' href='https://bigladdersoftware.com/epx/docs/8-9/input-output-reference/group-airflow-network.html#airflownetworksimulationcontrol' title='https://bigladdersoftware.com/epx/docs/8-9/input-output-reference/group-airflow-network.html#airflownetworksimulationcontrol'>View EnergyPlus Reference <span class='glyphicon glyphicon-globe'></span></a></div><div class='panel-body'><ul><li><b>min-fields</b> : 12 </li><li><b>unique-object</b></li><li><b>memo</b> : This object defines the global parameters used in an Airflow Network simulation. </li></ul></div><table class='table table-striped table-hover'><tr><th>ID</th><th>Field</th><th>Property</th><th>Information</th></tr><tr><td rowspan='2'><b>A1</b></td><td rowspan='2'>Name</td><td><i>note</i></td><td>Enter a unique name for this object.<br></td></tr><tr><td><i>required-field</i></td><td><br></td></tr><tr><td rowspan='4'>A2</td><td rowspan='4'>AirflowNetwork Control</td><td><i>note</i></td><td>NoMultizoneOrDistribution: Only perform Simple calculations (objects ZoneInfiltration:*,<br>ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing,<br>ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower);<br>MultizoneWithoutDistribution: Use AirflowNetwork objects to simulate multizone<br>Airflows driven by wind during simulation time,<br>and objects of ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing<br>ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube,<br>ZoneThermalChimney, and ZoneCoolTower:Shower are ignored;<br>MultizoneWithDistributionOnlyDuringFanOperation: Perform distribution system<br>calculations during system fan on time<br>and Simple calculations during system Fan off time;<br>MultizoneWithDistribution: Perform distribution system calculations during system<br>fan on time and multizone Airflow driven by wind during system fan off time.<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>MultizoneWithDistribution<br>MultizoneWithoutDistribution<br>MultizoneWithDistributionOnlyDuringFanOperation<br>NoMultizoneOrDistribution<br></td></tr><tr><td><i>default</i></td><td><b>NoMultizoneOrDistribution</b><br></td></tr><tr><td rowspan='4'>A3</td><td rowspan='4'>Wind Pressure Coefficient Type</td><td><i>note</i></td><td>Input: User must enter AirflowNetwork:MultiZone:WindPressureCoefficientArray,<br>AirflowNetwork:MultiZone:ExternalNode, and<br>AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.<br>SurfaceAverageCalculation: used only for rectangular buildings.<br>If SurfaceAverageCalculation is selected,<br>AirflowNetwork:MultiZone:WindPressureCoefficientArray, AirflowNetwork:MultiZone:ExternalNode,<br>and AirflowNetwork:MultiZone:WindPressureCoefficientValues objects are not used.<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>Input<br>SurfaceAverageCalculation<br></td></tr><tr><td><i>default</i></td><td><b>SurfaceAverageCalculation</b><br></td></tr><tr><td rowspan='4'>A4</td><td rowspan='4'>Height Selection for Local Wind Pressure Calculation</td><td><i>note</i></td><td>If ExternalNode is selected, the height given in the<br>AirflowNetwork:MultiZone:ExternalNode object will be used.<br>If OpeningHeight is selected, the surface opening height (centroid) will be used to<br>calculate local wind pressure<br>This field is ignored when the choice of the Wind Pressure Coefficient Type field is<br>SurfaceAverageCalculation.<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>ExternalNode<br>OpeningHeight<br></td></tr><tr><td><i>default</i></td><td><b>OpeningHeight</b><br></td></tr><tr><td rowspan='4'>A5</td><td rowspan='4'>Building Type</td><td><i>note</i></td><td>Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation,<br>otherwise this field may be left blank.<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>LowRise<br>HighRise<br></td></tr><tr><td><i>default</i></td><td><b>LowRise</b><br></td></tr><tr><td rowspan='6'>N1</td><td rowspan='6'>Maximum Number of Iterations</td><td><i>note</i></td><td>Determines the maximum number of iterations used to converge on a solution. If this limit<br>is exceeded, the program terminates.<br></td></tr><tr><td><i>type</i></td><td>integer<br></td></tr><tr><td><i>units</i></td><td>dimensionless<br></td></tr><tr><td><i>default</i></td><td><b>500</b><br></td></tr><tr><td><i>minimum></i></td><td>10<br></td></tr><tr><td><i>maximum</i></td><td>30000<br></td></tr><tr><td rowspan='4'>A6</td><td rowspan='4'>Initialization Type</td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>LinearInitializationMethod<br>ZeroNodePressures<br></td></tr><tr><td><i>default</i></td><td><b>ZeroNodePressures</b><br></td></tr><tr><td rowspan='5'>N2</td><td rowspan='5'>Relative Airflow Convergence Tolerance</td><td><i>note</i></td><td>This tolerance is defined as the absolute value of the sum of the mass Flow Rates<br>divided by the sum of the absolute value of the mass Flow Rates. The mass Flow Rates<br>described here refer to the mass Flow Rates at all Nodes in the AirflowNetwork model.<br>The solution converges when both this tolerance and the tolerance in the next field<br>(Absolute Airflow Convergence Tolerance) are satisfied.<br></td></tr><tr><td><i>type</i></td><td>real<br></td></tr><tr><td><i>units</i></td><td>dimensionless<br></td></tr><tr><td><i>default</i></td><td><b>1.E-4</b><br></td></tr><tr><td><i>minimum></i></td><td>0<br></td></tr><tr><td rowspan='5'>N3</td><td rowspan='5'>Absolute Airflow Convergence Tolerance</td><td><i>note</i></td><td>This tolerance is defined as the absolute value of the sum of the mass flow rates. The mass<br>flow rates described here refer to the mass flow rates at all nodes in the AirflowNetwork<br>model. The solution converges when both this tolerance and the tolerance in the previous<br>field (Relative Airflow Convergence Tolerance) are satisfied.<br></td></tr><tr><td><i>type</i></td><td>real<br></td></tr><tr><td><i>units</i></td><td>kg/s<br></td></tr><tr><td><i>default</i></td><td><b>1.E-6</b><br></td></tr><tr><td><i>minimum></i></td><td>0<br></td></tr><tr><td rowspan='6'>N4</td><td rowspan='6'>Convergence Acceleration Limit</td><td><i>note</i></td><td>Used only for AirflowNetwork:SimulationControl<br></td></tr><tr><td><i>type</i></td><td>real<br></td></tr><tr><td><i>units</i></td><td>dimensionless<br></td></tr><tr><td><i>minimum</i></td><td>-1<br></td></tr><tr><td><i>maximum</i></td><td>1<br></td></tr><tr><td><i>default</i></td><td><b>-0.5</b><br></td></tr><tr><td rowspan='6'>N5</td><td rowspan='6'>Azimuth Angle of Long Axis of Building</td><td><i>note</i></td><td>Degrees clockwise from true North.<br>Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.<br></td></tr><tr><td><i>type</i></td><td>real<br></td></tr><tr><td><i>units</i></td><td>deg<br></td></tr><tr><td><i>minimum</i></td><td>0.0<br></td></tr><tr><td><i>maximum</i></td><td>180.0<br></td></tr><tr><td><i>default</i></td><td><b>0.0</b><br></td></tr><tr><td rowspan='5'>N6</td><td rowspan='5'>Ratio of Building Width Along Short Axis to Width Along Long Axis</td><td><i>note</i></td><td>Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.<br></td></tr><tr><td><i>type</i></td><td>real<br></td></tr><tr><td><i>minimum></i></td><td>0.0<br></td></tr><tr><td><i>maximum</i></td><td>1.0<br></td></tr><tr><td><i>default</i></td><td><b>1.0</b><br></td></tr><tr><td rowspan='4'>A7</td><td rowspan='4'>Height Dependence of External Node Temperature</td><td><i>note</i></td><td>If Yes, external node temperature is height dependent.<br>If No, external node temperature is based on zero height.<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>Yes<br>No<br></td></tr><tr><td><i>default</i></td><td><b>No</b><br></td></tr><tr><td rowspan='4'>A8</td><td rowspan='4'>Solver</td><td><i>note</i></td><td>Select the solver to use for the pressure network solution<br></td></tr><tr><td><i>type</i></td><td>choice<br></td></tr><tr><td><i>key</i></td><td>SkylineLU<br>ConjugateGradient<br></td></tr><tr><td><i>default</i></td><td><b>SkylineLU</b><br></td></tr></table></div>"
}

Example using curl://

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

curl https://api.ensims.com/jess_web/api/idd/9.3/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/AirflowNetwork:SimulationControl')

# Show returned object  
r.json()


Site Tools