User Metadata to DOI

A New DOI must be inserted for every new DataPublication created.
It is assumed that this endpoint will be called as and when a DOI/ Datapublication needs to be created. 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 DOI states can be found here
The information that goes into the DOI is taken from the API request.

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

A full list of all metadata can be found here

Metadata

Below is a mapping of user-supplied 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`	Based on values here
`creators`	Taken from API request
`affiliation.name`	Trys to search based on API Request
`affiliation.affiliationIdentifier`	http://ror.org	Returned through the ROR API
`affiliation.affiliationIdentifierScheme`	API	Hardcoded to ROR
`titles`	Taken from API request
`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`	Taken from API request
`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
`relatedIdentifiers`	Taken from API request

Example request

Below is an example of a request that can be made to the API

{
	"metadata": {
		"creators": [
			{
				"name": "James T Kirk",
				"givenName": "James",
				"familyName": "Kirk",
				"nameType": "Personal",
				"email": "airkemp@gmail.com",
				"affiliation": "University of Something"
			}
		],
		"relatedIdentifiers":[
			{
				"title": "A Title",
				"fullReference": "A landing page ref",
				"relatedIdentifier": "88976",
				"relatedIdentifierType": "DOI",
				"relationType":"IsCitedBy"
			},
			{
				"title": "A Title2",
				"fullReference": "A landing page ref2",
				"relatedIdentifier": "88975",
				"relatedIdentifierType": "DOI",
				"relationType":"IsCitedBy"
			}
		],
		"resource_type": "Dataset",
		"title": "Research into the melting point of a chocolate teapot",
		"description": "Data has shown that the melting point of a chocolate teapot can vary dependant on altitude relative to sea level...."
	},
	"investigations": {
		"ids": [
			8631996
		]
	},
	"datasets": {
		"ids": [
			7916
		]
	},
	"datafiles": {
		"ids": [
			2437097744
		]
	}
}

Example request DOI metadata

Given the request above, the following DOI is created

{
  "id": "https://doi.org/10.5286/gj21-ra04",
  "doi": "10.5286/GJ21-RA04",
  "url": "https://example.stfc.ac.uk/2703905064",
  "types": {
    "ris": "DATA",
    "bibtex": "misc",
    "citeproc": "dataset",
    "schemaOrg": "Dataset",
    "resourceTypeGeneral": "Dataset"
  },
  "creators": [
    {
      "name": "James T Kirk",
      "nameType": "Personal",
      "givenName": "James",
      "familyName": "Kirk",
      "affiliation": {
        "name": "University of Something"
      }
    }
  ],
  "titles": [
    {
      "title": "Research into the melting point of a chocolate teapot"
    }
  ],
  "publisher": "Diamond Light Source",
  "container": {},
  "subjects": [],
  "contributors": [],
  "dates": [
    {
      "date": "2022-11-03"
    },
    {
      "dateType": "Created"
    }
  ],
  "publicationYear": 2022,
  "identifiers": [],
  "sizes": [],
  "formats": [],
  "rightsList": [],
  "descriptions": [
    {
      "description": "Data has shown that the melting point of a chocolate teapot can vary dependant on altitude relative to sea level...."
    }
  ],
  "geoLocations": [],
  "fundingReferences": [],
  "relatedIdentifiers": [
    {
      "relationType": "IsCitedBy",
      "relatedIdentifier": "88976",
      "relatedIdentifierType": "DOI"
    },
    {
      "relationType": "IsCitedBy",
      "relatedIdentifier": "88975",
      "relatedIdentifierType": "DOI"
    }
  ],
  "relatedItems": [],
  "schemaVersion": "http://datacite.org/schema/kernel-4",
  "providerId": "bl",
  "clientId": "bl.stfc",
  "agency": "datacite",
  "state": "findable"
}