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

Download Open API Spec

POST /evaluation/submission

Creates a Submission and sends a submission notification email to the submitter's team members. The passed request body should contain the following fields:

  • evaluationId - The ID of the Evaluation to which this Submission belongs.
  • entityId - The ID of the Entity being submitted.
  • versionNumber - The specific version of the Entity being submitted.

A Submission must be either a Team or an Individual submission. A Team submission must include a Team ID in the teamId field and the request must include a submissionEligibilityHash request parameter. A Team submission may also include a list of submission contributors. (The submitter is taken to be a contributor and need not be included in the list.) An individual submission must have a null teamId, a null or empty contributor list, and no submissionEligibilityHash parameter.

Note: The caller must be granted the ACCESS_TYPE.SUBMIT.

This call also creates an associated SubmissionStatus, initialized with a SubmissionStatusEnum value of RECEIVED.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/evaluation/submission

Parameters
etag

optional

The current eTag of the Entity being submitted
submissionEligibilityHash

optional

The hash provided by the TeamSubmissionEligibility object.
challengeEndpoint

optional

The portal endpoint prefix to the an entity/challenge page. The entity ID of the challenge project is appended to create the complete URL. In normal operation, this parameter should be omitted.
notificationUnsubscribeEndpoint

optional

The portal endpoint prefix for one-click email unsubscription. A signed, serialized token is appended to create the complete URL: NotificationSettingsSignedToken. In normal operation, this parameter should be omitted.
Resource Information
Authentication Required
Required OAuth Scopes view , modify
HTTP Method POST
Request Object Submission
(application/json)
Response Object Submission
(application/json)