Dataverse: How do I have a custom persistentId when creating a new dataset?

Created on 1 Nov 2018 · 7Comments · Source: IQSS/dataverse

We would like to have the following information for the field: Dataset Persistent ID:
doi:10.5072/nioz/7b.b.g since this DOI is already created on DataCite.

This is the request: (v. 4.9.4)
https://{our server}/api/v1/dataverses/doi/datasets/?key={our key}
This is the json used:
{
"authority": "10.5072/NIOZ",
"identifier": "nioz/7b.b.g",
"protocol": "doi",
"datasetVersion": {
"metadataBlocks": {
"citation": {
"displayName": "Citation Metadata",
"fields": [
{
"typeName": "title",
"multiple": false,
"typeClass": "primitive",
"value": "Dataset One"
},
{
"typeName": "alternativeURL",
"multiple": false,
"typeClass": "primitive",
"value": "https://doi.org/10.5072/nioz/7b.b.g"
},
{
"typeName": "author",
"multiple": true,
"typeClass": "compound",
"value": [
{
"authorName": {
"typeName": "authorName",
"multiple": false,
"typeClass": "primitive",
"value": "Smith, Robert"
},
"authorAffiliation": {
"typeName": "authorAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "The Smiths"
}
},
{
"authorName": {
"typeName": "authorName",
"multiple": false,
"typeClass": "primitive",
"value": "Kew, Susie"
},
"authorAffiliation": {
"typeName": "authorAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "Creedence Clearwater Revival"
}
}
]
},
{
"typeName": "datasetContact",
"multiple": true,
"typeClass": "compound",
"value": [
{
"datasetContactName": {
"typeName": "datasetContactName",
"multiple": false,
"typeClass": "primitive",
"value": "Dataverse, Admin"
},
"datasetContactAffiliation": {
"typeName": "datasetContactAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "Sample Datasets, inc."
},
"datasetContactEmail": {
"typeName": "datasetContactEmail",
"multiple": false,
"typeClass": "primitive",
"value": "[email protected]"
}
}
]
},
{
"typeName": "dsDescription",
"multiple": true,
"typeClass": "compound",
"value": [
{
"dsDescriptionValue": {
"typeName": "dsDescriptionValue",
"multiple": false,
"typeClass": "primitive",
"value": "This is a short text blurb describing the dataset. It is very informative and somewhat self-describing."
},
"dsDescriptionDate": {
"typeName": "dsDescriptionDate",
"multiple": false,
"typeClass": "primitive",
"value": "2015-01-14"
}
}
]
},
{
"typeName": "subject",
"multiple": true,
"typeClass": "controlledVocabulary",
"value": [
"Chemistry"
]
},
{
"typeName": "depositor",
"multiple": false,
"typeClass": "primitive",
"value": "Admin Dataverse"
},
{
"typeName": "dateOfDeposit",
"multiple": false,
"typeClass": "primitive",
"value": "2015-01-14"
}
]
}
}
}
}

Kind regards;
Flavio Francisco.

Source

flaviofrancisco

All 7 comments

@flaviofrancisco hi! Can you please try the new "import" API? See http://guides.dataverse.org/en/4.9.4/api/native-api.html#import-a-dataset-into-a-dataverse

pdurbin on 1 Nov 2018

👍1

I was just about to write that I was able to do it with the import.
Worked!
Thanks @pdurbin !

flaviofrancisco on 1 Nov 2018

🎉1

@flaviofrancisco hi! Do you mind sharing the curl command you used? And the JSON file?

pdurbin on 1 Nov 2018

Hi @pdurbin;
I am not using a file, I am using on the body message during my request.

This is my request url:
https://dataverse.nioz.nl//api/v1/dataverses/doi/datasets/:import?pid=doi:10.5072/nioz/7b.b.h

The headers:
Content-Type: application/json
X-Dataverse-key : {the account token}
Authorization: Basic {the account token converted to Base64 format}

You can use this site to convert and test: https://www.base64decode.org/

This is my JSON:
{
"authority": "10.5072/nioz/nioz",
"identifier": "doi:10.5072/nioz/7b.b.h",
"persistentUrl": "https://doi.org/10.5072/nioz/nioz/7b.b.h",
"protocol": "doi",
"datasetVersion": {
"license": "CC BY",
"metadataBlocks": {
"citation": {
"fields": [
{
"typeName": "depositor",
"multiple": false,
"typeClass": "primitive",
"value": "Eric Epping "
},
{
"typeName": "dateOfDeposit",
"multiple": false,
"typeClass": "primitive",
"value": "2018-10-25"
},
{
"typeName": "title",
"multiple": false,
"typeClass": "primitive",
"value": "My full filed DOI"
},
{
"typeName": "otherId",
"multiple": true,
"typeClass": "compound",
"value": [
{
"otherIdValue": {
"typeName": "otherIdValue",
"multiple": false,
"typeClass": "primitive",
"value": "DAS:4e48bd0a-a99a-4436-b15c-cb5576524728"
}
},
{
"otherIdValue": {
"typeName": "otherIdValue",
"multiple": false,
"typeClass": "primitive",
"value": "DOI:10.5072/nioz/7b.b.h"
}
}
]
},
{
"typeName": "author",
"multiple": true,
"typeClass": "compound",
"value": [
{
"authorName": {
"typeName": "authorName",
"multiple": false,
"typeClass": "primitive",
"value": "eric epping"
},
"authorAffiliation": {
"typeName": "authorAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "Royal Netherlands Institute for Sea Research"
}
},
{
"authorName": {
"typeName": "authorName",
"multiple": false,
"typeClass": "primitive",
"value": "Flavio Francisco"
},
"authorAffiliation": {
"typeName": "authorAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "Affiliation"
}
}
]
},
{
"typeName": "datasetContact",
"multiple": true,
"typeClass": "compound",
"value": [
{
"datasetContactName": {
"typeName": "datasetContactName",
"multiple": false,
"typeClass": "primitive",
"value": "Research Data Management"
},
"datasetContactAffiliation": {
"typeName": "datasetContactAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "NIOZ"
},
"datasetContactEmail": {
"typeName": "datasetContactEmail",
"multiple": false,
"typeClass": "primitive",
"value": "[email protected]"
}
},
{
"datasetContactName": {
"typeName": "datasetContactName",
"multiple": false,
"typeClass": "primitive",
"value": ""
},
"datasetContactAffiliation": {
"typeName": "datasetContactAffiliation",
"multiple": false,
"typeClass": "primitive",
"value": "NIOZ"
},
"datasetContactEmail": {
"typeName": "datasetContactEmail",
"multiple": false,
"typeClass": "primitive",
"value": "flavio.[email protected]"
}
}
]
},
{
"typeName": "dsDescription",
"multiple": true,
"typeClass": "compound",
"value": [
{
"dsDescriptionValue": {
"typeName": "dsDescriptionValue",
"multiple": false,
"typeClass": "primitive",
"value": "This data set contains a series of oxygen microprofiles recorded shipboard RV Pelagia in the framework of Enhanced Mineralization in Permable Sediments..."
},
"dsDescriptionDate": {
"typeName": "dsDescriptionDate",
"multiple": false,
"typeClass": "primitive",
"value": "2018-11-01"
}
}
]
},
{
"typeName": "keyword",
"multiple": true,
"typeClass": "compound",
"value": [
{
"keywordValue": {
"typeName": "keywordValue",
"multiple": false,
"typeClass": "primitive",
"value": "oxygen microprofiles"
}
}
]
}
],
"displayName": "My full filed DOI"
},
"geospatial": {
"displayName": "Geospatial Metadata",
"fields": [
{
"typeName": "geographicCoverage",
"multiple": true,
"typeClass": "compound",
"value": [
{
"otherGeographicCoverage": {
"typeName": "otherGeographicCoverage",
"multiple": false,
"typeClass": "primitive",
"value": "Southern North Sea"
}
}
]
},
{
"typeName": "geographicBoundingBox",
"multiple": true,
"typeClass": "compound",
"value": [
{
"eastLongitude": {
"typeName": "westLongitude",
"multiple": false,
"typeClass": "primitive",
"value": "53"
},
"northLongitude": {
"typeName": "southLongitude",
"multiple": false,
"typeClass": "primitive",
"value": "5"
}
}
]
}
]
}
}
}
}