Skip to content
Help

Data Object Identifiers API

The Data Object Identifiers API provides support for assign DOI references to Documents and Layers.

For more information about enabling Data Object Identifier support to your site, please contact help@koordinates.com.

DOIs – or Data Object Identifiers – are unique addresses assigned to a piece of digital content. They are intended to provide a persistent link to its location on the internet. Koordinates supports manually assigned DOIs and supports DOI “minting” and integrated management with the DataCite registry service.

For support for other DOI registry services please contact us at help@koordinates.com.

For sites that have this feature enabled, the Data Object Identifiers API is an extension to Layer, Table and Document APIs.

DOI representations

Section titled “DOI representations”

DOIs can be defined in the following ways:

Any of these forms is considered an acceptable way to supply DOI strings to the API. You can also supply one or more of these in an object keyed by url or identifier as long as they are equivalent.

Where a Layer, Table, or Document has a DOI the item will have a property doi . For example:

{
    "id": 1,
    "url": "https://{domain}/services/api/v1.x/layers/1/",
    "title": "Example Layer",
    // …
    "doi": {
        "url": "https://doi.org/10.5072/FK2SJ1J03K",
        "identifier": "doi:10.5072/FK2SJ1J03K"
    }
    // …
}

On sites where this feature isn’t enabled, the DOI endpoints return 404 with {"detail": "Service not enabled."}.

Per-version DOI endpoints provide additional functionality. The examples below use layers: for tables, use /tables/{id}/versions/{version-id}/doi/, and for documents, use /documents/{id}/versions/{version-id}/doi/.

DOI detail

Section titled “DOI detail”
GET/layers/{id}/versions/{version-id}/doi/DOI Detail

Returns DOI detail for this Layer, Table or Document version.

Response 200

Headers

Content-Type: application/json

Body

{
    "url": "https://doi.org/10.5072/FK2SJ1J03K",
    "identifier": "doi:10.5072/FK2SJ1J03K"
}

Delete DOI

Section titled “Delete DOI”
DELETE/layers/{id}/versions/{version-id}/doi/Delete DOI

Deletes the DOI from a draft Layer, Table or Document version. DOIs cannot be deleted from non-draft versions.

Warning: Data Object Identifiers are intended to provide a persistent reference to the item. Koordinates will not prevent DOIs being removed from items, or prevent items being deleted if they have a DOI assigned. It is expected that the user will take the necessary steps to update the DOI registry with an appropriate alternative location or “tombstone page”.

Response 204

Mint DOI

Section titled “Mint DOI”

Minting is the process of requesting a new random DOI identifier from a registry service. This is only supported on sites with the DataCite registry service configured. Contact help@koordinates.com for more information.

POST/layers/{id}/versions/{version-id}/doi/Mint DOI

Response 201

{
    "url": "https://doi.org/10.5072/FK2SJ1J03K",
    "identifier": "doi:10.5072/FK2SJ1J03K"
}