latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Revisions

Get Module Submission Revision

Gets a single revision for a submission. Revision data is transformed and returned in a specific format, based on the specified transform. JSON revisions 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}/revisions/{revisionId}

Path parameters

moduleIdstring required

Unique module ID

submissionIdstring required

ID of module submission to retrieve revisions for

revisionIdstring required

ID of the particular submission revision to retrieve. To retrieve all submission revisions, do not include this path parameter

Query parameters

transformNamestring

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

includeRawboolean

Whether to include the untransformed raw submission data in addition to the transformed data. Raw submission data may contain Cloud Storage Delivery URLs. Only available for single revisions

includeBase64boolean

Whether to include base64 PDF data in addition to the PDF url (for "njk-pdf" transforms). Only available for single revisions

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. Only available for single revisions

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

Revision

idstring required

Revision id

createdstring

Date of when the submission was created or modified (might be missing in old submissions)

createdBystring

Creator or modifier of the submission (might be missing in old submissions)

persistedInWormStorageboolean

whether the revision is WORM (Write-Once-Read-Many) compliant. Click here for more information