...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 1 | create a field | ACT | /field | POST | FieldCreate | Field | |
| 2 | retrieve a field | ACT | /field/{fieldId} | GET | Field |
Template (Phase 2)
A template contains a list of default fields the ACT wants to have on certain data access request form. When a member of the ACT creates a form on a dataset, they will create the form from an existing template. Once a template is created, it cannot be updated.
...
A form is created by an ACT member for a particular AccessRequirement. It contains the list of information the ACT wants from data requestor. It has the ACT's instruction on how to fill out a request for the data under access requirement.
Questions:
- Are there multiple versions of a form for a single accessRequirement?
- Does form ties to accessRequirement?
- Once a form is created for an accessRequirement/ data set, is there a need to update it?
| Form |
|---|
| String id |
| Long accessRequirementId |
| String name |
| String createdBy |
| Long createdOn |
| List<Field> fields |
| String instructions |
...
A DataAccessRequest is submitted by a data requestor to request access to to a particular dataset.
| DataAccessRequest |
|---|
| String requestorId |
| List<String> accessorIdList |
| String formId |
| Long accessRequirementId |
| List<Value> values |
| DataAccessRequestResult |
|---|
| String id |
| String requestorId |
| List<String> accessorIdList |
| String formId |
| Long accessRequirementId |
| Long createdOn |
| List<Value> values |
| DataAccessRequestStatus status (SUBMITTED, APPROVED, REJECTED) |
| String reason |
| Long modifiedOn |
| DataAccessRequestList |
|---|
| List<DataAccessRequestResult> results |
| Long numberOfResults |
| ChangeDataAccessRequest |
|---|
| String dataAccessRequestId |
| DataAccessRequestStatus status |
| String reason |
Services to create request and granting access:
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 7 | create a request | any Synapse User | /dataAccessRequest | POST | DataAccessRequest | DataAccessRequestResult | |
| 8 | retrieve requests for accessRequirementId | ACT | /dataAccessRequests | GET | accessRequirementIds, limit (max 20), offset, filter (SUBMITTED, APPROVED, REJECTED) | DataAccessRequestList | |
| 9 | delete a request | requestor | /dataAccessRequest/{dataAccessRequestId} | DELETE | |||
| 10 | change request status | ACT | /dataAccessRequest/{dataAccessRequestId} | PUT | ChangeDataAccessRequest |