NOTE: The Competition services are still under development and are not yet available on Synapse.
...
| URL | HTTP Type | Description | Request Parameters |
|---|---|---|---|
| /competition/submission | POST | Create a new Submission. (and corresponding SubmissionStatus object) | userId (String) |
| /competition/submission/{submissionId} | GET | Get a Submission | |
| /competition/submission/{submissionId}/status | GET | Get the status of a Submission | |
| /competition/submission/{submissionId}/status | PUT | Update the status of a Submission. | userId (String) |
| /competition/submission/{submissionId} | DELETE | Delete a Submission. Requires admin rights on the Competition. | userId (String) |
| /competition/{compId}/submission | GET | Batch get Submissions for a given Competition (Paginated). | userId (String) SubmissionStatusEnum (String) (optional) |
| /competition/{compId}/submission/count | GET | Get the number of Submissions for a given Competition |
...
- Create a Synapse Competition
- Fill in details, attach relevant Synapse entities
- Specify access requirements
- Specify open/close dates
- Listen for Submissions (using messaging service)
- Download unscored Submissions
- Perform scoring
- Push scores back to each SubmissionStatus
- Track user participation and publish competition status/leaderboard
- Award achievements for user participation / success
Planned
...
Improvements
The following Competition Services features are planned but not yet implemented.
- Banned user lists
Banned users should be prohibited from participating in one or more Competitions, and any Submissions by a banned user should be isolated from the general populations of Submissions.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1646 - Customizable Amazon Simple Notification Services messaging tools
Competition administrators should have tools to configure a selective Amazon instance to listen for messages pertaining to Competitions which they own. These messages should be sent to a queue dedicated to Competitions.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1647 - Immutable copies of the submitted Entities
Once an Entity is submitted to a Competition, a static copy of that Entity should become the property of the Competition administration.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1648 - Administrator lists for Competitions
Competitions should support administration by multiple users (rather than just the Competition owner). These admin lists should function as a lightweight ACL of sorts.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1649 - Multi-author Submissions
Competitions should support team Submissions, where more than one Synapse user claims authorship of a given Submission.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1650 - Pagination support for fetching Participants and Submissions
Currently the API supports fetching all Participants or all Submissions for a given Competition. To support high-volume Competitions, pagination shoudl be supported on these requests.Jira Legacy server JIRA (sagebionetworks.jira.com) key PLFM-1651