The Open API specification for Synapse is now available for download!

Download Open API Spec



A Renewal contains information required by an AccessRequirement and additional information about renewing a request.

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.
researchProjectId STRING The ID of the research project associated with this request.
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.
publication STRING Link(s) to publication that used the controlled data.
summaryOfUse STRING Summary of how the data has been used.