Sign in
latestOpenAPI 3.1.02026-08-08264458.4 KB

5e35babfb8d2

versions

Show a specific dataset version

If you know the dataset version's internal id, you can request its record directly. The <code>/versions</code> endpoint lists the versions of a dataset and their ids.

get/versions/{id}

Path parameters

idinteger required

The version ID is a unique integer and can be obtained from the list of versions for a dataset.

Response

The requested version of the dataset.

titlestring required
abstractstring required

An abstract introducing the dataset.

keywordsstring[]
fieldOfSciencestring

A term from the FOS (Fields of Science and Technology) controlled vocabulary. The main category of the dataset.

hsiStatementstring

A statement explaining the de-identification of any human subject data in the dataset.

methodsstring

The methods by which the data was produced. Not required for publication.

usageNotesstring

Usage notes for the dataset (Deprecated; It is preferred for this content to appear in the README file for the dataset). If the dataset has been retracted, the retraction statement will appear here.

versionNumberinteger
versionStatus'in_progress' | 'processing' | 'submitted'

Internal processing status of files.

curationStatus'In progress' | 'Processing' | 'Queued for curation' | 'Private for Peer Review' | 'Awaiting payment' | 'Curation' | 'Action required' | 'Withdrawn' | 'Embargoed' | 'Published'

Status of the submission in the curation workflow.

versionChanges'files_changed' | 'metadata_changed'
publicationDatestring
lastModificationDatestring
visibilitystring

Whether or not this version is publicly visible.

changedFieldsstring[]

Example response

{
  "funders": [
    {
      "identifier": "https://ror.org/00x6h5n95",
      "identifierType": "ror"
    }
  ]
}