The Open API specification for Synapse is now available for download!

Download Open API Spec

SubmissionStatus

org.sagebionetworks.evaluation.model.SubmissionStatus

A SubmissionStatus is a secondary, mutable object associated with a Submission. This object should be used to contain scoring data about the Submission.

Field Type Description
id STRING The unique, immutable Synapse ID of the Submission.
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. The eTag changes every time an SubmissionStatus is updated; it is used to detect when a client's copy of an SubmissionStatus is out-of-date.
modifiedOn STRING The date on which this SubmissionStatus was last modified.
status SubmissionStatusEnum The possible states of a Synapse Submission.
score NUMBER This field is deprecated and should not be used. Use the 'submissionAnnotations' field instead.
report STRING This field is deprecated and should not be used. Use the 'submissionAnnotations' field instead.
annotations Annotations Primary container object for Annotations on a Synapse object
submissionAnnotations Annotations Annotations are additional key-value pair metadata that are associated with an object.
entityId STRING The Synapse ID of the Entity in this Submission.
versionNumber INTEGER The version number of the Entity in this Submission.
statusVersion INTEGER A version of the status, auto-generated and auto-incremented by the system and read-only to the client.
canCancel BOOLEAN Can this submission be cancelled? By default, this will be set to False. Users can read this value. Only the queue's scoring application can change this value.
cancelRequested BOOLEAN Has user requested to cancel this submission? By default, this will be set to False. Submission owner can read and request to change this value.