112399a67ebb
Get Submissions Across Modules and Workflows
Returns submission objects across all modules and workflows. This is a paged endpoint (see Paging). This endpoint is available to "Administrator" users only.
Authorization Required:
- See Submission Access (Submission Access)
Query parameters
Maximum number of results to return (default 50, maximum 50)
Number of results to skip before selecting results. Offset is zero based.
Field to sort by (currently supported - "created", "modified")
Order of sort, if sortBy is specified. One of [1 (ascending),-1 (descending)]
Whether to include deleted objects in response
Filter condition against submission "metadata" field. Value must be a stringified MongoDB query condition (see Examples, below). MongoDB dot notation is supported for keys.
NOTE: MongoDB selectors that can be nested inside queries (such as Comparison and Element Selectors, e.g. $eq, $in, $exists) are supported. The following Logical Selectors are also supported: $and, $or, $nor
Examples:
-
metadataFilter: {"checkpoints.complete": 1234}
-
metadataFilter: {"checkpoints.complete": {"$exists": true}, "checkpoints.processed": {"$exists": false}}
- Will return submissions where both metadata.checkpoints.complete exists AND metadata.checkpoints.processed does not exist
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
Submissions