Exporting Form Submissions to CSV
To export all the Submission data associated with a Form, just add .csv.zip to the end of the listing URL. The response will be a ZIP file containing one or more CSV files, as well as all multimedia attachments associated with the included Submissions.
You can exclude the media attachments from the ZIP file by specifying ?attachments=false.
If Project Managed Encryption is being used, additional querystring parameters may be provided in the format {keyId}={passphrase} for any number of keys (eg 1=secret&4=password). This will decrypt any records encrypted under those managed keys. Submissions encrypted under self-supplied keys will not be decrypted. Note: if you are building a browser-based application, please consider the alternative POST endpoint, described in the following section.
If a passphrase is supplied but is incorrect, the entire request will fail. If a passphrase is not supplied but encrypted records exist, only the metadata for those records will be returned, and they will have a status of not decrypted.
If you are running an unsecured (HTTP rather than HTTPS) Central server, it is not a good idea to export data this way as your passphrase and the decrypted data will be sent plaintext over the network.
You can use an OData-style $filter query to filter the submissions that will appear in the ZIP file. This is a bit awkward, since this endpoint has nothing to do with OData, but since we already must recognize the OData syntax, it is less strange overall for now not to invent a whole other one here. Only a subset of the $filter features are available; please see the linked section for more information.
Path parameters
The numeric ID of the Project
The xmlFormId of the Form being referenced.
Query parameters
Set to false to exclude media attachments from the export.
If provided, will filter responses to those matching the given OData query. Only certain fields are available to reference. The operators lt, le, eq, neq, ge, gt, not, and, and or are supported, and the built-in functions now, year, month, day, hour, minute, second.
Set to false to remove group path prefixes from field header names (eg instanceID instead of meta-instanceID). This behavior mimics a similar behavior in ODK Briefcase.
Set to true to restore all fields previously deleted from this form for this export. All known fields and data for those fields will be merged and exported.
Set to true to create a boolean column for every known select multiple option in the export. The option name is in the field header, and a 0 or a 1 will be present in each cell indicating whether that option was checked for that row. This behavior mimics a similar behavior in ODK Briefcase.
Response
OK