...
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 | DataAccessSubmissionStatus ACTAccessRequirementStatus | |
DataAccessSubmissionStatus | |||||||
11 | cancel a DataAccessSubmission | requestor, | /dataAccessSubmission/{id}/cancellation | PUT | DataAccessSubmissionStatus 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 | |
DataAccessSubmissionStatus | |||||||
15 | retrieve restriction info for a given entity | Synapse user | /entity/{id}/restrictionInfo | GET | RestrictionInfo | ||
16 | retrieve access requirement status | Synapse user | /accessRequirement/{id}/status | GET | AccessRequirementStatus |
ACTAccessRequirementStatus implements AccessRequirementStatus |
---|
String accessRequirementId |
String submissionId |
DataAccessSubmissionState state |
String rejectedReason |
Long reviewedOn |
...
SubmissionStateChangeRequest |
---|
String submissionId |
DataAccessSubmissionState newState (only APPROVED and REJECTED are valid) |
String rejectedReason |
AccessApprovalStatusRequest |
List<String> accessRequirementIdList |
AccessApprovalStatusResults |
List<AccessApprovalStatusResult> results |
ACTAccessApprovalStatusResult implements AccessApprovalStatusResult |
String accessRequirementId |
Status (NOT_SUBMITTED, SUBMITTED, APPROVED, REJECTED) |
TermsOfUseAccessApprovalStatus implements AccessApprovalStatusResult |
String accessRequirementId |
RestrictionInfo |
---|
RestrictionLevel restrictionLevel (OPEN, RESTRICTED_BY_TERMS_OF_USE, CONTROLLED_BY_ACT) |
boolean hasUnmet |
TermsOfUseAccessRequirementStatus implements AccessRequirementStatus |
---|
String accessRequirementId |
boolean isApproved |
Compare behaviors of #6 and #7
...