RequestInterface <INTERFACE>
org.sagebionetworks.repo.model.dataaccess.RequestInterface
This is the base interface that all Request implements.
Known Implementations:
Request, Renewal| Field | Type | Description |
|---|---|---|
| id | STRING | The unique immutable ID for this request. A new ID will be generated for new Request. 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 request contains information that satisfies those requirements. |
| accessRequirementVersionNumber | INTEGER | The version of the Access Requirement that this request was last saved against. Set by the server on each create and update, so that a client resuming a request can compare it against the current version of the Access Requirement to detect that the requirement changed since the last save, and can clear that warning by saving the request against the current form. A client supplied value is ignored. |
| researchProjectId | STRING | The ID of the research project associated with this request. Only a request for a ManagedACTAccessRequirement has a research project; for a JsonSchemaAccessRequirement the equivalent information is collected as part of the schemaData. |
| createdOn | STRING | The date this request was created. |
| modifiedOn | STRING | The date this request was last modified. |
| createdBy | STRING | The ID of the user that created this request. |
| modifiedBy | STRING | The ID of the user that last modified this request. |
| 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. |
| 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. |
| concreteType | STRING | Indicates which implementation of RequestInterface this object represents. |
| institution | STRING | The name of the institution where the collaborators work. |
| principalInvestigator | PrincipalInvestigator | Information about a research project's principal investigator. |
| signingOfficial | SigningOfficial | Information about an institution's signing official. |
| eDucSignatureEnvelopeId | STRING | The envelope ID for the routed eDUC signature document. |
| schemaData | OBJECT | Request data that was provided using the associated JSON Schema. Unvalidated while the request is a draft; validated against the schema referenced by the Access Requirement when a Submission is created. |