跳到主要內容

資料集詮釋資料API開發指引

本平臺開放資料提供資料集詮釋資料API供開發人員取得及使用

 

取得分類群組清單

一、使用說明:
使用API取得平臺上符合條件之資料集分類編號(categoryCode)

 

二、介接網址:

/api/v1/rest/group?limit={limit}&offset={offset}

{limit}:限制最多回傳的資料筆數。預設值: 100

{offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

 

三、輸入範例:

範例1:/api/v1/rest/group

範例2:/api/v1/rest/group?limit=5&offset=0

 

四、檔案格式:JSON

 

五、備註:

1. 分類編號(categoryCode)為電子化政府入口網提供的分類選項之服務分類編號3碼18 類(服務分類第1層)。

2. 此輸出範例的分類編號相等於資料集詮釋資料之分類編號。

 

取得群組相關的資料集編號
一、使用說明:

使用API取得平臺上符合條件之群組相關的資料集編號

 

二、介接網址:

/api/v1/rest/group/{categoryCode}

{categoryCode}:分類編號

 

三、輸入範例:

範例1:/api/v1/rest/group/E00

 

四、檔案格式:JSON

categoryCode:群組的分類編號

display_name:用來顯示的分類群組名稱

description:描述分類群組詳細內容

package_count:群組內資料集數量

created:建立日期

packages:群組內資料集編號清單

 

五、備註:

1. 分類編號(categoryCode)為電子化政府入口網提供的分類選項之服務分類編號3碼18 類(服務分類第1層)。

2. 此資源路徑categoryCode相等於資料集詮釋資料之分類編號。

3. categoryCode可經由「取得分類群組清單」API項目來取得。

4. 輸出範例的資料集編號相等於資料集詮釋資料之資料集編號。

 

取得標籤清單
一、使用說明:

使用API取得平臺上符合條件之標籤清單

 

二、介接網址:

/api/v1/rest/tag?limit={limit}&offset={offset}

{limit}:限制最多回傳的資料筆數。預設值: 100

{offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

 

三、輸入範例:

範例1:/api/v1/rest/tag

範例2:/api/v1/rest/tag?limit=5&offset=0

 

四、檔案格式:JSON

 

五、備註:

1. 標籤(tag)為各業務機關紀錄於資料集詮釋資料中的標籤/關鍵字(keyword)。

 

取得標籤相關的資料集編號
一、使用說明:

使用API取得平臺上符合條件之標籤相關的資料集編號

 

二、介接網址:

/api/v1/rest/tag/{tagName}?limit={limit}&offset={offset}

{tagName}:標籤

{limit}:限制最多回傳的資料筆數。預設值: 100

{offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

 

三、輸入範例:

範例1:/api/v1/rest/tag/監測

範例2:/api/v1/rest/tag/監測?limit=5&offset=0

 

四、檔案格式:JSON

 

五、備註:

1. 標籤(tag)為各業務機關紀錄於資料集詮釋資料中的標籤/關鍵字(keyword)。

2. tagName可經由「取得標籤清單」API項目來取得。

 

取得資料集編號清單
一、使用說明:

使用API取得平臺上符合條件之資料集編號清單

 

二、介接網址:

/api/v1/rest/dataset?modified={modified}&limit={limit}&offset={offset}

{modified}:日期, 詮釋資料最後更新時間大於或等於輸入之查詢條件。若無輸入,則傳回所有資料集編號清單。日期格式為 yyyy-MM-dd HH:mm:ss

{limit}:限制最多回傳的資料筆數。

{offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。

 

三、輸入範例:

範例1:/api/v1/rest/dataset

範例2:/api/v1/rest/dataset?limit=5&offset=0

 

四、檔案格式:JSON

 

五、備註:

1. 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼。

2. 輸出內容之資料集編號相等於資料集詮釋資料的資料集編號。

 

取得資料集詮釋資料
一、使用說明:

使用API取得平臺上符合條件之資料集詮釋資料

 

二、介接網址:

/api/v1/rest/dataset/{identifier}

{identifier}:資料集編號

 

三、輸入範例:

範例1:/api/v1/rest/dataset/A41000000G-000001

 

四、檔案格式:JSON

 

五、備註:

1. 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼。相等於資料集詮釋資料的資料集編號。

2. 資源路徑之資料集編號可以從「取得資料集標號清單」、「取得群組相關的資料集編號」、「取得標籤相關的資料集編號」等API項目中取得。

3. 若不輸入{identifier}參數,則請詳見「取得資料集編號清單」的說明。