Umaka REST API

Umaka Data provides information about Linked Data endpoints. We can access the information via REST API. This document shows how we can retrieve the data.

Endpoint Search

API can be accessed over HTTP from 'https://d.umaka.dbcls.jp', and API returns data as JSON.

Retrieve Information of All Endpoints

You can retrieve information of all endpoints as follows:

curl -L -H 'Accept: application/json' https://d.umaka.dbcls.jp/api/endpoint/search

This return the list of information of endpoints as follows:

[
  {
    "id": 1,
    "name": "Allie",
    "endpoint_url": "http://data.allie.dbcls.jp/sparql",
    "description_url": "http://data.allie.dbcls.jp/",
    "evaluation": {
      "started_at": "2019-01-01T00:00:00.000Z",
      "rank": "A",
      "score": 100,
      "publisher": [
        "http://dbcls.jp/"
      ],
      "license": [
        "http://creativecommons.org/licenses/by/2.1/jp/"
      ],
      "language": [
        "SPARQL11Query"
      ],
      "service_keyword": true,
      "graph_keyword": true,
      "data_scale": "8.0",
      "cors": true,
      "alive": true,
      "alive_rate": 1.0,
      "last_updated": "2019-01-01",
      "service_description": true,
      "void": true,
      "metadata": 100.0,
      "ontology": 100.0,
      "links_to_other_datasets": [],
      "data_entry": 100000000,
      "support_html_format": true,
      "support_rdfxml_format": true,
      "support_turtle_format": true,
      "cool_uri": 100,
      "http_uri": true,
      "provide_useful_information": true,
      "link_to_other_uri": true,
      "execution_time": 1.000
    }
  }, ...
]
Retrieve Information of Filtered Endpoints

We can specify the conditions using URL parameters. Please see the table below for all parameters.

Example: Retrieve information of endpoints which name contains "Life" as follows:

curl -L -H 'Accept: application/json' https://d.umaka.dbcls.jp/api/endpoint/search?name=Life

Example: Retrieve information of endpoints which Umaka score is between 50 and 70 as follows:

curl -L -H 'Accept: application/json' https://d.umaka.dbcls.jp/api/endpoint/search?score_lower=50&score_upper=70

Example: Retrieve information of endpoints which alive rate is more than 75% as follows:

curl -L -H 'Accept: application/json' https://d.umaka.dbcls.jp/api/endpoint/search?alive_rate_lower=75

Example: Retrieve information of endpoints which has service description as follows:

curl -L -H 'Accept: application/json' https://d.umaka.dbcls.jp/api/endpoint/search?service_description=1
Parameter NameDescription
nameEndpoint which name contains the specified string.
resource_uriEndpoint which resource_uri contains the specified string as the following element_type.
dateThe result of searching is as of date specified yyyy-mm-dd string.
rankEndpoint which rank is specified value. This value must be one of A, B, C, D and E. Otherwise this conidition is ignored.
score_lowerEndpoint which Umaka score is more than or equal to the specified value.
score_upperEndpoint which Umaka score is less than or equal to the specified value.
alive_rate_lowerEndpoint which alive rate is more than or equal to the specified value.
alive_rate_upperEndpoint which alive rate is less than or equal to the specified value.
cool_uri_lowerEndpoint which Cool URI rate is more than or equal to the specified value.
cool_uri_upperEndpoint which Cool URI rate is less than or equal to the specified value.
ontology_lowerEndpoint which ontology score rate is more than or equal to the specified value.
ontology_upperEndpoint which ontology score rate is less than or equal to the specified value.
metadata_lowerEndpoint which metadata score rate is more than or equal to the specified value.
metadata_upperEndpoint which metadata score rate is less than or equal to the specified value.
service_descriptionEndpoint which has Service Description will be shown if this value is 1
voidEndpoint which has VoID will be shown if this value is 1
htmlEndpoint which supports HTML format will be shown if this value is 1
turtleEndpoint which supports Turtle format will be shown if this value is 1
xmlEndpoint which supports RDF+XML format will be shown if this value is 1