latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Submissions

Create Module Submission(s)

Creates one or more new module submission. Submission ID is auto-generated and returned. Module submission data must be provided as a JSON object. In case of multiple submissions, Request Body must contain an Array of below defined request body structure. Max Limit per request is 50.

Authorization Required:

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

Path parameters

moduleIdstring required

Unique module ID

Query parameters

transformNamestring

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

Request body

userIdstring

Submission owner

dataobject required

Raw input data

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.

Response

Submission created

idstring required
userIdstring

Submission owner

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