API¶

The API supports retrieving all records of a table and retrieving a single record by its id.

list of records: https://contrib.dariah.eu/api/db/table

single record: https://contrib.dariah.eu/api/db/table/id

The result is in JSON format by default, but lists of records can also be retrieved as tab-separated values.

Tables¶

Here are all tables:

url	description
https://contrib.dariah.eu/api/db/contrib	contributions (see also below)
https://contrib.dariah.eu/api/db/country	countries (with membership info)
https://contrib.dariah.eu/api/db/criteria	the definitions of the assessment criteria, by contribution type
https://contrib.dariah.eu/api/db/discipline	valuelist of academic disciplines
https://contrib.dariah.eu/api/db/keyword	value list of keywords
https://contrib.dariah.eu/api/db/score	value list of scores
https://contrib.dariah.eu/api/db/tadirahActivity	value list of TADIRAH Activities
https://contrib.dariah.eu/api/db/tadirahObject	value list of TADIRAH Objects
https://contrib.dariah.eu/api/db/tadirahTechnique	value list of TADIRAH Techniques
https://contrib.dariah.eu/api/db/typeContribution	value list of contribution types, with main- and subtype
https://contrib.dariah.eu/api/db/vcc	value list of virtual competence centers
https://contrib.dariah.eu/api/db/year	value list of years

If output as TSV is preferred, append .tsv to the request:

https://contrib.dariah.eu/api/db/contrib.tsv

https://contrib.dariah.eu/api/db/country.tsv

N.B.: the tsv output for the contrib table is richer than the json output. See below.

You can also add .json, but that has the same effect as no extension at all:

https://contrib.dariah.eu/api/db/contrib.json

https://contrib.dariah.eu/api/db/country.json

Records¶

For all tables except contrib, the result of the list call is the list of the individual records where each individual record has exactly the same information as what you get by the single record call.

Contrib table¶

The list call for contributions delivers a list with reduced records. However, some additional workflow fields are included, i.e. information about the current assessment, review, and selection status of the contribution. This enables you to make a selection first before retrieving individual contributions.

However, the .tsv call for contrib records contain all the above fields plus the all the exportable fields of each record.

See below.

Fields¶

See the table specfication directory to see what fields there are in each table.

Permissions

You only get the publicly accessible values.

TSV exports

When delivering tab-separated data, the following measures are taken:

if a field has multiple values, they will be separated by middle dots: ·
newlines in field values will be replaced by §
tabs in fields will be replaced by (a sequence of two spaces)

As said above, for contrib records the fields are a bit different. Here is a (fictitious) example:

{
    "_id": "ae89ae89ae89ae89ae89ae89",
    "country": "AT",
    "year": 2018,
    "type": "activity - software development",
    "title": "SACHA - Simple Access to Cultural Heritage Assets",
    "selected": null,
    "assessed": "no assessment",
    "arank": [0, 0],
    "astage": null,
    "score": null,
    "reviewed1": "not reviewable",
    "reviewed2": "not reviewable",
    "r1Rank": 1,
    "r2Rank": 1,
    "r1Stage": "noReview",
    "r2Stage": "noReview"
}

When you ask for an individual contrib record, you get this

{
    "_id": "ae89ae89ae89ae89ae89ae89",
    "country": "AT",
    "year": 2018,
    "type": "activity - software development",
    "title": "SACHA - Simple Access to Cultural Heritage Assets",
    "vcc": ["VCC1"],
    "description": "Access to digitized holdings of the Austrian National Library through IIIF",
    "contactPersonName": ["Can Özgür YILMAZ BSc"],
    "contactPersonEmail": ["can.yilmaz@onb.ac.at"],
    "urlContribution": [],
    "urlAcademic": ["https://www.onb.ac.at/forschung/forschungsaktivitaeten/sacha"],
    "tadirahObject": ["Literature"],
    "tadirahActivity": [],
    "tadirahTechnique": ["Searching", "Browsing"],
    "discipline": ["Cultural Heritage", "digital humanities"],
    "keyword": [],
    "selected": null,
    "dateDecided": null,
    "assessed": "no assessment",
    "arank": [0, 0],
    "astage": null,
    "score": null,
    "reviewed1": "not reviewable",
    "reviewed2": "not reviewable",
    "r1Rank": 1,
    "r2Rank": 1,
    "r1Stage": "noReview",
    "r2Stage": "noReview"
}