User Tools

Action disabled: source

Back to JESS API

Get IDD Types Index


Use GET /idd/alt/<version> to retrieve the list of types in the specified version of IDD


Synopsis

Return object

A successful /idd/alt/<version> transaction returns a tree object, in an alternative layout compared to the default, containing all the types defined in the IDD file of the selected version. An abbreviated example is shown below.


{
    "state": {
        "disabled": false,
        "opened": true,
        "selected": false
    },
    "id": "_root",
    "li_attr": null,
    "a_attr": null,
    "type": "IDDRoot",
    "text": "IDD v9.3.0",
    "data": null,
    "children": [
        {
            "type": "Tag1",
            "text": "Simulation",
            "data": [
                "Simulation Parameters",
                "Output Reporting"
            ],
            "children": [
                {
                    "state": null,
                    "id": "simulation_parameters",
                    "li_attr": null,
                    "a_attr": null,
                    "type": "Group",
                    "text": "Simulation Parameters",
                    "data": null,
                    "children": [
                        {
                            "state": null,
                            "id": "version",
                            "li_attr": null,
                            "a_attr": null,
                            "type": "ObjectType",
                            "text": "Version",
                            "data": null,
                            "children": []
                        },
                        ...
                    ]
                },
                ...
            ]
        },
        ...
    ]
}

Example using curl://

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

curl https://api.ensims.com/jess_web/api/idd/alt/9.3

On success, the IDD types tree will be returned in a JSON object. If the requested version does not exist, 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/alt/8.9')

# Show returned object  
r.json()


Site Tools