APIリファレンス

はじめに

本章では、Meta BridgeのAPIの使い方についてについて解説します。

1.語彙取得APIを利用するには

本APIではメタデータ語彙の定義を取得することができます。

語彙定義取得APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
URL: http://www.metabridge.jp/infolib/metabridge/api/vocabulary

API利用例)
http://www.metabridge.jp/infolib/metabridge/api/vocabulary?graph={語彙定義URI}&format={出力フォーマット}&version={日付}
となります。

ex.) URI<http://purl.org/dc/elements/1.1/>の最新バージョンの語彙定義をTurtle形式で取得する
http://www.metabridge.jp/infolib/metabridge/api/vocabulary?graph=http://purl.org/dc/elements/1.1/&format=turtle
※該当する語彙定義がない場合は「Parameter Error!」となります。

パラメータ
パラメータ名 内容
graph※必須 取得する語彙定義URIを指定
format 出力フォーマット形式を指定
format=xml・・・・・RDF/XML形式で出力
format=turtle・・・・・Turtle形式で出力
format=topic・・・・・TopicMaps形式で出力
※指定なしの場合は、RDF/XML形式で出力
version 語彙定義URIのバージョンを指定
書式:YYYYMMDD
※指定なしの場合は、最新の語彙定義を取得


2.記述規則取得APIを利用するには

本APIではメタデータ記述規則の定義を取得することができます。

記述規則取得APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
URL: http://www.metabridge.jp/infolib/metabridge/api/description

API利用例)
http://www.metabridge.jp/infolib/metabridge/api/description?graph={記述規則URI}&format={出力フォーマット}&version={日付}
となります。

ex.) URI<http://iris.slis.tsukuba.ac.jp/dsp/mangametadata>の最新バージョンの記述規則をTurtle形式で取得する
http://www.metabridge.jp/infolib/metabridge/api/description?graph=http://iris.slis.tsukuba.ac.jp/dsp/mangametadata&format=turtle
※該当する語彙定義がない場合は「Parameter Error!」となります。

パラメータ
パラメータ名 内容
graph※必須 取得する記述規則URIを指定
format 出力フォーマット形式を指定
format=xml・・・・・RDF/XML形式で出力
format=turtle・・・・・Turtle形式で出力
format=topic・・・・・TopicMaps形式で出力
※指定なしの場合は、RDF/XML形式で出力
version 記述規則URIのバージョンを指定
書式:YYYYMMDD
※指定なしの場合は、最新の記述規則を取得


3.統制語彙取得APIを利用するには

本APIでは統制語彙の定義を取得することができます。

統制語彙取得APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
【RDF/XML形式】
URL: http://www.metabridge.jp/infolib/metabridge/show/controlledVocabulary/view/rdf
【Turtle形式】
URL: http://www.metabridge.jp/infolib/metabridge/show/controlledVocabulary/view/turtle
【JSON形式】
URL: http://www.metabridge.jp/infolib/metabridge/show/controlledVocabulary/view/json

API利用例)
http://www.metabridge.jp/infolib/metabridge/show/controlledVocabulary/view/rdf?uri={統制語彙URI}
となります。

ex.) URI<http://www.infocom.co.jp/sample-data>の統制語彙をTurtle形式で取得する
http://www.metabridge.jp/infolib/metabridge/show/controlledVocabulary/view/turtle?uri=http://www.infocom.co.jp/sample-data

パラメータ
パラメータ名 内容
uri※必須 取得する統制語彙URIを指定


4.DublinCore変換APIを利用するには

本APIではメタデータ記述規則のSimpleDCマッピングにより、RDF/XML形式のメタデータをDublinCore形式に変換します。

DublinCore変換APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
URL: http://www.metabridge.jp/infolib/metabridge/api/metadata

API利用例)
http://www.metabridge.jp/infolib/metabridge/api/metadata?graph={記述規則URI}&source={変換対象メタデータURI}
となります。

ex.) URI<http://iris.slis.tsukuba.ac.jp/dsp/mangametadata>の記述規則よりサンプルメタデータを変換する
http://www.metabridge.jp/infolib/metabridge/api/metadata?graph=http://iris.slis.tsukuba.ac.jp/dsp/mangametadata&source=http://www.metabridge.jp/samplefiles/sample_rdf2.rdf

パラメータ
パラメータ名 内容
graph※必須 記述規則URIを指定
source※必須 変換対象のメタデータURI(RDF/XML)を指定


5.メタデータ変換APIを利用するには

本APIでは「RDF形式」又は「CSV形式」のメタデータから、異なる構造の「RDF形式」メタデータに変換することができます。

メタデータ変換APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
【RDF形式から異なる構造のRDF形式へのメタデータ変換】
URL: http://www.metabridge.jp/infolib/metabridge/api/rdf2rdf/change
【CSV形式からRDF形式へのメタデータ変換】
URL: http://www.metabridge.jp/infolib/metabridge/api/csv2rdf/change

API利用例)
http://www.metabridge.jp/infolib/metabridge/api/rdf2rdf/change?src={変換元データURI}&map={マッピング定義URI}&format={出力フォーマット}
となります。

ex.) 【RDF形式から異なる構造のRDF形式へのメタデータ変換】
http://www.metabridge.jp/infolib/metabridge/api/rdf2rdf/change?src=http://www.metabridge.jp/samplefiles/sample_rdf2rdf.ttl
&map=http://www.metabridge.jp/api/map/sabae/zoo/rdf2rdf&format=rdf%2bxml

※パラメータはUTF-8でエンコードしています。

ex.) 【CSV形式からRDF形式へのメタデータ変換】
http://www.metabridge.jp/infolib/metabridge/api/csv2rdf/change?src=http://www.metabridge.jp/samplefiles/sample_csv2rdf.csv
&map=http://www.metabridge.jp/api/map/sabae/zoo/csv2rdf&format=turtle

パラメータ【RDF形式から異なる構造のRDF形式へのメタデータ変換】
パラメータ名 内容
src※必須 変換元データURIを指定
※RDF形式からRDF形式への変換の場合は、RDFファイルを指定。
※変換元データはUTF-8のみ利用可能です。
※変換元データのサイズは最大5MB(5,242,880 byte)まで利用可能です。
※変換元データURIはHTTPのみ対応しています。
map※必須 マッピング定義URIを指定
※Meta Bridgeにて登録したマッピング定義URIを指定できます。
マッピング定義URIの登録方法についてはこちらを参照ください。
※変換元データURIはHTTPのみ対応しています。
format 出力フォーマット形式を指定
format=rdf+xml・・・・・RDF/XML形式で出力
format=turtle・・・・・Turtle形式で出力
format=json・・・・・JSON形式で出力
※指定なしの場合は、RDF/XML形式で出力
パラメータ【CSV形式からRDF形式へのメタデータ変換】
パラメータ名 内容
src※必須 変換元データURIを指定
※CSV形式からRDF形式への変換の場合は、CSVファイルを指定。
※変換元データはUTF-8もしくはSHIFT-JISのみ利用可能です。
※変換元データのサイズは最大5MB(5,242,880 byte)まで利用可能です。
※CSVデータの1行目はヘッダ行とみなし、メタデータ変換されません。
※変換元データURIはHTTPのみ対応しています。
map※必須 マッピング定義URIを指定
※Meta Bridgeにて登録したマッピング定義URIを指定できます。
マッピング定義URIの登録方法についてはこちらを参照ください。
※変換元データURIはHTTPのみ対応しています。
format 出力フォーマット形式を指定
format=rdf+xml・・・・・RDF/XML形式で出力
format=turtle・・・・・Turtle形式で出力
※指定なしの場合は、RDF/XML形式で出力


6.SPARQL-APIを利用するには

本APIではRDFストアに登録したデータをSPARQL検索し、検索結果を取得することができます。

SPARQL-APIのURL
APIのURLは、下記の通りです。URLにパラメータを付与して利用することができます。
【ログインユーザのみ】URL: http://www.metabridge.jp/api/sparql/G0000138mb
【URLを知っている全員で利用する】URL: http://www.metabridge.jp/api/sparql/G0000138mb?lu=(トークン文字列)

API利用例)
http://www.metabridge.jp/api/sparql/G0000138mb?operation={オペレーション}&query={SPARQLクエリ}&format={返戻形式名}
となります。

ex.) ユーザが登録したGRAPH<http://infocom.sample/>から100件を取得する
http://www.metabridge.jp/api/sparql/G0000138mb?lu=hlqaashwayimqzwmtzoq&operation=search
&query=select%20*%20where%20%7B?s%20?p%20?o%7D&maxrows=100
&default-graph-uri=http://infocom.sample/&timeout=2000&format=html

※パラメータはUTF-8でエンコードしています。

パラメータ
パラメータ名 内容
lu 認証なしで利用するためのトークン文字列を指定します
operation 固定値: search / explain
例)operation=search
count 総件数の取得 取得する場合は「count=true」としてください。
※指定がある場合は総件数のみ返戻されます。
http://www.metabridge.jp/api/sparql/G0000138mb?operation=search&query=select%20*%20where%20{?s%20?p%20?o}&format=html&count=true
query(必須) SPARQLクエリを指定します。
URLエンコード(UTF-8)されている必要があります。
例)
URLエンコード前:select * where {?s ?p ?o}

URLエンコード後:select%20*%20where%20{?s%20?p%20?o}
maxrows SPARQL結果の出力件数を指定します。
例)maxrows=1
default-graph-uri Default graph URI を指定
例)default-graph-uri=http://www.metabridge.jp/graph
※default-graph-uriはqueryのfrom句に相当します。queryのfrom句とdefault-graph-uriをどちらも指定された場合は両方のGRAPHが検索対象となります。
timeout SPARQLクエリ実行時のタイムアウト値をミリ秒単位で指定できます。 1000未満の値は無視されます。
例)timeout=2000
format 返戻形式名
※下記種類が指定可能です。
n3/turtle、rdf/xml、 n-triples、csv 、 tsv、 html 、 spreadsheet 、 xml、 json 、 javascript
例)format=rdf/xml
※指定がない、または上記以外を指定した場合は「xml」形式で返戻されます。