マニュアル

レジストリカタログの操作方法について、説明します。
なお、本マニュアル記載の画面項目や画面イメージについてはマニュアル向けの事例であり、今後変更される可能性があります。


本サービスの利用規約については、メニューの「利用規約」からご参照ください。
本サービスに関するお問い合わせは、メニューの「お問い合わせ」から行ってください。

目次

1 検索とデータダウンロードの方法

2 データカタログサイトで提供しているAPIに関する情報


1 検索とデータダウンロードの方法

レジストリカタログでは、CKANを使用して、データセットを公開しています。

CKAN
https://ckan.org/

データセットは以下の方法で検索できます。


ファセット検索を行う
①データセット一覧画面の左メニューから、以下の内容でファセット検索が行えます。
組織 : データの公開元組織グループ : 法律、土地などデータのグループ
データセット種別 : グループより詳細な種別フォーマット : CSV、JSONなどのフォーマット(拡張子)
ファセット検索
②組織でファセット検索を行います。組織にはそれぞれ以下のデータが含まれます。
デジタル庁 : ベース・レジストリ、e-Gov公開データ等金融庁 : EDINET公開データ等
国税庁 : 法人番号公表サイト公開データ等経済産業省 : gBizINFO公開データ等
中小企業庁 : ミラサポPlus公開データ等情報処理推進機構(IPA) : IMI公開データ等
【検索例】組織「デジタル庁」をクリック
ファセット検索 デジタル庁

③ファセット検索が行われ、組織「デジタル庁」のデータセットのみ表示されます。

ファセット検索結果 デジタル庁
④別の条件でさらにファセット検索を行うことができます。
グループでファセット検索を行います。グループにはそれぞれ以下のデータが含まれます。
土地・地図 : アドレスデータ、町字マスター等公共施設 : 公共施設データ等
イベント : イベントデータ等法人 : 有価証券報告書、法人番号、法人活動情報等
法律・制度 : 事例、法令等文字情報基盤 : MJ文字情報一覧表、MJ縮退マップ等
【検索例】グループ「法律・制度」をクリック
ファセット検索 法律・制度

⑤ファセット検索が行われ、組織「デジタル庁」かつグループ「法律・制度」のデータセットのみ表示されます。
さらに別の条件でもファセット検索可能です。また、キーワード検索と合わせて使用することもできます。

ファセット検索結果 法律・制度

キーワード検索を行う

①キーワード検索欄に検索したいキーワードを入力します。

キーワード検索

②キーワードを入力して、「」ボタンをクリックすると、データセットのメタデータ(タイトル、説明、タグ等)にキーワードが含まれるデータセットを検索して表示します。
【検索例】キーワードに「公共施設」を入力して検索

キーワード検索 公共施設

③キーワードをスペース区切りで入力すると、いずれのキーワードも含まれているデータセットを検索します。(AND検索)
【検索例】キーワードに「公共施設 東京都」を入力して検索すると「公共施設」と「東京都」のいずれも含まれているデータセットを検索します。

キーワード検索 公共施設 東京都

データをダウンロードする

データは以下の方法でダウンロードできます。

①データセット一覧画面からデータをダウンロードしたいデータセットをクリックします。

データセット一覧

②データセットのメタデータが表示されます。「データとリソース」欄にダウンロード可能なデータが一覧表示されます。

データセット詳細

③ダウンロードしたいデータの「詳細」ボタンをクリックします。
メニューが表示されるので、「ダウンロード」をクリックするとファイルがダウンロードされます。

データダウンロード

④「より多くの情報」をクリックすると、リソース詳細画面に遷移します。リソース詳細画面からURLのリンクまたは、ダウンロードボタンをクリックすることでダウンロードすることもできます。

リソース詳細

⑤リソースのデータ定義等の情報は「リソース詳細」から確認することができます。

リソース詳細

⑥「メタデータ詳細」は、メタデータの詳細をXML形式でダウンロードすることができます。

メタデータ詳細

2 データカタログサイトで提供しているAPIに関する情報

レジストリカタログでは、ITシステムの開発者等が、本サービスで提供するメタデータを二次利用し、ITシステムを開発するために必要なAPI情報を提供しています。
※API: Application Programming Interface


レジストリカタログでは、CKAN APIを使用して、データセット、リソース、組織、グループ等のメタデータの情報を取得することができます。

CKAN API guide
https://docs.ckan.org/en/2.9/api/

留意点

  • 実行にあたっては、CKAN API guideに記載の 「http://demo.ckan.org/」 の部分を、レジストリカタログのURL 「https://catalog.registries.digital.go.jp/」 に置き換えてください。
  • データの更新を行うAPIについては使用できません。
  • APIで取得する日付項目はUTC(協定世界時)となっています。JST(日本標準時)で使用する場合は、変換してご利用ください。

API名
GETpackage_search

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_search

主要なパラメタ
名前 データ型 説明
q

(任意項目)

string 検索キーワード
sort

(任意項目)

string 検索結果の表示順
metadata_modified desc : 最終更新日の降順
title_string asc : データセット名の昇順
title_string desc : データセット名の降順
rows

(任意項目)

int 検索結果の取得数
デフォルト: 10
上限:1000
start

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 キーワード「イベント」で検索する。 https://catalog.registries.digital.go.jp/api/3/action/package_search?q=イベント レスポンス

{ "help": "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=package_search", "success": true, "result": { "count": 2, "facets": {}, "results": [ { "author": null, "author_email": null, "creator_user_id": "8287047d-f0ba-441a-911a-6d26e0a0b633", "id": "9b35fe9f-412e-4b0f-af29-d2e9cc3636c4", "isopen": true, "license_id": "cc-by", "license_title": "クリエイティブ・コモンズ 表示", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": null, "maintainer_email": null, "metadata_created": "2022-08-06T08:40:40.499647", "metadata_modified": "2022-08-06T08:40:40.499655", "name": "be000001", "notes": "ベースレジストリの イベント データセットです。", "num_resources": 2, "num_tags": 5, "organization": { "id": "79589b46-04fa-48cf-9256-cdf7629043cf", "name": "o-000001", "title": "デジタル庁", "type": "organization", "description": "", "image_url": "", "created": "2022-08-04T09:09:43.768847", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "79589b46-04fa-48cf-9256-cdf7629043cf", "private": false, "state": "active", "title": "イベント", "type": "dataset", "url": null, "version": null, "extras": [ { "key": "管理ID", "value": "BE000001" }, { "key": "対象地域", "value": "日本" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "デジタル庁" }, { "key": "データセット種別", "value": "イベント(全て)" }, { "key": "備考", "value": "ベースレジストリ側で削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "公共イベント", "id": "2914586a-f918-4662-a2c0-5fac71d20464", "image_display_url": "", "name": "g-000003", "title": "公共イベント" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2022-08-06T08:40:40.505947", "description": "イベント/全国のリソースです。", "format": "CSV", "hash": "", "id": "f2dca7fa-ef0e-4db8-9cf9-89723709bb9e", "last_modified": "2022-08-06T08:40:40.486124", "metadata_modified": "2022-08-06T08:40:40.486124", "mimetype": "text/csv", "mimetype_inner": null, "name": "イベント/全国", "package_id": "9b35fe9f-412e-4b0f-af29-d2e9cc3636c4", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/be000001.csv", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2022-08-06T08:40:40.505952", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "9c407c83-a127-4cf8-96dd-01e5e8252b86", "last_modified": "2022-08-06T08:40:40.486319", "metadata_modified": "2022-08-06T08:40:40.486319", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ詳細", "package_id": "9b35fe9f-412e-4b0f-af29-d2e9cc3636c4", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/dataset/be000001.xml", "url_type": null } ], "tags": [ { "display_name": "催し", "id": "45f9938a-cda6-4013-93cc-9631c9333693", "name": "催し", "state": "active", "vocabulary_id": null }, { "display_name": "催事", "id": "3a2a9bee-ae6b-4f30-a080-91cdf4bf0f88", "name": "催事", "state": "active", "vocabulary_id": null }, { "display_name": "地域イベント", "id": "d82993b5-38b3-4f92-9aa3-e9b3a4ce140b", "name": "地域イベント", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "0901c722-8550-441c-92a3-cdbb53e46e20", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "17479e76-ef76-459a-acd2-623a1a858c05", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] }, { "author": null, "author_email": null, "creator_user_id": "8287047d-f0ba-441a-911a-6d26e0a0b633", "id": "06b64adc-99b0-48f3-9001-d199ab1e36ba", "isopen": true, "license_id": "cc-by", "license_title": "クリエイティブ・コモンズ 表示", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": null, "maintainer_email": null, "metadata_created": "2022-08-06T08:40:42.547004", "metadata_modified": "2022-08-06T08:40:42.547011", "name": "br-o1-010006_g2-000test", "notes": "ベースレジストリの アドレス/都道府県マスター データセットです。", "num_resources": 2, "num_tags": 5, "organization": { "id": "79589b46-04fa-48cf-9256-cdf7629043cf", "name": "o-000001", "title": "デジタル庁", "type": "organization", "description": "", "image_url": "", "created": "2022-08-04T09:09:43.768847", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "79589b46-04fa-48cf-9256-cdf7629043cf", "private": false, "state": "active", "title": "神奈川県 イベント データセット", "type": "dataset", "url": null, "version": null, "extras": [ { "key": "管理ID", "value": "BR-o1-010006_g2-000test" }, { "key": "対象地域", "value": "神奈川県" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "デジタル庁" }, { "key": "データセット種別", "value": "イベント(都道府県、自治体別)" }, { "key": "備考", "value": "ベースレジストリ側で削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "公共イベント", "id": "2914586a-f918-4662-a2c0-5fac71d20464", "image_display_url": "", "name": "g-000003", "title": "公共イベント" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2022-08-06T08:40:42.549732", "description": "イベント(都道府県、自治体別)のリソースです。", "format": "CSV", "hash": "", "id": "db8dd0fd-3848-43a1-ad55-b060371fa238", "last_modified": "2022-08-06T08:40:42.534240", "metadata_modified": "2022-08-06T08:40:42.534240", "mimetype": "text/csv", "mimetype_inner": null, "name": "神奈川県 イベント データセット", "package_id": "06b64adc-99b0-48f3-9001-d199ab1e36ba", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/br-o1-010006_g2-000test.csv", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2022-08-06T08:40:42.549738", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "d6105a97-ea91-4b77-8013-fc4669af8324", "last_modified": "2022-08-06T08:40:42.534422", "metadata_modified": "2022-08-06T08:40:42.534422", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ詳細", "package_id": "06b64adc-99b0-48f3-9001-d199ab1e36ba", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/dataset/br-o1-010006_g2-000test.xml", "url_type": null } ], "tags": [ { "display_name": "催し", "id": "45f9938a-cda6-4013-93cc-9631c9333693", "name": "催し", "state": "active", "vocabulary_id": null }, { "display_name": "催事", "id": "3a2a9bee-ae6b-4f30-a080-91cdf4bf0f88", "name": "催事", "state": "active", "vocabulary_id": null }, { "display_name": "地域イベント", "id": "d82993b5-38b3-4f92-9aa3-e9b3a4ce140b", "name": "地域イベント", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "0901c722-8550-441c-92a3-cdbb53e46e20", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "17479e76-ef76-459a-acd2-623a1a858c05", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] } ], "sort": "score desc, metadata_modified desc", "search_facets": {} } }

主要なレスポンス項目
名前 データ型 説明
count int データセット件数
results

list of dataset dictionaries データセット一覧
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 組織
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日

データセットID一覧を取得する(package_list)

API名
GETpackage_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_list

主要なパラメタ
名前 データ型 説明
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 データセットIDを10件取得する。 https://catalog.registries.digital.go.jp/api/3/action/package_list?limit=10 レスポンス

{ "help": "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=package_list", "success": true, "result": [ "ba000001", "be000001", "bp000001", "br-140007g1-000305", "br-o1-010006_g2-000003", "br-o1-010006_g2-000test", "cn000001", "eg000001", "eg000002", "eg000003" ] }

主要なレスポンス項目
名前 データ型 説明
results

list of dataset id データセットID一覧

データセットのメタデータを取得する(package_show)

API名
GETpackage_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string データセットID
include_tracking

(任意項目)

bool データセットのアクセス数、ダウンロード数を出力する
デフォルト: false
実行例 「全法令」データセットのメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/package_show?id=eg000001 レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=package_show", success: true, result: { author: null, author_email: null, creator_user_id: "8287047d-f0ba-441a-911a-6d26e0a0b633", id: "c900cb5a-1a10-4122-89da-101813df457c", isopen: true, license_id: "cc-by", license_title: "クリエイティブ・コモンズ 表示", license_url: "https://creativecommons.org/licenses/by/4.0/deed.ja", maintainer: null, maintainer_email: null, metadata_created: "2022-08-06T08:32:43.621473", metadata_modified: "2022-08-06T08:32:43.621480", name: "eg000001", notes: "e-Govの 全法令 データセットです。", num_resources: 2, num_tags: 3, organization: { id: "79589b46-04fa-48cf-9256-cdf7629043cf", name: "o-000001", title: "デジタル庁", type: "organization", description: "", image_url: "", created: "2022-08-04T09:09:43.768847", is_organization: true, approval_status: "approved", state: "active" }, owner_org: "79589b46-04fa-48cf-9256-cdf7629043cf", private: false, state: "active", title: "全法令", type: "dataset", url: null, version: null, extras: [ { key: "管理ID", value: "EG000001" }, { key: "対象地域", value: "日本" }, { key: "対象期間", value: "" }, { key: "提供者", value: "デジタル庁" }, { key: "連絡先情報", value: "デジタル庁" }, { key: "データセット種別", value: "全法令" }, { key: "備考", value: "e-Gov側で削除となった情報は含みません。" } ], groups: [ { description: "", display_name: "法律・制度", id: "26d937fd-01f6-4574-a1f9-99f6485b7e05", image_display_url: "", name: "g-000005", title: "法律・制度" } ], resources: [ { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:32:43.636648", description: "全法令のリソースです。", format: "XML", hash: "", id: "a35c7ada-67ee-4a1d-9188-4a9ba8e826ff", last_modified: "2022-08-06T08:32:43.583434", metadata_modified: "2022-08-06T08:32:43.583434", mimetype: null, mimetype_inner: null, name: "全法令", package_id: "c900cb5a-1a10-4122-89da-101813df457c", position: 0, resource_type: null, size: null, state: "active", url: "https://elaws.e-gov.go.jp/download?file_section=1&only_xml_flag=true", url_type: null }, { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:32:43.636655", description: "メタデータをXML形式でダウンロードします。", format: "XML", hash: "", id: "b8736542-e36b-4d73-8267-e51c940bc47d", last_modified: "2022-08-06T08:32:43.584319", metadata_modified: "2022-08-06T08:32:43.584319", mimetype: null, mimetype_inner: null, name: "メタデータ詳細", package_id: "c900cb5a-1a10-4122-89da-101813df457c", position: 1, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/dataset/eg000001.xml", url_type: null } ], tags: [ { display_name: "商取引", id: "9b4bf182-af92-408b-89b8-42015e422905", name: "商取引", state: "active", vocabulary_id: null }, { display_name: "法令", id: "51e377cf-491e-4e53-af99-bd37c3ffbb0d", name: "法令", state: "active", vocabulary_id: null }, { display_name: "法律", id: "f7f4d265-4755-4b49-a914-7d157f9e4622", name: "法律", state: "active", vocabulary_id: null } ], relationships_as_subject: [ ], relationships_as_object: [ ] } }

主要なレスポンス項目
名前 データ型 説明
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 組織
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
tracking_summary : リソースダウンロード数(include_tracking=trueを指定した場合のみ表示)
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日
tracking_summary

int データセットアクセス数
(include_tracking=trueを指定した場合のみ表示)

最近更新されたデータセットのメタデータ一覧を取得する(current_package_list_with_resources)

API名
GETcurrent_package_list_with_resources

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/current_package_list_with_resources

主要なパラメタ
名前 データ型 説明
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 最近更新されたデータセットのメタデータを3件取得する。 https://catalog.registries.digital.go.jp/api/3/action/current_package_list_with_resources?limit=3 レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=current_package_list_with_resources", success: true, result: [ { author: null, author_email: null, creator_user_id: "8287047d-f0ba-441a-911a-6d26e0a0b633", id: "efaa3383-89cd-4347-b930-1888a4495351", isopen: true, license_id: "cc-by", license_title: "クリエイティブ・コモンズ 表示", license_url: "https://creativecommons.org/licenses/by/4.0/deed.ja", maintainer: null, maintainer_email: null, metadata_created: "2022-08-06T08:40:51.616503", metadata_modified: "2022-08-06T09:38:17.106295", name: "cn000001", notes: "法人番号公表サイトの 法人番号 データセットです。", num_resources: 3, num_tags: 5, organization: { id: "9523f9f2-03c3-4269-a790-6ac7c53e6396", name: "o-000003", title: "国税庁", type: "organization", description: "", image_url: "", created: "2022-08-04T09:09:54.224032", is_organization: true, approval_status: "approved", state: "active" }, owner_org: "9523f9f2-03c3-4269-a790-6ac7c53e6396", private: false, state: "active", title: "法人番号", type: "dataset", url: null, version: null, extras: [ { key: "データセット種別", value: "法人番号(全て)" }, { key: "備考", value: "法人番号公表サイト側で非公開となる情報は含みません。" }, { key: "対象地域", value: "日本" }, { key: "対象期間", value: "" }, { key: "提供者", value: "国税庁" }, { key: "管理ID", value: "CN000001" }, { key: "連絡先情報", value: "国税庁" } ], groups: [ { description: "", display_name: "法人", id: "67dcd0e8-9c90-4674-9e87-c30f70eea1d4", image_display_url: "", name: "g-000004", title: "法人" } ], resources: [ { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:51.624403", description: "法人番号(UTF-8)のリソースです。", format: "CSV(UTF-8)", hash: "", id: "3c5b64f6-ec03-4394-b994-c5dcf8c7cfa7", last_modified: "2022-08-06T09:34:54.852331", metadata_modified: "2022-08-06T09:34:54.852331", mimetype: "text/csv", mimetype_inner: null, name: "法人番号(UTF-8)", package_id: "efaa3383-89cd-4347-b930-1888a4495351", position: 0, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/rsc/XXXXXX.csv", url_type: null }, { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:51.624409", description: "法人番号(Shift-JIS)のリソースです。", format: "CSV(Shift-JIS)", hash: "", id: "0979e5dd-6252-445d-b4d3-5592b3fff25f", last_modified: "2022-08-06T08:40:51.601353", metadata_modified: "2022-08-06T08:40:51.601353", mimetype: null, mimetype_inner: null, name: "法人番号(Shift-JIS)", package_id: "efaa3383-89cd-4347-b930-1888a4495351", position: 1, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/rsc/XXXXXX.csv", url_type: null }, { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:51.624411", description: "メタデータをXML形式でダウンロードします。", format: "XML", hash: "", id: "f982f3f1-046f-42bd-a0f1-1b175beb74bd", last_modified: "2022-08-06T09:38:17.112201", metadata_modified: "2022-08-06T09:38:17.112201", mimetype: "application/xml", mimetype_inner: null, name: "メタデータ詳細", package_id: "efaa3383-89cd-4347-b930-1888a4495351", position: 2, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/dataset/cn000001.xml", url_type: null } ], tags: [ { display_name: "企業名", id: "0dea72db-1f20-45ae-bf93-95772936fdc7", name: "企業名", state: "active", vocabulary_id: null }, { display_name: "会社名", id: "3aa00f57-7ae5-4368-af4a-b56a0d38dde1", name: "会社名", state: "active", vocabulary_id: null }, { display_name: "業種", id: "d0c6b24d-43ea-4cc0-9e59-66b941605721", name: "業種", state: "active", vocabulary_id: null }, { display_name: "法人名", id: "76eaa964-f3ed-4bfc-84de-af01868f3520", name: "法人名", state: "active", vocabulary_id: null }, { display_name: "都道府県名", id: "ab1ef496-0d4f-43d6-bdb8-62de275deec3", name: "都道府県名", state: "active", vocabulary_id: null } ], relationships_as_subject: [ ], relationships_as_object: [ ] }, { author: null, author_email: null, creator_user_id: "8287047d-f0ba-441a-911a-6d26e0a0b633", id: "1f4f7f45-d85c-46ca-ac3a-080baf32715d", isopen: true, license_id: "cc-by", license_title: "クリエイティブ・コモンズ 表示", license_url: "https://creativecommons.org/licenses/by/4.0/deed.ja", maintainer: null, maintainer_email: null, metadata_created: "2022-08-06T08:40:47.514743", metadata_modified: "2022-08-06T08:40:47.514750", name: "br-140007g1-000305", notes: "ベースレジストリの神奈川県 公共施設データセット データセットです。", num_resources: 2, num_tags: 4, organization: { id: "79589b46-04fa-48cf-9256-cdf7629043cf", name: "o-000001", title: "デジタル庁", type: "organization", description: "", image_url: "", created: "2022-08-04T09:09:43.768847", is_organization: true, approval_status: "approved", state: "active" }, owner_org: "79589b46-04fa-48cf-9256-cdf7629043cf", private: false, state: "active", title: "神奈川県 公共施設 データセット", type: "dataset", url: null, version: null, extras: [ { key: "管理ID", value: "BR-140007/g1-000305" }, { key: "対象地域", value: "神奈川" }, { key: "対象期間", value: "" }, { key: "提供者", value: "デジタル庁" }, { key: "連絡先情報", value: "デジタル庁" }, { key: "データセット種別", value: "公共施設(都道府県、市区町村)" }, { key: "備考", value: "ベースレジストリ側で削除となった情報は含みません。" } ], groups: [ { description: "", display_name: "公共施設", id: "8c9b5d08-fba0-47c9-bad4-780508ff38c5", image_display_url: "", name: "g-000002", title: "公共施設" } ], resources: [ { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:47.517423", description: "公共施設(都道府県、自治体別)のリソースです。", format: "CSV", hash: "", id: "cce9966b-d7bc-44f9-94e8-c9da60a7d651", last_modified: "2022-08-06T08:40:47.503604", metadata_modified: "2022-08-06T08:40:47.503604", mimetype: null, mimetype_inner: null, name: "神奈川県 公共施設 データセット", package_id: "1f4f7f45-d85c-46ca-ac3a-080baf32715d", position: 0, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/rsc/XXXXXX.csv", url_type: null }, { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:47.517429", description: "メタデータをXML形式でダウンロードします。", format: "XML", hash: "", id: "60b35e82-cee3-43ed-a749-05d1766c0f9b", last_modified: "2022-08-06T08:40:47.503799", metadata_modified: "2022-08-06T08:40:47.503799", mimetype: null, mimetype_inner: null, name: "メタデータ詳細", package_id: "1f4f7f45-d85c-46ca-ac3a-080baf32715d", position: 1, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/dataset/br-140007g1-000305.xml", url_type: null } ], tags: [ { display_name: "市区町村", id: "0901c722-8550-441c-92a3-cdbb53e46e20", name: "市区町村", state: "active", vocabulary_id: null }, { display_name: "避難所", id: "f2de545c-f0db-4d5e-812d-42103a9b0965", name: "避難所", state: "active", vocabulary_id: null }, { display_name: "避難施設", id: "0bb79fcb-f812-40c9-be48-ed540c105a02", name: "避難施設", state: "active", vocabulary_id: null }, { display_name: "都道府県", id: "17479e76-ef76-459a-acd2-623a1a858c05", name: "都道府県", state: "active", vocabulary_id: null } ], relationships_as_subject: [ ], relationships_as_object: [ ] }, { author: null, author_email: null, creator_user_id: "8287047d-f0ba-441a-911a-6d26e0a0b633", id: "945cfbe1-102b-436c-9830-0dc0c83f2fdf", isopen: true, license_id: "cc-by", license_title: "クリエイティブ・コモンズ 表示", license_url: "https://creativecommons.org/licenses/by/4.0/deed.ja", maintainer: null, maintainer_email: null, metadata_created: "2022-08-06T08:40:45.179963", metadata_modified: "2022-08-06T08:40:45.179971", name: "bp000001", notes: "ベースレジストリの 公共施設 データセットです。", num_resources: 2, num_tags: 4, organization: { id: "79589b46-04fa-48cf-9256-cdf7629043cf", name: "o-000001", title: "デジタル庁", type: "organization", description: "", image_url: "", created: "2022-08-04T09:09:43.768847", is_organization: true, approval_status: "approved", state: "active" }, owner_org: "79589b46-04fa-48cf-9256-cdf7629043cf", private: false, state: "active", title: "公共施設", type: "dataset", url: null, version: null, extras: [ { key: "管理ID", value: "BP000001" }, { key: "対象地域", value: "日本" }, { key: "対象期間", value: "" }, { key: "提供者", value: "デジタル庁" }, { key: "連絡先情報", value: "デジタル庁" }, { key: "データセット種別", value: "公共施設(全て)" }, { key: "備考", value: "ベースレジストリ側で削除となった情報は含みません。" } ], groups: [ { description: "", display_name: "公共施設", id: "8c9b5d08-fba0-47c9-bad4-780508ff38c5", image_display_url: "", name: "g-000002", title: "公共施設" } ], resources: [ { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:45.185215", description: "公共施設/全国のリソースです。", format: "CSV", hash: "", id: "ec868296-645b-46f0-8696-712ad204e5de", last_modified: "2022-08-06T08:40:45.166145", metadata_modified: "2022-08-06T08:40:45.166145", mimetype: null, mimetype_inner: null, name: "公共施設/全国", package_id: "945cfbe1-102b-436c-9830-0dc0c83f2fdf", position: 0, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/rsc/XXXXXX.csv", url_type: null }, { cache_last_updated: null, cache_url: null, created: "2022-08-06T08:40:45.185220", description: "メタデータをXML形式でダウンロードします。", format: "XML", hash: "", id: "6989615d-db5e-4146-8f3a-41756dd4bcec", last_modified: "2022-08-06T08:40:45.166349", metadata_modified: "2022-08-06T08:40:45.166349", mimetype: null, mimetype_inner: null, name: "メタデータ詳細", package_id: "945cfbe1-102b-436c-9830-0dc0c83f2fdf", position: 1, resource_type: null, size: null, state: "active", url: "https://catalog.registries.digital.go.jp/dataset/bp000001.xml", url_type: null } ], tags: [ { display_name: "市区町村", id: "0901c722-8550-441c-92a3-cdbb53e46e20", name: "市区町村", state: "active", vocabulary_id: null }, { display_name: "避難所", id: "f2de545c-f0db-4d5e-812d-42103a9b0965", name: "避難所", state: "active", vocabulary_id: null }, { display_name: "避難施設", id: "0bb79fcb-f812-40c9-be48-ed540c105a02", name: "避難施設", state: "active", vocabulary_id: null }, { display_name: "都道府県", id: "17479e76-ef76-459a-acd2-623a1a858c05", name: "都道府県", state: "active", vocabulary_id: null } ], relationships_as_subject: [ ], relationships_as_object: [ ] } ] }

主要なレスポンス項目
名前 データ型 説明
result

list of dataset dictionaries データセット一覧
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 組織
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日

組織ID一覧を取得する(organization_list)

API名
GETorganization_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/organization_list

主要なパラメタ
名前 データ型 説明
sort

(任意項目)

string 検索結果の表示順
name asc : 組織IDの昇順
name desc : 組織IDの降順
title asc : 組織名の昇順
title desc : 組織名の降順
package_count asc : 組織内データセット数の昇順
package_count desc : 組織内データセット数の降順
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 組織IDを組織IDの昇順で取得する。 https://catalog.registries.digital.go.jp/api/3/action/organization_list?sort=name asc レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=organization_list", success: true, result: [ "o-000001", "o-000002", "o-000003", "o-000004", "o-000005", "o-000006", ] }

主要なレスポンス項目
名前 データ型 説明
result

list of organization id 組織ID一覧

組織のメタデータを取得する(organization_show)

API名
GETorganization_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/organization_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string 組織ID
include_datasets

(任意項目)

bool 組織内データセットのメタデータを含める
実行例 組織「デジタル庁」のメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/organization_show?id=o-000001 レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=organization_show", success: true, result: { approval_status: "approved", created: "2022-08-04T09:09:43.768847", description: "", display_name: "デジタル庁", id: "79589b46-04fa-48cf-9256-cdf7629043cf", image_display_url: "", image_url: "", is_organization: true, name: "o-000001", num_followers: 0, package_count: 10, state: "active", title: "デジタル庁", type: "organization", extras: [ ], tags: [ ], groups: [ ] } }

主要なレスポンス項目
名前 データ型 説明
name

string 組織ID
title, display_name

string 組織名
description

string 説明
created

iso date string 作成日
package_count

int 組織内のデータセット数
packages

list of dataset dictionaries 組織内データセットのメタデータ
(include_datasets=trueを指定した場合のみ表示)

グループID一覧を取得する(group_list)

API名
GETgroup_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/group_list

主要なパラメタ
名前 データ型 説明
sort

(任意項目)

string 検索結果の表示順
name asc : グループIDの昇順
name desc : グループIDの降順
title asc : グループ名の昇順
title desc : グループ名の降順
package_count asc : グループ内データセット数の昇順
package_count desc : グループ内データセット数の降順
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 グループIDをグループIDの昇順で取得する。 https://catalog.registries.digital.go.jp/api/3/action/group_list?sort=name asc レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=group_list", success: true, result: [ "g-000001", "g-000002", "g-000003", "g-000004", "g-000005", "g-000006", ] }

主要なレスポンス項目
名前 データ型 説明
result

list of group id グループID一覧

グループのメタデータを取得する(group_show)

API名
GETgroup_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/group_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string グループID
include_datasets

(任意項目)

bool グループ内データセットのメタデータを含める
実行例 グループ「公共施設」のメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/group_show?id=g-000002 レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=group_show", success: true, result: { approval_status: "approved", created: "2022-08-04T09:10:29.788130", description: "", display_name: "公共施設", id: "8c9b5d08-fba0-47c9-bad4-780508ff38c5", image_display_url: "", image_url: "", is_organization: false, name: "g-000002", num_followers: 0, package_count: 2, state: "active", title: "公共施設", type: "group", extras: [ ], tags: [ ], groups: [ ] } }

主要なレスポンス項目
名前 データ型 説明
name

string グループID
title, display_name

string グループ名
description

string 説明
created

iso date string 作成日
package_count

int グループ内のデータセット数
packages

list of dataset dictionaries グループ内データセットのメタデータ
(include_datasets=trueを指定した場合のみ表示)

タグ一覧を取得する(tag_list)

API名
GETtag_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/tag_list

主要なパラメタ
名前 データ型 説明
query

(任意項目)

string 検索キーワード
実行例 タグの一覧を取得する。 https://catalog.registries.digital.go.jp/api/3/action/tag_list レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=tag_list", success: true, result: [ "中小企業", "住所情報", "催し", "催事", "助成", "商取引", "地域イベント", "市区町村", "支援", "文字情報", "業種", "法令", "法律", "漢字情報", "補助金", "避難所", "避難施設", ] }

主要なレスポンス項目
名前 データ型 説明
result

list of tag タグ一覧

タグのメタデータを取得する(tag_show)

API名
GETtag_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/tag_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string タグ名
include_datasets

(任意項目)

bool タグが設定されたデータセットのメタデータを含める
実行例 タグ「法令」のメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/tag_show?id=法律 レスポンス

{ help: "https://catalog.registries.digital.go.jp/api/3/action/help_show?name=tag_show", success: true, result: { id: "51e377cf-491e-4e53-af99-bd37c3ffbb0d", name: "法令", vocabulary_id: null, display_name: "法令" } }

主要なレスポンス項目
名前 データ型 説明
name, display_name

string タグ名
packages

list of dataset dictionaries タグが設定されたデータセットのメタデータ
(include_datasets=trueを指定した場合のみ表示)