latestOpenAPI 3.1.02026-08-08264458.4 KB

5e35babfb8d2

datasets

Get a dataset record by its DOI

Be sure to URL encode the DOI (see example below). Datasets that are not yet published are only retrievable by users with permission to access them.

get/datasets/{doi}

Path parameters

doistring required

DOI like doi:10.1000/18238577 that should be URL encoded (example: <code>doi%3A10.1000%2F18238577</code>)

Response

Dataset information retrieved.

identifierstring
idinteger
storageSizeinteger
relatedPublicationISSNstring
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.

licensestring

The license of the dataset

Example response

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