UNunqork
Revisions

Get Workflow Submission Revisions

Changed on

Gets all revisions for a submission. The data field is left empty.

Authorization Required:

  • See Submission Access (Submission Access)
get/workflows/{workflowId}/submissions/{submissionId}/revisions

Request

Path parameters

workflowIdstring required

Unique workflow ID

submissionIdstring required

ID of workflow submission to retrieve revisions for

Query parameters

limitinteger

Maximum number of results to return (default 50, maximum 50)

offsetinteger

Number of results to skip before selecting results. Offset is zero based.

sortBystring

Field to sort by (currently supported - "created", "modified")

sortOrder1 | -1

Order of sort, if sortBy is specified. One of [1 (ascending),-1 (descending)]

metadataFilterstring

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

Response

Revisions

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

Changes