Yummydata logo background 4a62501819042828d626320d5b62f9d0f5263e1ce6565617e0edabc51d244235

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 'http://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 -i http://d.umaka.dbcls.jp/api/endpoints/search

This return the list of information of endpoints as follows:

[
   {
      "id": 1,
      "name": "Allie",
      "url": "http://data.allie.dbcls.jp/sparql",
      "created_at": "2016-03-23T12:13:39.547+09:00",
      "updated_at": "2016-03-23T12:13:39.547+09:00",
      "issue_id": 5,
      "description_url": null,
      "evaluation": {
        "id": 1,
        "endpoint_id": 1,
        "latest": true,
        "alive": true,
        "alive_rate": 100.0,
        "response_header": "date: Tue, 29 Mar 2016 13:03:43 GMT\n --snip-- ",
        "service_description": "@prefix rdf:\t .\n@prefix ns1:\t .\n --snip-- ",
        "void_uri": "http://data.allie.dbcls.jp/.well-known/void",
        "void_ttl": "@prefix dc:     .\n --snip-- .\n",
        "subject_is_uri": true,
        "subject_is_http_uri": true,
        "uri_provides_info": true,
        "contains_links": true,
        "score": 77,
        "rank": 4,
        "created_at": "2016-03-29T22:08:26.700+09:00",
        "updated_at": "2016-03-29T22:08:26.700+09:00",
        "cool_uri_rate": 75,
        "support_content_negotiation": true,
        "support_turtle_format": true,
        "support_xml_format": false,
        "support_html_format": true,
        "execution_time": 0.06357,
        "metadata_score": 25.5952380952381,
        "ontology_score": 28.5034013605442,
        "last_updated": "2016-03-29",
        "last_updated_source": "Adhoc",
        "update_interval": 6,
        "number_of_statements": 143196406,
        "support_graph_clause": true,
        "supported_language": "[\"SPARQL11Query\"]",
        "linksets": "[\"http://dbpedia.org\", \"http://lifesciencedb.jp/bdls/\", \"http://lsd.dbcls.jp/portal/\"]",
        "license": "[\"http://creativecommons.org/licenses/by/2.1/jp/\"]",
        "publisher": "[\"http://uri.dbcls.rois.ac.jp/\"]",
        "retrieved_at": "2016-03-23T00:00:00.547+09:00",
        "crawl_log_id": 1
      }
    },
    ...
  ]
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 -i http://d.umaka.dbcls.jp/api/endpoints/search?name=Life

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

curl -i http://d.umaka.dbcls.jp/api/endpoints/search?score_lower=50&score_upper=70

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

curl -i http://d.umaka.dbcls.jp/api/endpoints/search?alive_rate_lower=75

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

curl -i http://d.umaka.dbcls.jp/api/endpoints/search?service_description=1
Parameter Name Description
name Endpoint which name contains the specified string.
prefix Endpoint which prefix contains the specified string.
prefix_filter_uri Endpoint which prefix_filter_uri contains the specified string as the following element_type.
element_type element_type is subject or object.
date The result of searching is as of date specified %d-%m-%Y string.
score_lower Endpoint which Umaka score is more than or equal to the specified value.
score_upper Endpoint which Umaka score is less than or equal to the specified value.
alive_rate_lower Endpoint which alive rate is more than or equal to the specified value.
alive_rate_upper Endpoint which alive rate is less than or equal to the specified value.
rank Endpoint which rank is specified value. This value must be one of A, B, C, D and E. Otherwise this conidition is ignored.
cool_uri_rate_lower Endpoint which Cool URI rate is more than or equal to the specified value.
cool_uri_rate_upper Endpoint which Cool URI rate is less than or equal to the specified value.
ontology_lower Endpoint which ontology score rate is more than or equal to the specified value.
ontology_upper Endpoint which ontology score rate is less than or equal to the specified value.
metadata_lower Endpoint which metadata score rate is more than or equal to the specified value.
metadata_upper Endpoint which metadata score rate is less than or equal to the specified value.
service_description Endpoint which has service description will be shown if this value is 1
content_negotiation Endpoint which supports content negotiation will be shown if this value is 1
html Endpoint which supports HTML format will be shown if this value is 1
turtle Endpoint which supports Turtle format will be shown if this value is 1
xml Endpoint which supports RDF+XML format will be shown if this value is 1