JBIF:地球規模生物多様性 情報機構日本ノード

このAPIは、GBIFチェックリスト・バンク(Checklist Bank)に格納しているデータを対象とします。このバンクは、GBIFネットワークにある全登録チェックリスト・データセットに対して、分類学的なインデクス付けを行います。

チェックリスト・データセットに関する統計データについては、登録APIのデータセット・メトリクスの箇所を参照してください。

プログラム内ではJava Webサービスクライエントを用いて、HTTPベースREST対応ウェブサービスを提供しています。APIのコードを書く人の中には、関心のある方もいると思われます。checklistbank-ws-client projectのページに詳細があります。

・各機能メニュー

名称用例の検索  名称検索  名称パース機能  クエリ・パラメータの解説

名称用例の検索

名称用例とは、特定のチェックリストで学術名が使われている使用方法を言います。チェックリストには、GBIFバックボーンタクソノミーも含みます。GBIFバックボーンタクソノミーは、このAPIにおいては、nub(「骨子」の意味)と呼ばれています。GBIFバックボーンタクソノミーの分類名を使っている他のチェックリストにおける名称の用例には、taxonKeyが付けられ、バックボーンタクソノミーにおける用例との関連づけが行われます。

リソースURL メソッド レスポンス 説明 ページング パラメータ
/species GET NameUsage Page 全チェックリストにおける名称用例を表示 true language, datasetKey, sourceId, name
/species/root/{uuid|shortname} GET NameUsage Page NameUsage Page true
/species/{int} GET NameUsage 単一の名称用例を取得 false language
/species/{int}/verbatim GET VerbatimNameUsage 報告者による名称用例(verbatim name usage)を取得 false
/species/{int}/name GET ParsedName 名称用例に対する解析名称(parsed name)を取得 false
/species/{int}/parents GET NameUsage List 名称用例に対する子用法(child usage)を全て表示 true language
/species/{int}/related GET NameUsage List 他のチェックリストにおける関連名称用例を全て表示 false language, datasetKey
/species/{int}/synonyms GET NameUsage Page 名称用例に対する同義語を全て表示 true language
/species/{int}/combinations GET NameUsage List 当該用例をバシオニム(基礎異名)とする組合せを全て表示 false
/species/{int}/descriptions GET Description Page 名称用例に対する説明を全て表示 true
/species/{int}/distributions GET Distribution Page 名称用例に対する分布データを全て表示 true
/species/{int}/media GET Media Page 名称用例に対するメディア項目を全て表示 true
/species/{int}/references GET Reference Page 名称用例に対する参照を全て表示 true
/species/{int}/speciesProfiles GET peciesProfile Page 名称用例に対する種プロファイルを全て表示 true
/species/{int}/vernacularNames GET VernacularName Page 名称用例に対する俗称名を全て表示 true
/species/{int}/typeSpecimens GET TypeSpecimen Page 名称用例に対するタイプ標本を全て表示 true

GBIFには、4種類の方法により、名称用例を検索することができます。それぞれ、照合動作、レスポンス形式および実際に対象とするコンテンツが異なります。

リソースURL メソッド レスポンス 説明 ページング パラメータ
/species GET NameUsage Page 全チェックリスト又は同じ正式名が使われているチェックリストにおける名称用例を表示。命名者を問わない。 true language, datasetKey, sourceId, name
/species/match GET NameUsage Page GBIFバックボーンタクソノミーに対して、学術名のファジー照合を行う。オプションとして、分類区分(classification)を選択することができる。分類区分を選択し、strictをtrueに設定しない場合であって、当該名称パラメータに正確にマッチするデータがない場合、分類区分に対しても照合を行うようにデフォルト設定されている。 false rank, name, strict, verbose, kingdom, phylum, class, order, family, genus
/species/search GET NameUsage Page 全チェックリスト又は一部のチェックリストにおける名称用例に関し、学術名、俗称名、種の説明、分布および全分類区分を対象として、名称用例のフルテキスト検索を行う。この検索では通常の場合多数の結果が返されるため、結果は、関連性の高い順に表示される。 true q, datasetKey, rank, highertaxonKey, status, isExtinct, habitat, threat, nameType, nomenclaturalStatus, hl, facet, facetMincount, facetMultiselect
/species/suggest GET NameUsage Page 学術名に対して、オートコンプリート機能により、名称用例のプレフィックス照合を迅速に行い、最大20件の結果を表示。結果は、関連性の高い順に表示される。 false q, datasetKey, rank

名称パース機能

GBIFでは、APIによりJava形式の名称パーサライブラリを公開しています。この機能では、単純文字列からなる学術名(一または複数)に基づいて、パーシングを行い、パース処理した名称のリストを返します。

リソースURL メソッド レスポンス 説明 ページング パラメータ
/parser/name GET ParsedName List 学術名の文字列をパースし、ParsedNameバージョンを返す。一つの名称からなる複数のパラメータが使える。名称を正確にURLエンコードすること。 false name
/parser/name POST ParsedName List 以下のメディアタイプでエンコードした名称文字列から構成されるリストをパース処理する。
文字列のJSON配列
plain/text形式のコンテンツ
multipart/form-data 形式でアップロードしたプレーンテキストファイル
テキストファイルは、全てUTF8形式にエンコードし、学術名を一行に一つずつ書き込む。Unix用改行コード(\n)を使用すること。
false name

クエリ・パラメータの解説

上記の種APIには、以下のパラメータを使うことができます。

パラメータ 説明
class 正式名称が使われている綱分類を表示するオプション
datasetKey チェックリスト・データセットキー(UUID)により、フィルタリングを行う。
facet ファセット検索により、当該フィールドで頻度の高い順に100件の結果を表示する。使用可能なファセット検索項目は、以下のとおり。
datasetKey、higherTaxonKey、rank、status、isExtinct、habitatおよびnameType。この他、threatおよびnomenclaturalStatusも正式なパラメータであるものの、現在のところ未対応であるため、戻り値が表示されない。
facetMincount ファセット・パラメータと一緒に使用する。facetMincount={#}と設定すると、件数が{#}未満のファセットは除外される。すなわち、/search?facet=type&limit=0&facetMincount=10000では、type値が'CHECKLIST' および'METADATA'である件数はそれぞれ10000未満であることから、 'OCCURRENCE'のみ表示される。
facetMultiselect ファセット・パラメータと一緒に使用する。facetMultiselect=trueと設定することにより、フィルタリングの対象となっていない変数値に対する件数が戻される。すなわち、/search?facet=type&limit=0&type=CHECKLIST&facetMultiselect=trueでは、type=CHECKLISTによりフィルタリングを行っているにも関わらず、type値が'OCCURRENCE' および'METADATA'である結果も表示される。
family 正式名称が使われている科分類を表示するオプション
genus 正式名称が使われている属分類を表示するオプション
habitat 生息地によりフィルタリングを行う。現在のところ、主要3バイオームのみHabitat enumで使用可能。
highertaxonKey リンネ式分類法の上位階層キーによりフィルタリングを行う。フィルタリングは、それぞれのチェックリストに対して行われ、GBIFバックボーンタクソノミーのキーを全チェックリストに対して検索するものではないことに留意すること。
hl hl=trueと設定することにより、フルテキスト検索のクエリに該当する用語をハイライト表示する。ハイライトは、’gbifH1’クラスの強調タグによる。例えば、/search?q=plant&hl=trueを参照のこと。フルテキスト検索フィールドには、以下のものがある:タイトル、キーワード、国名、公開国名、公開機関名、ホスト機関名および説明。メタデータ文書の情報を含むフルテキスト・フィールドに対して、追加的に検索が行われるが、このフィールドのテキストは、結果には表示されない。
isExtinct 絶滅状態(ブール値、isExtinct=true等)でフィルタリングする。
kingdom 正式名称が使われている界分類を表示するオプション
language default=en(英語)である。これ以外の場合には、HTTPヘッダを用いる。
name 正式名称の文字列に対するフィルタとして使用する学術名(’Puma concolor’等)又は名称パーサに対する入力値として使用する学術名を指定する。
nameType 名称のタイプによりフィルタリングを行う。詳細は、NameType enumを参照のこと。
nomenclaturalStatus 現在は未対応であるが、将来的には、命名状況の列挙型に基づいてフィルタリングが可能になる予定。
order 正式名称が使われている目分類を表示するオプション
phylum 正式名称が使われている門分類を表示するオプション
q 単純フルテキスト検索用パラメータである。このパラメータが取る値は、単語または語句である。ワイルドカードには、対応していない。
rank 分類階層によりフィルタリングを行う。詳細は、Rank enumを参照のこと。
sourceId ソース識別子によりフィルタリングを行う。
status 分類状況によりフィルタリングを行う。詳細は、TaxonomicStatus enumを参照のこと。
strict strict=trueの場合には、指定の名称に関してのみファジー照合を行い、上位階層のタクソンは、対象としない。
threat 現在は未対応であるが、将来的には、危惧状態の列挙型に基づいてフィルタリングが可能になる予定。
verbose verbose=trueと設定すると、マッチの可能性ありと判断されたものの、その後排除された項目を表示する。