Submissions

Exporting Root Data to Plain CSV via POST

Changed on

(introduced: version 1.1)

This endpoint is useful only for Forms under Project Managed Encryption.

As with GET to .csv just above, this endpoint will only return CSV text data, rather than a ZIP file containing ore or more files. Please see that endpoint for further explanation.

As with POST to .csv.zip it allows secure submission of decryption passkeys. Please see that endpoint for more information on how to do this.

post/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 via POST removed and replaced with exportRootDataToPlainCsvViaPost

  • b11b54eea487Revision changes
    • info

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

    • info

      removed the non-success response with the status