Dataset API 2.5.1版即刻推出,本版本僅作小幅度修改。細部更動見於文件中。
簡介
本文件由農業部生物多樣性研究所編製,描述所屬台灣生物多樣性網絡(Taiwan Biodiversity Network,TBN)之資料集(dataset)開放API規格。
服務類型
本API提供查詢TBN資料集之服務。
查詢參數
參數型態
- 時間:字串,格式為西元10碼+24小時制精度至分之5碼格式,即YYYY-MM-DD HH:MM,台灣時區
- UUID:字串,RFC 4122,需含斷字符號共36個字元
- 文字
參數名 | 參數中文名 | 型態 | 說明 | 範例網址 |
---|---|---|---|---|
UUID | 資料集UUID | UUID | TBN資料集UUID | https://www.tbn.org.tw/api/v25/dataset?uuid=248d6799-bb66-40a5-b7ba-b45bbb818ddc |
name | 資料集名 | 文字 | 支援部分查詢 | |
modified | 最後修改時間 | 時間 | 格式 YYYY-MM-DD HH:II,包含指定時間後詮釋資料有修改的資料集 | https://www.tbn.org.tw/api/v25/dataset?modified=2021-02-10 23:00 |
複合查詢
各查詢參數均可做聯集查詢。如以下網址查詢資料集名稱包含"tbn"中詮釋資料最後修改時間為"2022年2月17日晚上11:00"的資料集
https://www.tbn.org.tw/api/v25/dataset?name=tbn&modified=2022-02-17 23:00
回傳範例:
{
"meta": {
status: "SUCCESS",
total: 6,
itemsCount: 6,
generateDate: "2022-03-08T15:20:43+08:00"
},
"links": {
self: "https://www.tbn.org.tw/api/v25/dataset?name=tbn&modified=2022-02-17%2023%3A00",
next: ""
},
"data": [
{
"datasetName": "TBN-DP 台灣爬行類回報",
"datasetTaxonGroup": "爬蟲類",
"datasetLicense": "政府資料開放授權條款-第1版",
"datasetPublisher": "農業部生物多樣性研究所",
"datasetAuthor": "林德恩、陳惇聿、倪旻萱、郭貴嵐",
"datasetUUID": "e1b7adf8-9315-4134-aced-729a09da40f6",
"datasetURL": "https://www.tbn.org.tw/dataset/e1b7adf8-9315-4134-aced-729a09da40f6",
"datasetDataFrom": "TBN研管中心",
"GBIFdatasetkey": "",
"datasetMetadataLastModified": "2022-03-09T17:30:01Z",
"datasetDateCoverage": "2004-01-17 ~ 2022-03-09",
"occurrenceCount: "6332",>
},
...
]
}
資料欄位
JSON欄位名
- 欄位名 (JSON field name) 均為羅馬字英文字母,大小寫不同,範圍為[a-zA-Z]。
- 欄位名命名採首字小寫駝峰式 (Camel) 命名法。
資料型態與允許值
- UUID:字串,RFC 4122,需含斷字符號共36個字元
- 文字
- 列舉:為規定值之一
- 允許多值時,多值以半形分號;分隔
- 無資料時回傳null
回傳欄位表
API欄位名 | 中文欄位名 | 型態 | 值與說明 |
---|---|---|---|
datasetName | 資料集名 | 文字 | |
datasetTaxonGroup | 含括類群 | 文字 | |
datasetLicense | 授權 | 列舉 | [CC0, CC BY, CC BY-NC, OGDL-Taiwan-1.0] |
datasetPublisher | 發布者 | 文字 | 資料集發布單位 |
datasetAuthor | 作者 | 文字 | 資料集作者 |
datasetUUID | 資料集UUID | UUID | TBN資料集UUID |
datasetURL | 網址 | 文字 | URL |
datasetDataFrom | 資料來源 | 文字 | |
GBIFdatasetkey | GBIFdatasetkey | UUID | v2.5.1新增 |
datasetModified | 最後修改時間 | 時間 | YYYY-MM-DD HH:MM |
datasetDateCoverage | 含括時間 | 文字 | 精度至日 |
occurrenceCount | 觀測紀錄數 | 數字 |