{"swagger":"2.0","info":{"description":"桃園市政府資料開放平台提供『資料集詮釋資料API』和『資料資源內容API』供開發人員取得及使用。\n\n 本開發指南說明各API操作方法。\n\n ","version":"V1","title":"TYCG OPEN DATA API"},"host":"data.tycg.gov.tw","basePath":"/","tags":[{"name":"Dataset","description":"資料集"},{"name":"Datastore","description":"資料資源"},{"name":"Format","description":"格式"},{"name":"Group","description":"分類"},{"name":"Organize","description":"資料集管理機關"},{"name":"Tag","description":"標籤"}],"schemes":["https"],"paths":{"/api/v1/dump/datastore/{rid}":{"get":{"tags":["Datastore"],"summary":"下載資料集之資料資源全部內容","description":"\n        * 使用API取得平臺上符合條件之資料資源全部內容\n\n        * 資料資源編碼{resource ID}為各資料資源之識別碼，一個資料集可有多個資料資源，各個資料資源只有一個資料資源編碼\n\n        * {resource ID}為必填的路徑名稱，參數則為選擇性填寫","operationId":"dumpDatastoreByResourceID","produces":["*/*","application/octet-stream"],"parameters":[{"name":"rid","in":"path","description":"資料資源編號","required":true,"type":"string"}],"responses":{"200":{"description":"OK"}}}},"/api/v1/rest/dataset":{"get":{"tags":["Dataset"],"summary":"取得資料集編號清單","description":"\n        * 使用API取得平臺上符合條件之資料集編號清單\n\n        * 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼\n\n        * 輸出內容之資料集編號相等於資料集詮釋資料的資料集編號","operationId":"listDatasetId","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"modified","in":"query","description":"日期\n詮釋資料最後更新時間大於或等於輸入之查詢條件\n若無輸入則傳回所有資料集編號清單\n日期格式為 yyyy-MM-dd HH:mm:ss","required":false,"type":"string","format":"date-time"},{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":2000,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/dataset/{identifier}":{"get":{"tags":["Dataset"],"summary":"取得資料集詮釋資料","description":"\n        * 使用API取得平臺上符合條件之資料集詮釋資料\n\n        * 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼，相等於資料集詮釋資料的資料集編號\n\n        * 資源路徑之資料集編號可以從「取得資料集標號清單」、「取得群組相關的資料集編號」、「取得標籤相關的資料集編號」等API項目中取得\n\n        * 若不輸入{identifier}參數，則請詳見「取得資料集編號清單」的說明","operationId":"getDatasetById","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"identifier","in":"path","description":"資料集編號","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Dataset"}}}}},"/api/v1/rest/datasetInfo":{"get":{"tags":["Dataset"],"summary":"取得資料狀態資訊","description":"\n        * 針對所有上架中資料集之資料資源狀態以及其資料品質自動檢核結果","operationId":"listDatasetInfo","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"oid","in":"query","description":"資料集識別碼","required":false,"type":"string"},{"name":"rid","in":"query","description":"資料資源識別碼","required":false,"type":"string"},{"name":"datasetTitle","in":"query","description":"資料集名稱","required":false,"type":"string"},{"name":"organize","in":"query","description":"資料集提供機關名稱","required":false,"type":"string"},{"name":"intfc","in":"query","description":"是否為透過介接取得之資料","required":false,"type":"boolean"},{"name":"quality","in":"query","description":"資料資源品質星等值(1~3)","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":200,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DatasetInfo"}}}}},"/api/v1/rest/datastore/{rid}":{"get":{"tags":["Datastore"],"summary":"取得資料集之資料資源內容","description":"\n        * 使用API取得平臺上符合條件之資料資源內容\n\n        * 資料資源編碼{resource ID}為各資料資源之識別碼，一個資料集可有多個資料資源，各個資料資源只有一個資料資源編碼\n\n        * {resource ID}為必填的路徑名稱，參數則為選擇性填寫\n\n        * 資料資源內容可連結至一般檔案或資料庫表格，此API為取得資料庫表格內容，並非取得一般檔案","operationId":"getResourceByResourceId","produces":["*/*","text/xml;charset=UTF-8","application/json;charset=UTF-8","text/html;charset=UTF-8"],"parameters":[{"name":"rid","in":"path","description":"資料資源編號","required":true,"type":"string"},{"name":"q","in":"query","description":"資料資源所有內容之全文檢索字串","required":false,"type":"string"},{"name":"sort","in":"query","description":"排序資料資源之欄位名稱\n可多欄位排序，使用半形逗號「,」隔開，範例：sort=EngFiled1,EngFiled2\n可遞增或遞減排序，使用空白隔開，範例：sort=EngFiled1 desc,EngFiled2 asc","required":false,"type":"string"},{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":100,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"},{"name":"format","in":"query","description":"指定來源格式","required":false,"type":"string","default":"JSON","enum":["JSON","XML","CSV"]}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/api/v1/rest/format":{"get":{"tags":["Format"],"summary":"取得資料格式清單","description":"\n        * 使用API取得平臺上符合條件之資料資源格式清單","operationId":"listFormat","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":2000,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/format/{format}":{"get":{"tags":["Format"],"summary":"取得資料格式相關之資料集編號","description":"\n        * 使用API取得平臺上符合條件之資料格式相關的資料集編號","operationId":"getPackageByFormat","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"format","in":"path","description":"資料格式","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/group":{"get":{"tags":["Group"],"summary":"取得分類群組清單","description":"\n        * 使用API取得平臺上符合條件之資料集分類編號(categoryCode)","operationId":"listGroupId","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":2000,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/group/{categoryCode}":{"get":{"tags":["Group"],"summary":"取得群組相關之資料集編號","description":"\n        * 使用API取得平臺上符合條件之群組相關的資料集編號\n\n        * 分類編號(categoryCode)為通用唯一識別碼，分別對應到電子化政府入口網提供的分類選項之服務分類編號3碼18 類(服務分類第1層)\n\n        * 此輸出範例的分類編號相等於資料集詮釋資料之分類編號\n \n        * categoryCode可經由「取得分類群組清單」API項目來取得\n\n        * 輸出範例的資料集編號相等於資料集詮釋資料之資料集編號","operationId":"getPackageByCategortCode","produces":["*/*","application/json;charset=UTF-8"],"parameters":[{"name":"categoryCode","in":"path","description":"分類編號","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Group"}}}}},"/api/v1/rest/organize":{"get":{"tags":["Organize"],"summary":"取得資料集管理機關清單","description":"\n        * 使用API取得平臺上符合條件之資料集管理機關清單清單","operationId":"getOrganizeListUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":2000,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/organize/{organizeId}":{"get":{"tags":["Organize"],"summary":"取得資料集管理機關相關之資料集編號","description":"\n        * 使用API取得平臺上符合條件之資料集管理機關相關的資料集編號","operationId":"getPackageByOrganizeIdUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"organizeId","in":"path","description":"資料集管理機關ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/tag":{"get":{"tags":["Tag"],"summary":"取得標簽清單","description":"\n        * 使用API取得平臺上符合條件之標籤清單\n\n        * 標籤(tag)為各業務機關紀錄於資料集詮釋資料中的標籤/關鍵字(keyword)","operationId":"listTagId","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"limit","in":"query","description":"限制最多回傳的資料筆數","required":false,"type":"integer","default":2000,"format":"int32"},{"name":"offset","in":"query","description":"指定從第幾筆後開始回傳,可與limit配合使用達到分頁目的","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v1/rest/tag/{tagName}":{"get":{"tags":["Tag"],"summary":"取得標籤相關之資料集編號","description":"\n        * 使用API取得平臺上符合條件之標籤相關的資料集編號\n\n        * 標籤(tag)為各業務機關紀錄於資料集詮釋資料中的標籤/關鍵字(keyword)\n\n        * tagName可經由「取得標籤清單」API項目來取得","operationId":"getPackageByTag","produces":["*/*","application/json;charset=UTF-8"],"parameters":[{"name":"tagName","in":"path","description":"標籤","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}}},"definitions":{"Dataset":{"type":"object","properties":{"accrualPeriodicity":{"type":"string","description":"更新頻率"},"categoryCode":{"type":"array","description":"分類編號","items":{"type":"string"}},"description":{"type":"string","description":"資料集描述"},"distribution":{"type":"array","items":{"$ref":"#/definitions/Resource"}},"fieldDescription":{"type":"string","description":"主要欄位說明"},"identifier":{"type":"string","description":"資料集編號"},"landingPage":{"type":"string","description":"資料集說明網址"},"language":{"type":"string","description":"資料集語系"},"modified":{"type":"string","format":"date-time","description":"最後更新時間"},"numberOfData":{"type":"string","description":"資料量"},"organization":{"type":"string","description":"資料提供機關"},"organizationContactEmail":{"type":"string","description":"資料集所屬管理機關聯絡人電子郵件"},"organizationContactName":{"type":"string","description":"資料集所屬管理機關聯絡人"},"organizationContactPhone":{"type":"string","description":"資料集所屬管理機關聯絡人電話"},"spatial":{"type":"string","description":"資料集空間範圍"},"temporalCoverageFrom":{"type":"string","description":"收錄期間(起)"},"temporalCoverageTo":{"type":"string","description":"收錄期間(訖)"},"title":{"type":"string","description":"資料集名稱"},"type":{"type":"string","description":"資料集類型"}},"title":"Dataset"},"DatasetInfo":{"type":"object","properties":{"columndesc":{"type":"boolean","example":false,"description":"詮釋資料中之欄位描述與資料資源內之欄位結構是否相符"},"dataset":{"type":"string","description":"資料集名稱"},"datasetid":{"type":"string","description":"資料集之識別碼(ID)"},"downloadable":{"type":"boolean","example":false,"description":"資料資源可下載與否"},"encoding":{"type":"boolean","example":false,"description":"詮釋資料中之編碼描述與資料資源編碼是否相符"},"entity":{"type":"string","description":"資料集提供機關之名稱"},"intfc":{"type":"boolean","example":false,"description":"是否為透過介接取得之資料"},"lcrsc":{"type":"boolean","example":false,"description":"資料資源是否位於本機"},"linkable":{"type":"boolean","example":false,"description":"連結有效性與否"},"lstupdt":{"type":"array","description":"最後10次更新日期與時間","items":{"type":"string","format":"date-time"}},"nodeid":{"type":"string","description":"資料集之節點識別碼(Node ID)"},"quality":{"type":"integer","format":"int32","description":"資料資源之品質星等值(最低1星最高5星)"},"resourceid":{"type":"string","description":"資料資源之識別碼(ID)"},"rscsize":{"type":"number","format":"float","description":"資料資源之體積(KiloByte)"},"rstype":{"type":"string","description":"資料資源之檔案格式"},"updfrq":{"type":"string","description":"資料更新頻率"}},"title":"DatasetInfo"},"Group":{"type":"object","properties":{"categoryCode":{"type":"string","description":"群組的分類編號"},"created":{"type":"string","format":"date-time","description":"建立日期"},"description":{"type":"string","description":"描述分類群組詳細內容"},"display_name":{"type":"string","description":"用來顯示的分類群組名稱"},"package_count":{"type":"integer","format":"int32","description":"群組內資料集數量"},"packages":{"type":"array","description":"群組內資料集編號清單","items":{"type":"string"}}},"title":"Group"},"Resource":{"type":"object","properties":{"characterSetCode":{"type":"string","description":"編碼格式"},"downloadURL":{"type":"string","description":"資料存取網址"},"format":{"type":"string","description":"資料資源格式"},"resourceDescription":{"type":"string","description":"資料資源描述"},"resourceID":{"type":"string","description":"資料資源編號"},"resourceModified":{"type":"string","format":"date-time","description":"最後更新日期"}},"title":"Resource"}}}