REST API

This is a documentation page. Click here to go to the full documentation index.
Table of contents

Most APIs work through Content Negotiation. Every API type lists the MIME types used for this. In some cases, regular file extensions are listed. They can be used as an alternative.

Metadata

Regular metadata export is enabled for almost everything. The schema is described here. The following formats are supported:

Format MIME type File extension
JSON application/json .json

The following paths are supported:

Linked data

The CDLI catalog supports Linked Open Data output for catalog data. The following formats are supported:

Format MIME type File extension
JSON-LD application/ld+json .jsonld
RDF/JSON application/rdf+json -
RDF application/rdf+xml .xml, .rdf
N-Triples application/n-triples .nt
Turtle text/turtle, application/turtle, application/x-turtle .ttl

The following paths, part of the main catalog, support linked data APIs:

Bibliographies

Bibliography exports are supported for artifacts and publications. The following formats are supported:

Format MIME type File extension
BibTeX application/x-bibtex .bib
CSL-JSON application/vnd.citationstyles.csl+json -
Formatted bibliographies text/x-bibliography -
RIS application/x-research-info-systems .ris

Formatting is done using citeproc-js and CSL styles. To specify the bibliographic style of the formatted bibliographies, use the style query parameter. For styles that can be used, check out the CSL styles repository or Zotero's search index.

The following paths are supported:

Inscriptions

Inscriptions can be fetched from specific inscription versions or from the latest inscription of a given artifact. Note that CoNLL-RDF is included in the linked data export. The following formats are supported:

Format MIME type File extension
C-ATF text/x-c-atf -
CDLI-CoNLL text/x-cdli-conll -
CoNLL-U text/x-conll-u -

The following paths are supported:

Tabular exports

Tabular exports are supported for artifacts, publications, and the links between the two (artifactsPublications). The following formats are supported:

Format MIME type File extension
CSV text/csv .csv
TSV text/tab-separated-values .tsv
Excel application/vnd.openxmlformats-officedocument.spreadsheetml.sheet .xlsx

The following paths are supported:

Cite this Doc

Willighagen, Lars. 2022. “User Guides: REST API.” Cuneiform Digital Library Initiative. November 29, 2022. https://cdli.mpiwg-berlin.mpg.de/docs/api.

Willighagen, L. (2022, November 29). User guides: REST API. Cuneiform Digital Library Initiative. https://cdli.mpiwg-berlin.mpg.de/docs/api

Willighagen, L. (2022) User guides: REST API, Cuneiform Digital Library Initiative. Available at: https://cdli.mpiwg-berlin.mpg.de/docs/api (Accessed: November 29, 2022).

@misc{Willighagen2022User,
  • note = {[Online; accessed 2022-11-29]},
  • author = {Willighagen, Lars},
  • year = {2022},
  • month = {nov 29},
  • title = {User guides: REST {API}},
  • howpublished = {https://cdli.mpiwg-berlin.mpg.de/docs/api},
}

TY  - ELEC
AU  - Willighagen, Lars
DA  - 2022/11/29/
ID  - temp_id_147610058710
M1  - 2022/11/29/
TI  - User guides: REST API
UR  - https://cdli.mpiwg-berlin.mpg.de/docs/api
ER  -