latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Submissions

Get Module Submission

Gets a single module submission. Module submission data is transformed and returned is a specific format, based on the specified transform. JSON submission data is returned as an object, XML data is returned as a string, and PDF data is returned as a Cloud Storage Delivery URL to the rendered PDF (and optionally base 64 data).

Authorization Required:

  • See Submission Access (Submission Access)
get/modules/{moduleId}/submissions/{submissionId}

Path parameters

moduleIdstring required

Unique module ID

submissionIdstring required

ID of module submission to retrieve

Query parameters

transformNamestring

Transform to apply to module for output. Transform must be configured and designated for for output. Available transforms may be listed via the /transforms endpoint

includeRawboolean

Whether to include the untransformed raw submission data in addition to the transformed data. Raw submission data may contain Cloud Storage Delivery URLs.

includeBase64boolean

Whether to include base64 PDF data in addition to the PDF url (for "njk-pdf" transforms)

resolveCloudStorageUrlsboolean

When transformName is specified, Cloud Storage URLs are already resolved to the original base64 value. When this flag is specified, resolve Cloud Storage URLs to base64 data inside "rawData", as well.

dataFieldsstring

Comma-separated list of dot-notation data fields to retrieve; for example, &dataFields=field1,also.field2 will retrieve {"data":{"field1":"v1","also":{"field2":"v2"}}}. Do not include "data" in front of each field. All other submission fields will always be retrieved.

Response

Submission

idstring required
userIdstring

Submission owner

moduleIdstring required
createdstring date-time required
modifiedstring date-time required
deletedstring date-time
metadataobject