APIの使い方

生駒市オープンデータポータルサイトのAPIの利用方法

CKAN APIの使い方について

CKANからのリクエストは全てJSON形式で戻ります。

データセットの検索

条件を指定してデータセットの検索が可能です

例:「AED」を条件にデータセットを1件取得する

https://data.city.ikoma.lg.jp/data/api/3/action/package_search?q=AED&rows=1

上記からは下記の様な構造のJSON形式でのレスポンスを取得することが出来ます。検索結果のデータセット情報等は「result」に格納されています。 { "help": "https://data.city.ikoma.lg.jp/data/api/3/action/help_show?name=package_search", "success": true, "result": {...} }

データセット詳細情報を取得する

検索からデータセットを取得するだけではなく、取得したいデータセットのidやnameがわかっている場合は

個別に情報を取得することが可能です。

上記で取得した「AED」の検索結果に「AED設置場所一覧」があります。

その中の「id」の値を参照し「package_show」APIを使用して、データセット個別の詳細情報を取得することが出来ます

例:idが「067f5c21-bbc5-48e5-87ec-821d5c63aba5」(AED設置場所一覧)のデータセット情報を取得する

https://data.city.ikoma.lg.jp/data/api/3/action/package_show?id=067f5c21-bbc5-48e5-87ec-821d5c63aba5

リソースの詳細情報を取得する

データセットの検索を行いその中にあるリソースの情報についても個別に情報を取得することができます。

上記で取得した「AED設置場所一覧」のJSONに「resources」があります。

その中にある「AED設置場所_csv」の情報を個別に取得する場合にはデータセットと同様にリソースの「id」の値を使用します。

例:idが「2ed3acae-6552-4c4a-a6de-69259045ef3d」(AED設置場所_csv)のリソース情報を取得する

https://data.city.ikoma.lg.jp/data/api/3/action/resource_show?id=2ed3acae-6552-4c4a-a6de-69259045ef3d

 

その他詳細の使用方法はCKAN API公式ドキュメントをご参照ください。(英語のみ)

SPARQLエンドポイントの使い方について

生駒市ではVirtuosoを利用したRDFストアを公開しています。

生駒市RDFストアの情報はスパークルエンドポイントから「SPARQL」で取得可能です。

生駒市のスパークルエンドポイントのURL

https://data.city.ikoma.lg.jp/sparql

生駒市のスパークルエンドポイントのグラフURI

https://data.city.ikoma.lg.jp

SPARQLエンドポイントの使い方

スパークルエンドポイントに遷移すると「Virtuoso SPARQL Query Editor」というページが表示されます。

そのまま「Run Query」ボタンをクリックしてみて下さい。

「https://data.city.ikoma.lg.jp」グラフに登録されているデータの一覧が「HTML」形式で出力されます。

上記のデータは同じ画面にある「Results Format」を値を変更することで「JSON」や「RDF」形式での出力も可能です。

また画面からではなく直接URLを指定することで取得も可能です。

例:<https://data.city.ikoma.lg.jp>から5件の結果を取得する

https://data.city.ikoma.lg.jp/sparql?default-graph-uri=https%3A%2F%2Fdata.city.ikoma.lg.jp&query=select+%3Fs+%3Fp+%3Fo+where+%7B%3Fs+%3Fp+%3Fo.%7D+LIMIT+5&format=text%2Fhtml&timeout=0

 

生駒市の独自URIについて

本サイトで提供しているRDF項目についてはIMIの共通語彙基盤と生駒市独自のURIの両方を使用しています。

生駒市独自URIは下記となります。

http://data.city.ikoma.lg.jp/rdf/property

SPARQLについて

データの問い合わせは「SPARQL」という言語を利用します。

SPARQLの詳細はRDF用クエリ言語SPARQLをご参照ください。