...
Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
---|---|---|---|---|---|---|---|
create or update Research Project | Synapse User | /researchProject | POST | ResearchProject | ResearchProject | ||
get ResearchProject for update | creator | /accessRequirement/{id}/researchProjectForUpdate | GET | ResearchProject | |||
5 | |||||||
6 | |||||||
7 | asking the server for a suitable request object to start with | creator | /accessRequirement/{id}/dataAccessRequestForUpdate | GET | DataAccessRequestInterface | ||
create or update DataAccessRequest | Synapse User | /dataAccessRequest | POST | DataAccessRequestInterface | DataAccessRequestInterface | ||
9 | submit a DataAccessRequest | creator, | /dataAccessRequest/{id}/submission | POST | etag | ACTAccessRequirementStatus | |
11 | cancel a DataAccessSubmission | requestor, | /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 | |
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 | AccessApprovalRequestsBatchAccessApprovalRequest | AccessApprovalResultsBatchAccessApprovalResult |
AccessApprovalRequestsBatchAccessApprovalRequest |
---|
List<AccessApprovalRequest> requests |
...
AccessApprovalRequest |
---|
String userId |
String accessRequirementId |
AccessApprovalResultsBatchAccessApprovalResult |
---|
List<AccessApprovalResult> results |
...