Sign in
latestOpenAPI 3.1.02026-08-08264458.4 KB

5e35babfb8d2

datasets

Create a new dataset with an automatically-generated DOI

You must be <a href="https://github.com/datadryad/dryad-app/blob/main/documentation/apis/api_accounts.md">logged in</a>. Use a JSON structure as shown below.

If no funders are declared, users will be asked to list them later; to declare no funding submit a funder with <code>identifier: '0'</code> (see the "Set no funding" example). If human subject information is in the dataset, include a statement explaining how the data was de-identified (see the 'Include HSI statement' example).

For a more full list of properties that can be sent, check the Model below and the <a href="https://github.com/datadryad/dryad-app/blob/main/documentation/apis/sample_dataset.json" target="_blank">sample dataset object</a>.

Further detailed instructions and examples can be found in <a href="https://github.com/datadryad/dryad-app/blob/main/documentation/apis/submission.md">additional submission API documentation</a>.

post/datasets

Request body

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.

userIdstring

The Dryad user ID, or ORCID iD, of the user who will submit the dataset. If this is unknown, the userId must be set to 0 to allow for an invitation link.

publicationISSNstring

An ISSN for the associated journal

publicationNamestring

The title of the associated journal

manuscriptNumberstring

The internal manuscript number assigned to an associated article before publication

skipEmailsboolean

Administrator value. Prevents emails being sent automatically.

triggerSubmitInvitationboolean

Administrator value. Sends an editing invitation email to the first author.

preserveCurationStatusboolean

Administrator value. Prevents automatic curation status changes.

holdForPeerReviewboolean

Administrator value. Sets whether the submission will be sent to curation or a peer review hold status.

loosenValidationboolean

For superusers only.

skipDataciteUpdateboolean

For superusers only.

invoiceIdstring

For superusers only.

Example request

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

Response

Show the dataset information that has been saved.

countinteger
totalinteger

Example response

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