...
Based on discussions with the ACT, we haven't had users come back to us with a final statement of use, so #8 would be low priority. #9 could still be solved by an R script.
Object Models
| ACTAccessRequirement |
|---|
| (original fields) |
| String instruction |
| Boolean isCertifiedUserRequired |
| Boolean isValidatedProfileRequired |
| Boolean isDUCRequired |
| String ducFileHandleId |
| Boolean isIRBRequired |
| Boolean areAttachmentsRequired |
| Boolean isAnnualReviewRequired |
| DataAccessRequest |
|---|
| String id |
| String accessRequirementId |
| String createdBy |
| Long createdOn |
| String projectLead |
| String institution |
| String intendedDataUseStatementFileHandleId |
| List<String> accessors |
| String ducFileHandleId |
| String irbFileHandleId |
| List<String> attachments |
| Long modifiedOn |
Any user can create a DataAccessRequest. accessRequirementId, and createdBy are required.
...
Once a request is submitted, a DataAccessSubmission object is created. While there is an DataAccessSubmission with status SUBMITTED, it's associated DataAccessRequest no longer available for update.
| DataAccessSubmission |
|---|
| String id |
| String dataAccessRequestId |
| String requestorId |
| Long submittedOn |
| String projectLead |
| String institution |
| String intendedDataUseStatementFileHandleId |
| List<String> accessors |
| String ducFileHandleId |
| String irbFileHandleId |
| List<String> attachments |
| State state (SUBMITTED, APPROVED, REJECTED, CANCELED) |
| String reviewerId |
| Long reviewedOn |
| String rejectedReason |
| Boolean canPublicAccess |
Once a DataAccessSubmission is created, it will have state SUBMITTED until a reviewer (ACT member) review and update its status.
...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 1 | create a DataAccessRequest | Synapse User | /dataAccessRequest | POST | DataAccessRequest | DataAccessRequest | |
| 2 | update a DataAccessRequest | creator | /dataAccessRequest | PUT | DataAccessRequest | DataAccessRequest | |
| 3 | submit a DataAccessRequest | creator | /dataAccessSubmission | POST | DataAccessRequest | DataAccessSubmission | |
| 4 | cancel a DataAccessSubmission | requestor | /dataAccessSubmission/{id}/cancel | PUT | DataAccessSubmission | ||
| 5 | update a DataAccessSubmission | ACT | /dataAccessSubmission | PUT | DataAccessSubmission | DataAccessSubmission | |
| 6 | retrieve a list of DataAccessSubmission | ACT | /accessRequirement/{id}/listSubmission | GET | nextPageToken, filter (by status) | DataAccessSubmissionPage |
Notification
| Condition | Target User | Notes | |
|---|---|---|---|
| 1 | After a new submission is created | ACT member | Includes link to a page that manages the dataset's access requests |
| 2 | After a submission is approved | Accessors | Includes link to dataset |
| 3 | After a request is rejected | Requestor | Includes reason Includes link to create a new request from the rejected one |
...