...
| URI | Method | Request Parameters | Request Body | Response Body | Authorization | Notes |
|---|---|---|---|---|---|---|
| /challenge | POST | -- | Challenge | Challenge | CREATE permission required in referenced project. | |
| /entity/{projectId}/challenge | GET | -- | -- | Challenge | READ permission required in project. | |
| /challenge/{challengeId} | GET | -- | -- | Challenge | READ permission required in project. | |
| /challenge | GET | participantId, limit, offset | -- | ChallengePagedResults | PUBLIC, but to be in the returned list the caller must have READ permission on the project 'owning' the Challenge. | returns the projects/challenges for which 'participantId' is registered. |
| /challenge/{challengeId} | PUT | -- | Challenge | -- | UPDATE permission required in referenced project. | |
| /challenge/{challengeId} | DELETE | -- | -- | -- | DELETE permission required in referenced project. | |
| /challenge/{challengeId}/participant | GET | limit, offset, affiliated | PaginatedIds | READ permission required in project. | Return challenge participants. If affiliated=true, return just participants affiliated with some registered Team. If false, return those affiliated with no Team. If missing return all participants. | |
| /challenge/{challengeId}/challengeTeam | POST | -- | ChallengeTeam | ChallengeTeam | Must be a member of the Participant Team and be an admin on the referenced Challenge Team. | |
| /challenge/{challengeId}/challengeTeam/{challTeamId} | GET | -- | -- | ChallengeTeam | Must have READ permission in the Challenge Project. | We defer implementation of this since there is no immediate use case. |
| /challenge/{challengeId}/challengeTeam | GET | limit, offset | -- | ChallengeTeamPagedResults | Must have READ permission in the Challenge Project. | |
| /challenge/{challengeId}/registratableTeam | GET | limit, offset | -- | PaginatedIds | Must have READ permission in the Challenge Project. | Returns the Teams which are NOT registered for the challenge and on which is current user is an ADMIN. |
| /challenge/{challengeId}/challengeTeam/{challTeamId} | PUT | -- | ChallengeTeam | ChallengeTeam | Must be a member of the Participant Team and be an admin on the referenced Challenge Team. | |
| /challengeTeam/{challTeamId} | DELETE | -- | -- | -- | Must be an admin on the referenced Challenge Team. | |
| /teamList | POST | IdSet | ListWrapper<Team> | PUBLIC | Returns a list of Teams for a given list of Team IDs. | |
/team/{id}/memberList | POST | IdSet | ListWrapper<TeamMember> | PUBLIC | Returns the Team Membership info for a given list of memberIds. | |
| /user/{id}/memberList | POST | IdSet | ListWrapper<TeamMember> | PUBLIC | Returns the user's Membership info for a given list of Teams. | |
| /challenge/{challengeId}/submissionTeams | GET | principalId, limit, offset | -- | PaginatedIds | Must be the user specified by 'principalId' or be a Synapse Admin | Returns a list of Teams either on whose behalf the user is eligible to submit, i.e. the Teams registered for the challenge and in which the user is a member. |
| /evaluation/submission | POST | etag, submissionEligibilityHash | Submission | Submission | Must have SUBMIT permission in the Evaluation referenced in the Submission. | If 'contributer' list is not empty then teamId is required and Submission is rejected if submitter or any specified contributers is not on the given team. If submissionEligibilityHash is included then teamId must also be included and submission will be rejected if computed TeamSubmissionEligibility does not match hash. Notifications sent to all contributers except for submitter. |
| /evaluation/submission/{submissionId}/contributor/{principalId} | POST | -- | -- | Administrative Service | Adds the given user as a contributor to the Submission. | |
| /evaluation/submission/{submissionId}/optOut | PUT | userId | -- | -- | userId must be the one making the request (or be a Synapse Administrator) | Sets 'optOut' field for given userId in the Submission. userId must be a contributer in the Submission (not the submitter himself) and Submission must not be in one of the Evaluation's 'optOutDisallowed' states. |
| /evaluation/{evaluationId}/team/{id}/submissionEligibility | GET | -- | -- | TeamSubmissionEligibility | user making the request must have SUBMIT permission in the Evaluation and must be a member of the specified Team. |