Submission
org.sagebionetworks.repo.model.dataaccess.Submission
A submission to request access to controlled data.
| Field | Type | Description |
|---|---|---|
| id | STRING | The unique immutable ID for this submission. A new ID will be generated for new Submission. Once issued, this ID is guaranteed to never change or be re-issued. |
| accessRequirementId | STRING | The ID of the Access Requirement which requires a request to be submitted to gain access to a dataset. This submission contains information that satisfies those requirements. |
| accessRequirementVersion | INTEGER | The version of the Access Requirement which requires a request to be submitted to gain access to a dataset. This submission contains information that satisfies those requirements. |
| requestId | STRING | The ID of the Request which is used to create this submission. |
| ducFileHandleId | STRING | The Data Use Certificate uploaded by user. |
| irbFileHandleId | STRING | The Institutional Review Board Approval document uploaded by user. |
| attachments | ARRAY<STRING> | The set of file handle ID of attached files to this request. |
| accessorChanges | ARRAY<AccessorChange> | List of user changes. A user can gain access, renew access or have access revoked. |
| researchProjectSnapshot | ResearchProject | A research project describes a project at an institution that used a controlled data set for the purposes that are stated in the Intended Data Use Statement. |
| isRenewalSubmission | BOOLEAN | True if this submission is a renewal submission. |
| publication | STRING | Link(s) to publication that used the controlled data. |
| summaryOfUse | STRING | Summary of how the data has been used. |
| submittedOn | STRING | The date this submission was created. |
| modifiedOn | STRING | The date this submission was reviewed or was cancelled. |
| submittedBy | STRING | The ID of the user that submitted this submission. |
| modifiedBy | STRING | The ID of the user that last modified the status of this submission. |
| state | SubmissionState | The state of a Submission. |
| rejectedReason | STRING | The reason this submission is rejected, if it's rejected. |
| etag | STRING | Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time a request is updated it is used to detect when a client's current representation of a request is out-of-date. |
| subjectId | STRING | The ID of the subject user interested in. This information will be used to help user navigate back to where they were to continue their work. |
| subjectType | RestrictableObjectType | JSON enum for the types of objects which can be restricted by an AccessRequirement. |