Sign in
latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Modules

Execute Module

Execute module rules/validations configured in specified module with specified submission data, optionally save data. The response will include the saved submission data that would be available in the specified module.

Authorization Required:

  • Designer Administrator or Express Read
put/modules/{moduleId}/execute

Path parameters

moduleIdstring required

ID of module to use to execute submission

Request body

submissionIdstring

ID of module submission to use. If submissionId is unspecified and save is specified, a new submission will be created with moduleId as the module being executed and userId as the user making the request.

dataobject

Raw data to include in submission data when executing (and saving, if specified).

metadataMetadataRequest

Object containing key-value pairs. To set nested values, this must be an object like {"statuses.complete": "yes", "statuses.processed": "no"}, which is MongoDB dot notation.

validateboolean

Whether or not to validate submission data post-execution.

saveboolean

Whether to save data for the existing submission (or create a new submission) after execution. Data will never be saved when an execution error is encountered.

saveOnValidationErrorboolean

If set to true (and both save and validate are also set to true), will save and send back a 2xx response, even if validation errors occurred.

hydrateDataInitiallyboolean

If set to true, will fully populate data object before module begins execution.

Response

Submission executed

idstring
userIdstring

Submission owner

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