| Action | Intended User | URI | Method | Request Params | Request Body | Response Body |
---|
1 | create a ResearchProject | Synapse User | /researchProject | POST |
| ResearchProject | ResearchProject |
2 | retrieve a ResearchProject | creator | /accessRequirement/{id}/researchProject | GET |
|
| ResearchProject |
3 | update a ResearchProject | creator | /researchProject/{id} | PUT |
| ResearchProject | ResearchProject |
4 | transfer ownership of a ResearchProject | creator, ACT | /researchProject/{id}/updateOwner | PUT |
| ChangeOwnershipRequest | ResearchProject |
| create or update Research Project | Synapse User | /researchProject | POST |
| ResearchProject | ResearchProject |
| get ResearchProject for update | creator | /accessRequirement/{id}/researchProjectForUpdate | GET |
|
| ResearchProject |
5 | create a DataAccessRequest | Synapse User | /dataAccessRequest | POST |
| DataAccessRequest | DataAccessRequest |
6 | retrieve the current DataAccessRequest | creator, ResearchProject's owner | /accessRequirement/{id}/dataAccessRequest | GET |
|
| DataAccessRequestInterface |
7 | asking the server for a suitable request object to start with | creator | /accessRequirement/{id}/dataAccessRequestForUpdate | GET |
|
| DataAccessRequestInterface |
8 | update a DataAccessRequest | creator, ResearchProject's owner | /dataAccessRequest/{id} | PUT |
| DataAccessRequestInterface | DataAccessRequestInterface |
| create or update DataAccessRequest | Synapse User | /dataAccessRequest | POST |
| DataAccessRequestInterface | DataAccessRequestInterface |
9 | submit a DataAccessRequest | creator, ResearchProject's owner | /dataAccessSubmission | POST |
| DataAccessRequestInterface | DataAccessSubmissionStatus |
10 | retrieve the latest DataAccessSubmission's status | requestor, ResearchProject's owner, accessors | /accessRequirement/{id}/submissionStatus | GET |
|
| DataAccessSubmissionStatus |
11 | cancel a DataAccessSubmission | requestor, ResearchProject's owner | /dataAccessSubmission/{id}/cancel | PUT |
|
| DataAccessSubmissionStatus
|
12 | update a DataAccessSubmission | ACT | /dataAccessSubmission/{id} | PUT |
| SubmissionStatusChangeRequestSubmissionStateChangeRequest | DataAccessSubmission |
13 | retrieve a list of DataAccessSubmission | ACT | /accessRequirement/{id}/listSubmission | GET | nextPageToken, order, filter (by status) |
| DataAccessSubmissionPage |
14 | retrieve a list of Approval Status for a given list of AccessRequirement | SynapseUser | /accessApproval/status | POST |
| AccessApprovalStatusRequest | AccessApprovalStatusResults |