| 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 | /dataAccessRequest/{id}/submission | POST | etag |
| ACTAccessRequirementStatus |
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}/cancellation | PUT |
|
| ACTAccessRequirementStatus |
| 12 | update a DataAccessSubmission | ACT | /dataAccessSubmission/{id} | PUT |
| SubmissionStateChangeRequest | DataAccessSubmission |
| 13 | retrieve a list of DataAccessSubmission | ACT | /accessRequirement/{id}/submissions | GET | nextPageToken, order (DataAccessSubmissionOrder), filter (DataAccessSubmissionState),
asc |
| DataAccessSubmissionPage |
14 | retrieve a list of Approval Status for a given list of AccessRequirement | SynapseUser | /accessApprovalStatus | POST |
| AccessApprovalStatusRequest | AccessApprovalStatusResults |
| 15 | retrieve restriction info for a given entity | Synapse user | /entity/{id}/restrictionInformation | GET |
|
| RestrictionInfo |
| 16 | retrieve access requirement status | Synapse user | /accessRequirement/{id}/status | GET |
|
| AccessRequirementStatus |
| 17 | retrieve info about open submissions | ACT | /dataAccessSubmission/openSubmissions | GET | nextPageToken |
| OpenSubmissionPage |
| 18 | retrieve approval info for users | ACT | /accessApproval/batch | POST |
| AccessApprovalRequests | AccessApprovalResults |
