--- title: "Update (overwrite) dataset metadata for DOI" method: PUT path: "/datasets/{doi}" tags: ["datasets"] --- # Update (overwrite) dataset metadata for DOI `PUT /datasets/{doi}` This will overwrite writeable metadata for an in-progress dataset. This is an insert or update action (upsert). Be sure to URL encode the DOI (see example below). You must be logged in. Use a JSON structure as shown below. For a more full list of properties that can be sent, check the Schema below and the sample dataset object. ## Path parameters - `doi` string, required ## Request body - object - `title` string, required - `authors` Author[], required - `firstName` string - `lastName` string - `email` string - `affiliation` string - `affiliationROR` string — Preferred identifier for the author affiliation. - `affiliations` unknown[] - unknown - `affiliationISNI` string - `orcid` string - `order` integer - `abstract` string, required — An abstract introducing the dataset. - `funders` Funder[] - `organization` string - `identifier` string — The organization identifier, for example a ROR ID. - `identifierType` string — Type of identifier — ror, isni, grid, crossref_funder_id or other. - `awardNumber` string - `awardDescription` string — Usually used for the program or the division of the award. - `order` integer - `keywords` string[] - `fieldOfScience` string — A term from the FOS (Fields of Science and Technology) controlled vocabulary. The main category of the dataset. - `hsiStatement` string — A statement explaining the de-identification of any human subject data in the dataset. - `methods` string — The methods by which the data was produced. Not required for publication. - `usageNotes` string — 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. - `locations` Geolocation[] - `place` string — A place name. - `box` GeolocationBox - `swLongitude` number — The longitude of the southwest corner of the box. - `swLatitude` number — The latitude of the southwest corner of the box. - `neLongitude` number — The longitude of the northeast corner of the box. - `neLatitude` number — The latitude of the northeast corner of the box. - `point` GeolocationPoint - `latitude` number — The latitude of the point. - `longitude` number — The longitude of the point. - `relatedWorks` RelatedWork[] - `relationship` 'article' | 'dataset' | 'preprint' | 'software' | 'supplemental_information' | 'primary_article' | 'data_management_plan', string - `identifierType` string - `identifier` string - `identifier` string — The Dryad dataset DOI - `userId` string — 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. - `publicationISSN` string — An ISSN for the associated journal - `publicationName` string — The title of the associated journal - `manuscriptNumber` string — The internal manuscript number assigned to an associated article before publication - `skipEmails` boolean — Administrator value. Prevents emails being sent automatically. - `triggerSubmitInvitation` boolean — Administrator value. Sends an editing invitation email to the first author. - `preserveCurationStatus` boolean — Administrator value. Prevents automatic curation status changes. - `holdForPeerReview` boolean — Administrator value. Sets whether the submission will be sent to curation or a peer review hold status. - `loosenValidation` boolean — For superusers only. - `skipDataciteUpdate` boolean — For superusers only. - `invoiceId` string — For superusers only. ## Response `200` Show the dataset information that has been saved. - Datasets - `_links` object - `self` HalLink - `href` string, uri, required - `first` HalLink - `href` string, uri, required - `last` HalLink - `href` string, uri, required - `prev` HalLink - `href` string, uri, required - `next` HalLink - `href` string, uri, required - `count` integer - `total` integer - `_embedded` object - `stash:datasets` Dataset[] - `identifier` string - `id` integer - `storageSize` integer - `relatedPublicationISSN` string - `_links` object - `self` HalLink - `href` string, uri, required - `stash:dataset` HalLink - `href` string, uri, required - `stash:files` HalLink - `href` string, uri, required - `stash:download` HalLink - `href` string, uri, required - `curies` HalCurie[] - `name` string, required - `href` string, uri, required - `templated` boolean, required - `stash:versions` HalLink - `href` string, uri, required - `stash:version` HalLink - `href` string, uri, required - `title` string, required - `authors` Author[], required - `firstName` string - `lastName` string - `email` string - `affiliation` string - `affiliationROR` string — Preferred identifier for the author affiliation. - `affiliations` unknown[] - unknown - `affiliationISNI` string - `orcid` string - `order` integer - `abstract` string, required — An abstract introducing the dataset. - `funders` Funder[] - `organization` string - `identifier` string — The organization identifier, for example a ROR ID. - `identifierType` string — Type of identifier — ror, isni, grid, crossref_funder_id or other. - `awardNumber` string - `awardDescription` string — Usually used for the program or the division of the award. - `order` integer - `keywords` string[] - `fieldOfScience` string — A term from the FOS (Fields of Science and Technology) controlled vocabulary. The main category of the dataset. - `hsiStatement` string — A statement explaining the de-identification of any human subject data in the dataset. - `methods` string — The methods by which the data was produced. Not required for publication. - `usageNotes` string — 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. - `locations` Geolocation[] - `place` string — A place name. - `box` GeolocationBox - `swLongitude` number — The longitude of the southwest corner of the box. - `swLatitude` number — The latitude of the southwest corner of the box. - `neLongitude` number — The longitude of the northeast corner of the box. - `neLatitude` number — The latitude of the northeast corner of the box. - `point` GeolocationPoint - `latitude` number — The latitude of the point. - `longitude` number — The longitude of the point. - `relatedWorks` RelatedWork[] - `relationship` 'article' | 'dataset' | 'preprint' | 'software' | 'supplemental_information' | 'primary_article' | 'data_management_plan', string - `identifierType` string - `identifier` string - `versionNumber` integer - `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' - `publicationDate` string - `lastModificationDate` string - `visibility` string — Whether or not this version is publicly visible. - `metrics` object - `views` integer - `downloads` integer - `citations` integer - `license` string — The license of the dataset ## Other responses - `400` - `401` - `406` --- [API](https://skmtc.net/datadryad/apis/dryad-api.md) · [All operations](https://skmtc.net/datadryad/apis/dryad-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadryad/dryad-api/revisions/5e35babfb8d2/schema)