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

Download Open API Spec

DoiAssociation

org.sagebionetworks.repo.model.doi.v2.DoiAssociation

All fields that associate a Synapse object with a DOI. The objectId and objectType are required to create or mint a DOI in all circumstances.

Field Type Description
associationId STRING The unique ID of this DOI stored in Synapse. Provided by Synapse.
etag STRING For Optimistic Concurrency Control (OCC). Required to successfully update a DOI.
doiUri STRING The unique URI of this DOI to which the resource can be resolved. Provided by Synapse.
doiUrl STRING The DOI URL that will point to the Synapse object. Provided by Synapse.
objectId STRING Required. The ID of the digital object in Synapse for which this DOI is created.
objectType ObjectType JSON enum for the types of objects in Synapse.
objectVersion INTEGER Optional. The version of the digital object. When null, the DOI is associated with the current version of the object.
associatedBy STRING The ID of the user that creates this DOI. Provided by Synapse.
associatedOn STRING The date time this DOI is first created. Provided by Synapse.
updatedBy STRING The ID of the user that last updated this DOI. Provided by Synapse.
updatedOn STRING The date time this DOI is last updated. Provided by Synapse.