E-Link: Reserving a DOI for datasets

Purpose

For some use cases, it is desirable to obtain a DOI for a dataset that is not yet published, in order to present this value or referring to it for publication or other dissemination. The E-Link 2 API supports obtaining the DOI value for a dataset with minimal required metadata information, with the caveat that the DOI will not be "live" (that is, resolvable) until the record is subsequently updated and completes processing.

The following interaction with the E-Link 2 API demonstrates this. The example presumes the user already has a valid API key, supplied with each API interaction via HTTP Header "Authorization".

Saving a new dataset record

Send minimal metadata; a "title", "product_type" value, and "site_ownership_code" to which the user has appropriate permissions, as a POST. Optionally, you may add a "doi_infix" value if such is desired.

POST https://www.osti.gov/elink2api/records/save

            
{
    "title": "Sample data for my publication",
    "product_type": "DA",
    "site_ownership_code": "LANL"
}
            
            

Example JSON Response

Information to note in the response would be the "osti_id" value, assigned to all new records, and the "doi" value is also returned. This DOI value is now "reserved"; note that it will not be active or registered until the record is completed via another user interaction below.

                
{
    "doi": "10.25583/2303364",
    "languages": [
        "English"
    ],
    "title": "Sample data for my publication",
    "persons": [],
    "organizations": [],
    "identifiers": [],
    "osti_id": 2303364,
    "revision": 1,
    "ANALYTIC_FLAG": false,
    "collection_type": "DOE_LAB",
    "country_publication_code": "US",
    "added_by": 118678,
    "edited_by": 118678,
    "date_added": "2024-04-24T12:39:20.436+00:00",
    "doe_supported_flag": false,
    "paper_flag": false,
    "product_type": "DA",
    "site_ownership_code": "LANL",
    "peer_reviewed_flag": false,
    "related_identifiers": [],
    "workflow_status": "SA",
    "edit_reason": "API record creation.",
    "date_updated": "2024-04-24T12:39:20.436+00:00"
}
                
            

Releasing/Completing the DOI submission

In order to "complete" the DOI registration, and thus make the DOI resolvable, additional required metadata information must be provided via subsequent update operations. Once the information is made available, or the dataset itself is "ready" to move forward, simply update the metadata information via PUT API calls. Additionally, the landing page URL must be provided to complete processing via a POST to the E-Link 2 media API.

Once the PUT operation meets required elements and passes validation, the record should be marked "completed" and processed in short order by OSTI. Part of this process will register the metadata with Datacite, and the DOI will be made resolvable, usually within a few minutes to an hour. For this request, please include either a Content-Type header ("application/json"), or an empty content body ("").

PUT https://www.osti.gov/elink2api/records/2303364

                
{
    // JSON with required fields for submission
}
                
            

POST https://www.osti.gov/elink2api/media/2303364?url=https://example.com/my-landing-page.html

An example using the curl utility:

            
curl -H "Authorization: Bearer USER-API-TOKEN" -H "Content-Type: application/json" -X POST https://www.osti.gov/elink2api/media/2303364?url=https://example.com/my-landing-page.html