Submissions

Exporting Root Data to Plain CSV

Changed on

(introduced: version 1.1)

The above submission endpoints will give you a ZIP file with the submission data in it. This is necessary to provide all the possible related repeat table files, as well as the media files associated with the submissions. But ZIP files can be difficult to work with, and many Forms have no repeats nor media attachments.

To export just the root table (no repeat data nor media files), you can call this endpoint instead, which will directly give you CSV data.

Please see the above endpoint for notes on dealing with Managed Encryption.

get/v1/projects/{projectId}/forms/{xmlFormId}/submissions.csv

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/submissions.csv
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Query parameters

$filterstring

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.

Response

OK

Changes

  • 022694254f0dRevision changes
    • info

      api operation id Exporting Root Data to Plain CSV removed and replaced with exportRootDataToPlainCsv

  • b11b54eea487Revision changes
    • info

      added the media type application/zip for the response with the status

    • info

      removed the non-success response with the status