Investigation to DOI

A New DOI must be created for every new DataPublication created.

It is assumed that this endpoint will be called as part of a script that automatically creates DataPublications and DOIs based on an embargo end date. The process of creating a DOI is split into 2 parts:
- creating a draft to populate the DataPublication
- creating a findable DOI (moving from draft to findable) once the DP has been created.
- More info on DOI states can be found here
The information that goes into the DOI is made up of the Investigation and the newly created DataPublication.

A list of the required (minimum) metadata can be found here

A full list of all metadata can be found here

Below is a list of Metadata that the API inserts into the DOI followed by an example.

Key	Source	Comments

Key	Source	Comments
`id`	Datacite	Returned from datacite when the draft is created. See here
`doi`	Datacite	Returned from datacite when the draft is created. See here
`url`	config + ICAT	A base url is set which the DP ID is added to.
`types`	API	Based on values here
`creators`	`Investigation.investigationUsers.user`
`affiliation.name`	`Investigation.investigationUsers.user.affiliation`	Trys to search using the ROR API
`affiliation.affiliationIdentifier`	http://ror.org	Returned through the ROR API
`affiliation.affiliationIdentifierScheme`	API	Hardcoded to ROR
`titles`	`Investigation.name` + `Investigation.title`	Name e.g “MX15” appended to the beginning of title
`publisher`	API	Hardcoded to “Diamond Light Source”
`dates.date`	API	Generated at the time of minting
`dates.dateType`	API	Based on values here
`publicationYear`	API	Generated at the time of minting
`descriptions`	`Investigation.summary`
`schemaVersion`	Datacite	Returned from datacite when the draft is created. See here
`providerId`	Datacite	Returned from datacite when the draft is created. See here
`clientId`	Datacite	Returned from datacite when the draft is created. See here

Example DOI metadata

Given an Investigation 4877374020, the following DOI is generated:

{
  "id": "https://doi.org/10.5286/czw5-8a98",
  "doi": "10.5286/CZW5-8A98",
  "url": "https://example.stfc.ac.uk/2703905988",
  "types": {
    "ris": "DATA",
    "bibtex": "misc",
    "citeproc": "dataset",
    "schemaOrg": "Dataset",
    "resourceTypeGeneral": "Dataset"
  },
  "creators": [
    {
      "name": "Dr Jun Kokubun",
      "nameType": "Personal",
      "givenName": "Jun",
      "familyName": "Kokubun",
      "affiliation": {
        "name": "Tokyo University of Science",
        "affiliationIdentifier": "https://ror.org/05sj3n476",
        "affiliationIdentifierScheme": "ROR"
      }
    },
    {
      "name": "Prof Stephen Lovesey",
      "nameType": "Personal",
      "givenName": "Stephen",
      "familyName": "Lovesey",
      "affiliation": {
        "name": "Diamond Light Source",
        "affiliationIdentifier": "https://ror.org/05etxs293",
        "affiliationIdentifierScheme": "ROR"
      }
    },
    {
      "name": "Mr Joel Collins",
      "nameType": "Personal",
      "givenName": "Joel",
      "familyName": "Collins",
      "affiliation": {
        "name": "University of Bath",
        "affiliationIdentifier": "https://ror.org/002h8g185",
        "affiliationIdentifierScheme": "ROR"
      }
    }
  ],
  "titles": [
    {
      "title": "MM21716-1: Quadrupolar X-ray Magnetic Circular Dichroism using Superchiral X-rays"
    }
  ],
  "publisher": "Diamond Light Source",
  "container": {},
  "subjects": [],
  "contributors": [],
  "dates": [
    {
      "date": "2022-11-22"
    },
    {
      "dateType": "Created"
    }
  ],
  "publicationYear": 2022,
  "identifiers": [],
  "sizes": [],
  "formats": [],
  "rightsList": [],
  "descriptions": [
    {
      "description": "Superchiral light can retrieve electronic properties of matter that are invisible with traditional, classical spectroscopies. By generating precisely sculpted optical beams, coupling to chiral properties can be enhanced dramatically [1]. Our studies show that the x-ray standing-wave field in diffraction, with circularly polarized light, is an x-ray manifestation of superchiral light [2]. Notably, the corresponding spectroscopy is found to be intimately related to Borrmann spectroscopy, where we have demonstrated very strong enhancement of quadrupole absorption (E2-E2) [3, 4]. Here, we aim to demonstrate an enhancement of E2-E2 contributions to x-ray magnetic circular dichroism (XMCD) in crystals of YIG and HoIG. A successful experiment will yield valuable data to assist the theoretical interpretation of (hard) x-ray XMCD, and provide a stimulating link to classical optics."
    }
  ],
  "geoLocations": [],
  "fundingReferences": [],
  "relatedIdentifiers": [],
  "relatedItems": [],
  "schemaVersion": "http://datacite.org/schema/kernel-4",
  "providerId": "bl",
  "clientId": "bl.stfc",
  "agency": "datacite",
  "state": "findable"
}