...
| ACTAccessRequirement |
|---|
| (original fields) |
| String instruction |
| Boolean isCertifiedUserRequired |
| Boolean isValidatedProfileRequired |
| Boolean isDUCRequired |
| String ducFileHandleId |
| Boolean isIRBRequired |
| Boolean areAttachmentsRequired |
| Boolean isAnnualReviewRequired |
| WorkingGroup |
|---|
| String id |
| String accessRequirementId |
| String institution |
| String projectLead |
| String intendedDataUseStatement |
| List<String> members |
| String ownerId |
| String createdBy |
| Long createdOn |
| Long modifiedOn |
| Long gainAccessOn |
Any user can create a WorkingGroup. To create a WorkingGroup, the following information are required: accessRequirementId, institution, projectLead, intendedDataUseStatement, members, ownerId, and createdBy. Id, createdOn, modifiedOn and gainAccessOn are set by the system. A user will not be able to change these values.
After a WorkingGroup is created, only the owner can make changes to the WorkingGroup. The owner can also change the ownership of a working group by changing the ownerId value to another userId that is in the list of members.
| DataAccessRequest |
|---|
| String id |
| String accessRequirementId |
| String createdBy |
| Long createdOn |
| String workingGroupId |
| String ducFileHandleId |
| String irbFileHandleId |
| List<String> attachments |
| Long modifiedOn |
Any user can create a DataAccessRequest to a given AccessRequirement. To create a DataAccessRequest, the following fields are required: accessRequirementId, and createdBy. A user can only create one DataAccessRequest to a given AccessRequirementId, createdOn, and modifiedOn are set by the system. A user cannot change these values.
Only creator of DataAccessRequest can update, and submit the request. To submit a request, it has to meet the requirements specified in the associated AccessRequirement.
...
Once a DataAccessSubmission is created, it will have state SUBMITTED until a reviewer (ACT member) review and update its status.
After a submission is Rejected and a reason is provided, the submission is closed for modification.
After a submission is Approved, the only update an ACT member can perform is changing the value of 'canPublicAccess.'
When an ACT member approves a submission, multiple AccessApproval are created for each member of the working group.
When the owner of a working group remove a user, the associated AccessApproval for that user will be remove.
When the owner of a working group add a user, he/she will also need to update the request and create a new submission. An ACT member will review the new submission and make decision to grant access to the new member.
Services
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 1 | create a WorkingGroup | SynapseUser | /workingGroup | POST | WorkingGroup | WorkingGroup | |
| 2 | retrieve a WorkingGroup | owner | /accessRequirement/{id}/workingGroup | GET | WorkingGroup | ||
| 3 | update a WorkingGroup | owner | /workingGroup | PUT | WorkingGroup | WorkingGroup | |
| 4 | transfer ownership of a WorkingGroup | owner | /workingGroup/{id}/updateOwner | PUT | WorkingGroup | WorkingGroup | |
| 5 | create a DataAccessRequest | Synapse User | /dataAccessRequest | POST | DataAccessRequest | DataAccessRequest | |
| 6 | retrieve a DataAccessRequest | creator | /accessRequirement/{id}/listRequest | GET | DataAccessRequest | ||
| 7 | update a DataAccessRequest | creator | /dataAccessRequest | PUT | DataAccessRequest | DataAccessRequest | |
| 8 | submit a DataAccessRequest | creator | /dataAccessSubmission | POST | DataAccessRequest | DataAccessSubmission | |
| 9 | retrieve a list DataAccessSubmission | requestor | /accessRequirement/{id}/listSubmission | GET | nextPageToken | DataAccessSubmissionPage | |
| 10 | cancel a DataAccessSubmission | requestor | /dataAccessSubmission/{id}/cancel | PUT | DataAccessSubmission | ||
| 11 | update a DataAccessSubmission | ACT | /dataAccessSubmission | PUT | DataAccessSubmission | DataAccessSubmission | |
| 12 | retrieve a list of DataAccessSubmission | ACT | /accessRequirement/{id}/listSubmission | GET | nextPageToken, filter (by status) | DataAccessSubmissionPage |
...