E-Link API Dataset Examples
Adding a new Dataset
Below is an example use case of the E-Link 1 dataset API, for new records and updates. Hovering over the highlighted fields on the left side will indicate the corresponding values in JSON on the right, to demonstrate the new API terminology and structure.
Dataset records are implied to be "UNL", or unlimited access. Note that these fields in XML are no longer applicable or have been deprecated.
In E-Link 2 API, metadata ("records") and media REST operations are separated. In order to attach a landing page or other related media files, use the OSTI ID value obtained in the POST response for records to add media URLs in a separate POST to the media service, as detailed below.
E-Link1 241.6 XML NEW RECORD
POST /elink/2416api
<records>
<record>
<dataset_type>SM</dataset_type>
<title>Title of the data set</title>
<authors>
<author>
<first_name>Author</first_name>
<last_name>One</last_name>
<private_email>oneguy@private.email.com</private_email>
</author>
<author>
<first_name>Author</first_name>
<last_name>Two</last_name>
</author>
<author>
<first_name>Author</first_name>
<last_name>Three</last_name>
</author>
<author>
<first_name>Sample</first_name>
<middle_name>Q.</middle_name>
<last_name>Mann</last_name>
<affiliation_name>Test Persons, Inc.</affiliation_name>
<private_email>sampleguy@someplace.com</private_email>
<orcid_id>0000-0001-5109-3700</orcid_id>
</author>
</authors>
<contributors>
<contributor contributorType="Researcher">
<first_name>Jane</first_name>
<last_name>Doe</last_name>
<affiliation_name>Research Services, Inc.</affiliation_name>
</contributor>
<contributor contributorType="DataCurator">
<first_name>Testing</first_name>
<last_name>Guy</last_name>
</contributor>
</contributors>
<contact_name>Data User</contact_name>
<contact_org>OSTI</contact_org>
<contact_email>testing@osti.gov</contact_email>
<contact_phone>888-241-5926</contact_phone>
<related_resource>Related Resource information</related_resource>
<product_nos>product-001</product_nos>
<product_type>DA</product_type>
<contract_nos>AC36-08GO28308</contract_nos>
<other_identifying_numbers>01234</other_identifying_numbers>
<originating_research_org>A Research University (United States)</originating_research_org>
<availability>Direct paper publishing information</availability>
<collaboration_names>Contributions Unlimited, LLC.</collaboration_names>
<publication_date>2014</publication_date>
<language>English</language>
<country>US</country>
<site_input_code>OSTI</site_input_code>
<sponsor_org>USDOE Office of Science (SC)</sponsor_org>
<subject_categories_code>Testing; Software; Data</subject_categories_code>
<keywords>Data Sources; Measuring; Scientific Method</keywords>
<accession_num>123456789</accession_num>
<description>A simple abstract description of the data set and its research information.</description>
<awards>
<award>
<award_doi>10.11578/92930</award_doi>
<award_number>92930</award_number>
<funder_name>Awarding Entity, Inc.</funder_name>
</award>
</awards>
<related_identifiers>
<detail>
<related_identifier>10.5072/0007</related_identifier>
<related_identifier_type>DOI</related_identifier_type>
<relation_type>IsPreviousVersionOf</relation_type>
</detail>
<detail>
<related_identifier>10.5072/journal.2007.01529.x</related_identifier>
<related_identifier_type>DOI</related_identifier_type>
<relation_type>IsCompiledBy</relation_type>
</detail>
</related_identifiers>
<geolocations>
<geolocation>
<place>Tennessee</place>
<polygon>
<point longitude="-81.6064453125" latitude="36.597889133070225"/>
<point longitude="-88.04443359375" latitude="36.6507925250347"/>
<point longitude="-88.06640625" latitude="36.491973470593685"/>
<point longitude="-89.45068359375" latitude="36.4566360115962"/>
<point longitude="-90.32958984375" latitude="34.994003757575776"/>
<point longitude="-84.35302734375" latitude="35.02999636902566"/>
<point longitude="-81.6064453125" latitude="36.597889133070225"/>
</polygon>
</geolocation>
<geolocation>
<place>Near Myrtle Beach, SC</place>
<point longitude="-78.85986328125" latitude="33.72433966174761"/>
</geolocation>
<geolocation>
<place>Around Atlanta, GA</place>
<boundingBox>
<westLongitude>-84.5233154296875</westLongitude>
<eastLongitude>-84.287109375</eastLongitude>
<northLatitude>33.85673152928873</northLatitude>
<southLatitude>33.60546961227188</southLatitude>
</boundingBox>
</geolocation>
</geolocations>
<doi_infix>DataScienceJournal</doi_infix>
<file_extension>xls</file_extension>
<software_needed>Excel or other spreadsheet software</software_needed>
<site_url>http://host.com/my_landing_page.html</site_url>
<dataset_size>50 GB</dataset_size>
<othnondoe_contract_nos>NonDOEAwardNumber001</othnondoe_contract_nos>
</record>
</records>
E-Link 2 JSON API NEW RECORD
POST /elink2api/records
{
"title": "Title of the data set",
"access_limitations": [
"UNL"
],
"persons": [
{
"type":"AUTHOR",
"first_name":"Author",
"last_name":"One",
"email":["oneguy@private.email.com"]
},
{
"type":"AUTHOR",
"first_name":"Author",
"last_name":"Two"
},
{
"type":"AUTHOR",
"first_name":"Author",
"last_name":"Three"
},
{
"type":"AUTHOR",
"first_name":"sample",
"middle_name":"Q.",
"last_name":"Mann",
"email":["sampleguy@someplace.com"],
"affiliations":[{ "name": "Test Persons, Inc." }],
"orcid":"0000-0001-5109-3700"
},
{
"type":"CONTRIBUTING",
"first_name":"Jane",
"last_name":"Doe",
"affiliations":[{ "name": "Research Services, Inc." }],
"contributor_type":"Researcher"
},
{
"type":"CONTRIBUTING",
"first_name":"Testing",
"last_name":"Guy",
"contributor_type":"DataCurator"
},
{
"type":"RELEASE",
"first_name":"Data",
"last_name":"Services",
"email":["testing@osti.gov"],
"affiliations":[{ "name": "OSTI" }],
"phone":"888-241-5926"
}
],
"product_type": "DA",
"identifiers": [
{
"type": "RN",
"value": "product-001"
},
{
"type": "OTHER_ID",
"value": "01234"
},
{
"type": "CN_NONDOE",
"value":"NonDOEAwardNumber001"
}
],
"organizations": [
{
"type": "RESEARCHING",
"name": "A Research University (United States)"
},
{
"type": "SPONSOR",
"name": "USDOE Office of Science (SC)"
},
{
"type": "SPONSOR",
"name": "Awarding Entity, Inc.",
"identifiers":[
{
"type": "CN_DOE",
"value": "AC36-08GO28308"
},
{
"type": "AWARD_DOI",
"value": "10.11578/92930"
}
]
}
],
"availability": "Direct paper publishing information",
"publication_date": "2014",
"languages": [
"English"
],
"country_publication_code": "US",
"site_unique_id": "123456789",
"site_ownership_code": "OSTI",
"keywords": [
"Data Sources",
"Measuring",
"Scientific Method"
],
"description": "A simple abstract description of the data set and its research information.",
"related_doc_info": "Related Resource information",
"related_identifiers": [
{
"value": "10.5072/0007",
"relation": "IsPreviousVersionOf",
"type": "DOI"
},
{
"value": "10.5072/journal.2007.01529.x",
"type": "DOI",
"relation": "IsCompiledBy"
}
],
"geolocations":[
{
"type":"POLYGON",
"label":"Tennessee",
"points":[ {"longitude":-81.6064453125, "latitude": 36.597889133070225 },
{ "longitude": -88.04443359375, "latitude": 36.6507925250347 },
{ "longitude": -88.06640625, "latitude": 36.491973470593685 },
{ "longitude": -89.45068359375, "latitude": 36.4566360115962 },
{ "longitude": -90.32958984375, "latitude": 34.994003757575776 },
{ "longitude": -84.35302734375, "latitude": 35.02999636902566 },
{ "longitude": -81.6064453125, "latitude": 36.597889133070225 }
]
},
{
"type": "POINT",
"label": "Near Myrtle Beach, SC",
"points":[{ "longitude": -78.85986328125, "latitude": 33.72433966174761 }]
},
{
"type":"BOX",
"label": "Around Atlanta, GA",
"points":[{ "longitude": -84.5233154296875, "latitude": 33.85673152928873 },
{ "longitude": -84.287109375, "latitude": 33.60546961227188 }]
}
],
"doi_infix": "DataScienceJournal",
"product_size": "50 GB",
"released_to_osti_date": "2019-10-01"
}
E-Link 2 JSON API NEW MEDIA
POST /elink2api/media/OSTI_ID?url=https://host.com/my_landing_page.html