AireForms Data Extracts

This page shows the possible options when extracting data from the AireForms data source.

Form instances

Use this data extract to get the list of forms that have been created against a subject.

{
    "type": "form-instances",
    "includeWithdrawn": false,
    "authorFilter": { "type": ["subject", "none"] }
}

Where:

• includeWithdrawn (Optional) - If true, withdrawn forms will be included in the list. Default value is false.
• authorFilter (Optional) - Filter the list of forms by the author. Subject only returns forms that were created by the subject themselves (currently persisted single pass forms). Default value is none.

Form data

Form data can be extracted at the building block level or the form level.

Building block level:

This will pull the data from all the controls within a building block. By using the building block extract, it will pull data from all form submissions that use the specified building block

{
    "key": "news2",
    "type": "building-block",
    "version": 1
}

To extract a control's display value instead of it's underlying value. You need to specify the controlId and the valueType [value/displayValue]

"dataPoints": [
    {
        "controlId": "my-control",
        "valueType": "displayValue"
    }
]

Form level

This will pull the data from all controls within a form.

{
    "type":"form",
    "key":"fluid-balance",
    "version":1
}

To extract a control's display value instead of it's underlying value you need to specify the building block for the control as well:

"dataPoints": [
    {
        "controlId": "my-control",
        "valueType": "displayValue",
        "buildingBlock": {
            "key": "my-building-block",
            "version": 1
        }
    }
]