G空間情報センター

お問い合わせ

よくある質問
新規ユーザー登録
ホーム マニュアル

APIを使う

Ｇ空間情報センター　ＡＰＩ利用マニュアル
２０１８年５月　一般社団法人社会基盤情報流通推進協議会

内容

  1. APIとは
  2. APIキーおよびIDの確認
    • 2-1. ユーザAPIキーおよびユーザIDの確認
    • 2-2. 組織IDの確認
    • 2-3. カテゴリIDの確認
    • 2-4. データセットIDの確認
    • 2-5. リソースIDの確認
  3. APIの一覧
  4. APIの利用例
    • 4-1. APIを利用した情報の取得例
      • （ア）組織に関するメタデータの取得
      • （イ）カテゴリに関するメタデータの取得
      • （ウ）タグに関するメタデータの取得
      • （エ）データセットやリソースに関するメタデータの取得
      • （オ）フォロー機能に関するメタデータの取得
      • （カ）ダッシュボードに関するメタデータの取得
      • （キ）CKANの設定に関するメタデータの取得
    • 4-2. プライベートデータのメタデータ取得
    • 4-3. APIを利用した登録、更新、削除例
      • （ア）データセットに関する更新
      • （イ）リソースおよびリソースビューに関する更新
      • （ウ）フォローに関する更新
    • 4-4. データセット作成・編集時のバリデーションチェック
      • （ア）必須・任意項目表
      • （イ）データセット登録時のAPI例

1.APIとは

G空間情報センターではシステム連携を実現するため、各システムから共通で使用可能なG空間情報センターのAPI（Application Programming Interface、以降APIといいます）を提供しています。API は、URL+引数で構成されています。一例として、ブラウザ上でAPI のURL を指定すると、実行結果が表示されます。

2. API キーおよびID の確認

2-1.ユーザAPI キーおよびユーザIDの確認

Ｇ空間情報センターではユーザごとにAPI キーを保持しています。API には情報取得機能と情報編集機能があり、プライベートデータセットの情報取得には閲覧権限のあるユーザのＡＰＩキーが必要となり、情報編集には編集権限のあるユーザのAPI キーが必要となります。
以下のURL を入力してユーザプロパティ画面を開き、画面左下に記載されているユーザ別のAPI キーを確認します。
https://www.geospatial.jp/ckan/user/<ユーザ名>
また、ユーザ名＝ユーザID として、ユーザID を引数に指定するＡＰＩが利用できます。

2-2.組織IDの確認

ＡＰＩの引数に指定する組織ＩＤは組織情報表示時のＵＲＬで確認します。

2-3.カテゴリＩＤの確認

ＡＰＩの引数に指定するカテゴリＩＤは、カテゴリ情報表示時のＵＲＬで確認します。

2-4.データセットＩＤの確認

ＡＰＩの引数に指定するデータセットＩＤは、データセット情報表示時のＵＲＬで確認します。

2-5.リソースＩＤの確認

ＡＰＩの引数に指定するリソースＩＤは、リソース情報表示時のＵＲＬで確認します。

3.ＡＰＩの一覧

Ｇ空間情報センターで提供されるＡＰＩの一覧です。

組織関連

API組織一覧を取得する
api/3/action/organization_list
引数：
order_by
必須／オプション：
オプション
デフォルト値：
name
戻り値のタイプ：
string
パラメータ説明

nameでソートする場合は「name」、データセット数でソートする場合は「packages」を指定する

引数：
organizations
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
list of strings
パラメータ説明

取得する組織の名称を指定する

引数：
all_fields
必須／オプション：
オプション
デフォルト値：
false
戻り値のタイプ：
boolean
パラメータ説明

すべてメタデータ項目を取得する場合は「true」、「name」のみを取得する場合は「false」を指定する

API組織の詳細を取得する
api/3/action/organization_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得する組織の「id」または、「name」を指定する

API組織更新履歴を取得する
api/3/action/organization_activity_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得する組織の「id」または、「name」を指定する

API組織のリビジョン履歴を取得する
api/3/action/organization_revision_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの「id」または、「name」を指定する

API検索文字列に一致する組織の一覧を取得する
api/3/action/organization_autocomplete
引数：
q
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索クエリを指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得する最大の組織件数を指定する

API組織の更新履歴をhtml形式で取得する
api/3/action/organization_activity_list_html
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

組織の「id」または、「name」を指定する

カテゴリ関連

APIカテゴリ一覧を取得する
api/3/action/group_list
引数：
order_by
必須／オプション：
オプション
デフォルト値：
name
戻り値のタイプ：
string
パラメータ説明

nameでソートする場合は「name」、データセット数でソートする場合は「packages」を指定する

引数：
groups
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
list of strings
パラメータ説明

取得するグループの名称を指定する

引数：
all_fields
必須／オプション：
オプション
デフォルト値：
false
戻り値のタイプ：
boolean
パラメータ説明

すべてメタデータ項目を取得する場合は「true」、「name」のみを取得する場合は「false」を指定する

APIカテゴリの詳細を取得する
api/3/action/group_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するカテゴリの「id」を指定する

APIグループのデータセット一覧を取得する
api/3/action/group_package_show
引数：
id
必須／オプション：
必須
デフォルト値：
 
戻り値のタイプ：
string
パラメータ説明

取得するグループの「id」または、「name」を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得する最大のグループ数を指定する

APIカテゴリ更新履歴を取得する
api/3/action/group_activity_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するカテゴリの「id」または、「name」を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
31
戻り値のタイプ：
int
パラメータ説明

取得する最大のアクティビティ数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

API編集権限をもつカテゴリの一覧を取得する
api/3/action/group_list_authz
引数：
am_member
必須／オプション：
オプション
デフォルト値：
false
戻り値のタイプ：
boolean
パラメータ説明

「True」の場合はログインユーザが所属するグループのみが返却され、「False」の場合はユーザの「name」または「id」を指定する

APIカテゴリのリビジョン履歴を取得する
api/3/action/group_revision_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

カテゴリの「id」または、「name」を指定する

APIカテゴリの更新履歴をhtml形式で取得する
api/3/action/group_activity_list_html
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

カテゴリの「id」または「name」を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得する最大の更新履歴件数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

タグ関連

APIタグ一覧を取得する
api/3/action/tag_list
引数：
query
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するタグに含まれる文字列を指定する

引数：
all_fields
必須／オプション：
オプション
デフォルト値：
false
戻り値のタイプ：
boolean
パラメータ説明

すべてメタデータ項目を取得する場合は「true」、「name」のみを取得する場合は「false」を指定する

APIタグの詳細を取得する
api/3/action/tag_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するタグの「id」または、「name」を指定する

API指定した文字列が含まれたタグを検索する
api/3/action/tag_search
引数：
query
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string or list of strings
パラメータ説明

検索する文字列を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得する最大のタグ数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

API検索文字列に一致するタグの一覧を取得する
api/3/action/tag_autocomplete
引数：
q
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索クエリを指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得する最大のタグ件数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

limitを指定している場合、取得するオフセットの番号を指定する

データセット・リソース関連

APIデータセット一覧を取得する
api/3/action/package_list
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

APIデータセット一覧(リソースを含む)を取得する
api/3/action/current_package_list_with_resources
引数：
limit
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得する最大のデータセット件数を指定する

引数：
page
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

「limit」の値で複数ページに分割されたデータセット一覧から、返却対象とするページの番号を指定する

APIデータセットを検索する
api/3/action/package_ search
引数：
q
必須／オプション：
必須
デフォルト値：
*：*
戻り値のタイプ：
string
パラメータ説明

データセットの検索クエリを指定する

引数：
fq
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索フィルターを指定する

引数：
ort
必須／オプション：
オプション
デフォルト値：
relevance asc, metadata_modified desc
戻り値のタイプ：
string
パラメータ説明

データセット一覧のソート順を指定する
注：フィールド名称とソート順（「asc」または「desc」）を半角スペース区切リで設定し、複数のソート順を設定する場合はパラメータをカンマ区切りで与えること

引数：
rows
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得するデータセット数を指定する

引数：
start
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

複数ページに分割されたデータセット一覧を表示する場合、表示を開始するページ番号を指定する

引数：
facet
必須／オプション：
オプション
デフォルト値：
true
戻り値のタイプ：
string
パラメータ説明

ファセットを有効化する場合は「true」、無効化する場合は「false」を指定する

引数：
facet.mincount
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

ファセットが含むデータセットの最小数を指定する
この値よりもファセットが含むデータセット数が少ない場合は、そのファセットは表示されない

引数：
facet.limit
必須／オプション：
オプション
デフォルト値：
50
戻り値のタイプ：
int
パラメータ説明

ファセットの最大取得数を指定する。0より小さい値を指定した場合は全て取得される

引数：
facet.field
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
list of strings
パラメータ説明

ファセットを生成する対象のフィールド名を指定する。指定しなかった場合、ファセットは空値で返却される

APIデータセットの詳細を取得する
api/3/action/package_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するデータセットの「id」または、「name」を指定する

APIリソースの詳細を取得する
api/3/action/resource_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するリソースの「id」を指定する

APIリソースを検索する
api/3/action/resource_search
引数：
query
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string or list of strings of the form “{field}:{term1}”
パラメータ説明

リソースの検索クエリを指定する

引数：
order by
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソース一覧のソート順を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得する最大のデータセット件数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

APIデータセット更新履歴を取得する
api/3/action/package_activity_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するデータセットの「id」または、「name」を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
31
戻り値のタイプ：
int
パラメータ説明

取得する最大のアクティビティ数を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

APIデータセットのリビジョン履歴を取得する
api/3/action/package_revision_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

取得するデータセットの「id」または、「name」を指定する

API最近更新されたデータセット履歴を取得する
api/3/action/recently_changed_packages_activity_list
引数：
limit
必須／オプション：
オプション
デフォルト値：
31
戻り値のタイプ：
int
パラメータ説明

取得する最大のアクティビティ数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

APIデータセットの更新履歴をhtml形式で取得する
api/3/action/package_activity_list_html
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの「id」または「name」を指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
int
パラメータ説明

取得する最大の更新履歴件数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

API指定したデータセットと他のデータセットとの関係の一覧を取得する
api/3/action/package_relationships_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

一つ目のデータセットの「id」または「name」を指定する

引数：
id2
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

二つ目のデータセットの「id」または「name」を指定する

引数：
rel
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リレーションシップタイプを指定する

APIリソースビューの詳細を取得する
api/3/action/resource_view_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースビューの「id」を指定する

API特定リソースのリソースビューの一覧を取得する
api/3/action/resource_view_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースの「id」を指定する

API検索文字列に一致するデータセットの一覧を取得する
api/3/action/package_autocomplete
引数：
q
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索クエリを指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得する最大のリソース件数を指定する

API検索文字列に一致する拡張子の一覧を取得する
api/3/action/format_autocomplete
引数：
q
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索クエリを指定する

引数：
limit
必須／オプション：
オプション
デフォルト値：
10
戻り値のタイプ：
int
パラメータ説明

取得する最大の拡張子件数を指定する

APIライセンス一覧を取得する
api/3/action/license_list
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

フォロー機能関連

API指定したユーザのフォロワー人数を取得する
api/3/action/user_follower_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」または、「name」を指定する

API指定したデータセットのフォロワー人数を取得する
api/3/action/dataset_follower_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの「id」または、「name」を指定する

API指定したカテゴリのフォロワー人数を取得する
api/3/action/group_follower_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

カテゴリの「id」または、「name」を指定する

API指定した組織のフォロワー人数を取得する
api/3/action/organization_follower_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

組織の「id」または、「name」を指定する

API指定したデータセットのフォロー状況を取得する
api/3/action/am_following_dataset
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの「id」または、「name」を指定する

API指定したカテゴリのフォロー状況を取得する
api/3/action/am_following_group
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

カテゴリの「id」または、「name」を指定する

API指定したユーザがフォローしている数を取得する
api/3/action/followee_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」を指定する

API指定したユーザがフォローしているデータセット数を取得する
api/3/action/dataset_followee_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」を指定する

API指定したユーザがフォローしているカテゴリ数を取得する
api/3/action/group_followee_count
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」を指定する

API指定したユーザのフォロー一覧を取得する
api/3/action/followee_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」を指定する

引数：
q
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索クエリを指定する

API指定したユーザのデータセットフォロー一覧を取得する
api/3/action/dataset_followee_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」または、「name」を指定する

API指定したユーザのグループフォロー一覧を取得する
api/3/action/group_followee_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」または、「name」を指定する

API指定したユーザの組織フォロー一覧を取得する
api/3/action/organization_followee_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ユーザの「id」または、「name」を指定する

ダッシュボード関連

APIダッシュボードの更新履歴の一覧を取得する
api/3/action/dashboard_activity_list
引数：
limit
必須／オプション：
オプション
デフォルト値：
31
戻り値のタイプ：
int
パラメータ説明

取得する最大のアクティビティ数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

APIダッシュボードの更新履歴の一覧をhtml形式で取得する
api/3/action/dashboard_activity_list_html
引数：
limit
必須／オプション：
オプション
デフォルト値：
31
戻り値のタイプ：
int
パラメータ説明

取得する最大のアクティビティ数を指定する

引数：
offset
必須／オプション：
オプション
デフォルト値：
0
戻り値のタイプ：
int
パラメータ説明

取得するオフセットの番号を指定する

APIダッシュボード内の新着数を取得する
api/3/action/dashboard_new_activity_count
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

ＣＫＡＮ設定関連

APIサイトのリビジョン履歴を取得する
api/3/action/revision_list
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

APIリビジョンの詳細を取得する
api/3/action/revision_show
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リビジョンの「id」を指定する

APICKANの設定情報と拡張機能の一覧を取得する
api/3/action/status_show
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

API指定した更新情報の詳細を取得する
api/3/action/activity_detail_list
引数：
id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

更新情報の「id」を指定する

API指定したAPIのヘルプを取得する
api/3/action/help_show
引数：
name
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索対象のAPI名称を指定する

APICKANの設定情報を取得する
api/3/action/config_option_list
引数：
–
必須／オプション：
–
デフォルト値：
–
戻り値のタイプ：
–
パラメータ説明

API指定したCKAN設定情報の詳細を取得する
api/3/action/config_option_show
引数：
key
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

検索対象のCKAN設定項目名を指定する

データセット更新関連

API新規データセットを作成する
api/3/action/package_create
引数：
name
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

新規データセットの菜目を指定する。長さは2～100文字で、小文字の半角英数字および半角

引数：
title
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

新規データセットのタイトルを指定する。デフォルト値は菜目と同様である

引数：
private
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
boolean
パラメータ説明

trueを指定したい場合、作成するデータセットはプライベート扱いとなる

引数：
author
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの作成者の名称を指定する

引数：
author_email
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの作成者のE-mailアドレスを指定する

引数：
maintainer
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットのメンテナーの名称を指定する

引数：
maintainer_email
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットのメンテナーのメールアドレスを指定する

引数：
license_id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットのライセンスＩＤを指定する

引数：
notes
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットに関する説明を指定する

引数：
url
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットのソースＵＲＬを指定する

引数：
version
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットのバージョンを指定する。100文字以下でなければならない

引数：
state
必須／オプション：
オプション
デフォルト値：
active
戻り値のタイプ：
string
パラメータ説明

データセットのステータスを指定する。デフォルト：アクティブ

引数：
type
必須／オプション：
オプション
デフォルト値：
dataset
戻り値のタイプ：
string
パラメータ説明

作成するデータセットのタイプを指定する

引数：
tags
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
list of tag dictionaries
パラメータ説明

データセットのタグを指定する

引数：
groups
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
list of tag dictionaries
パラメータ説明

データセットが属するグループを指定する

引数：
owner_org
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットを所有する組織のＩＤを指定する

引数：
spatial
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
GeoJSON
パラメータ説明

データセットの領域を指定する。本パラメータを指定させると、地図でのデータセット検索でヒットさせることが可能である

引数：
quality
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの品質を指定する。本パラメータはＧ空間情報センター固有である

引数：
restriction
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの制約を指定する。本パラメータはＧ空間情報センター固有である

引数：
registerd_date
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの作成日時を指定する。本パラメータはＧ空間情報センター固有である

引数：
charge
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットが有償・無償の区分を指定する。本パラメータはＧ空間情報センター固有である
値：有償、無償

引数：
emergency
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

災害発生時におけるデータセットの取り扱いを指定する。本パラメータはＧ空間情報センター固有である
値：無償提供、条件付き無償提供、設定なし

引数：
area
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの地理的範囲を指定する。本パラメータはＧ空間情報センター固有である

引数：
fee
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットが有償の場合に価格情報を指定する。本パラメータはＧ空間情報センター固有である

引数：
license_agreement
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

データセットの使用許諾を指定する。本パラメータはＧ空間情報センター固有である

API特定のデータセットを更新する
api/3/action/package_update
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

更新対象のデータセット名あるいはデータセットＩＤを指定する
注意事項：ＡＰＩ経由でデータセットを更新すると、配下のリソースが削除される。また、データセット作成時に入力していたパラメータ値が未設定の場合、それらのパラメータ値はnullとなる

API特定のデータセットを削除する
api/3/action/package_delete
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

削除対象のデータセット名あるいはデータセットＩＤを指定する

リソース・リソースビュー更新関連

API新規リソースを作成する
api/3/action/resource_create
引数：
package_id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースを追加するデータセットのＩＤを指定する

引数：
url
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

登録したいファイルのパスあるいは外部ＵＲＬを指定する

引数：
description
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースに関する説明を指定する

引数：
format
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースの拡張子を指定する

引数：
name
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースのタイトルを指定する

引数：
metadata_type
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースのメタデータ形式を指定する。本パラメータはＧ空間情報センター固有である

引数：
data_crs
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースが空間データの場合に座標参照系を指定する

引数：
standard_price
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースが有償データの場合に標準価格をしている。本パラメータはＧ空間情報センター固有である

引数：
acknowledgement
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースを使用するにあたって留意すべき注意事項を指定する。本パラメータはＧ空間情報センター固有である

引数：
tos
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースの利用規約を指定する。本パラメータはＧ空間情報センター固有である

引数：
selection_type
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースが有償の場合、購入データの選択単位を指定する
値：空間、時間、時空間

API新規リソースビューを作成する
api/3/action/resource_view_create
引数：
resource_id
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

リソースのＩＤを指定する

引数：
title
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ビューのタイトルを指定する

引数：
description
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ビューに関する説明を指定する

引数：
view_type
必須／オプション：
必須
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

ビューのタイプを指定する

API特定のリソースを更新する
api/3/action/resource_update
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

更新対象のリソースＩＤを指定する

API特定のリソースビューを更新する
api/3/action/resource_view_update
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

更新対象のリソースビューＩＤを指定する

API特定のリソースを削除する
api/3/action/resource_delete
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

削除対象のリソースＩＤを指定する

API特定のリソースビューを削除する
api/3/action/resource_view_delete
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

削除対象のリソースビューＩＤを指定する

フォロー更新関連

API特定のユーザをフォローする
api/3/action/follow_user
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォロー対象のユーザ名あるいはユーザＩＤを指定する

API特定のデータセットをフォローする
api/3/action/follow_dataset
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォロー対象のデータセット名あるいはデータセットＩＤを指定する

API特定のカテゴリをフォローする
api/3/action/follow_group
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォロー対象のカテゴリ名あるいはカテゴリＩＤを指定する

API特定のユーザのフォローを中止する
api/3/action/unfollow_user
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォローを中止するユーザ名あるいはユーザＩＤを指定する

API特定のデータセットのフォローを中止する
api/3/action/unfollow_dataset
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォローを中止するデータセット名あるいはデータセットＩＤを指定する

API特定のカテゴリのフォローを中止する
api/3/action/unfollow_group
引数：
id
必須／オプション：
オプション
デフォルト値：
–
戻り値のタイプ：
string
パラメータ説明

フォローを中止するカテゴリ名あるいはカテゴリＩＤを指定する

4.ＡＰＩの利用例

G 空間情報センターのCKANAPI のベースURL は以下の通りです。
https://www.geospatial.jp/ckan/api/3/action/

4.1.API を利用した情報の取得例

引数がある場合は、以下のように指定します。

URL?引数名1=値1&引数名2=値2&引数名3=値3&…
（ア）組織に関するメタデータの取得
登録されている組織の一覧
https://www.geospatial.jp/ckan/api/3/action/organization_list
登録されている組織の一覧(各組織のメタ情報も取得）
https://www.geospatial.jp/ckan/api/3/action/organization_list?all_fields=true
登録されている組織の一覧（各組織のメタ情報を取得し、且つ組織のデータセット登録数順でソート）
https://www.geospatial.jp/ckan/api/3/action/organization_list?all_fields=true&order_by=packages
指定した組織の詳細情報（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_show?id=aigid
組織更新履歴を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_activity_list?id=aigid
組織のリビジョン履歴を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_revision_list?id=aigid
検索文字列に一致する組織の一覧を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_autocomplete?q=aigid
組織の更新履歴をhtml 形式で取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_activity_list_html?id=aigid
（イ）カテゴリに関するメタデータの取得
登録されているカテゴリの一覧
https://www.geospatial.jp/ckan/api/3/action/group_list
指定したカテゴリの詳細情報（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_show?id=gr-0100
グループ更新履歴を取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_activity_list?id=gr-0100
編集権限をもつカテゴリの一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/group_list_authz
グループのリビジョン履歴を取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_revision_list?id=gr-0100
カテゴリの更新履歴をhtml 形式で取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_activity_list_html?id=gr-0100
（ウ）タグに関するメタデータの取得
タグの一覧
https://www.geospatial.jp/ckan/api/3/action/tag_list
指定したタグ「全国」を含むデータセット名の一覧（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/package_search?q=*:*&facet.limit=10&facet.field=[“title_string”]&fq=tags:全国&rows=0

※検索結果にフィルターをかける際に、「fq」で指定できない項目があります。

指定したタグ「全国」を含むカテゴリの検索（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/package_search?q=*:*&facet.limit=10&facet.field=[“groups”]&fq=tags:全国&rows=0
キーワード「全国」を含むタグの検索
https://www.geospatial.jp/ckan/api/3/action/tag_search?query=全国
検索文字列「全国」に一致するタグの一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/tag_autocomplete?q=全国
（エ）データセットやリソースに関するメタデータの取得
データセット一覧(リソースを含む)を取得する
https://www.geospatial.jp/ckan/api/3/action/current_package_list_with_resources
検索条件に合うデータセット「AED」とそのデータセットに含まれるリソースの一覧
https://www.geospatial.jp/ckan/api/3/action/package_search?q=name:*aed*
指定したデータセット「AED」のメタデータ情報
https://www.geospatial.jp/ckan/api/3/action/package_show?id=aed
指定したリソース「全国AED 設置位置」のメタデータ情報
https://www.geospatial.jp/ckan/api/3/action/resource_show?id=bfc3b8da-073a-4e3b-98c7-ff2f40edb621
「name」属性にキーワード「全国」を含むリソースの検索（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/resource_search?query=name:全国&limit=10
データセット更新履歴を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_activity_list?id=aed
データセットのリビジョン履歴を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_revision_list?id=aed
指定したデータセットと他のデータセットとの関係の一覧を取得する（例．AED と避難場所）
https://www.geospatial.jp/ckan/api/3/action/package_relationships_list?id=aed&id2=hinanbasho
リソースビューの詳細を取得する(リソースビューのID を指定する）
https://www.geospatial.jp/ckan/api/3/action/resource_view_show?id=e7deded5-2efc-4833-8d0f-c52016a86f3f
特定リソースのリソースビューの一覧を取得する(リソースのID を指定する）
https://www.geospatial.jp/ckan/api/3/action/resource_view_list?id=2a5afb18-9a08-44bc-929d-ce891ea791e8
検索文字列に一致するデータセットの一覧を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_autocomplete?q=aed
検索文字列に一致する拡張子の一覧を取得する（例．csv）
https://www.geospatial.jp/ckan/api/3/action/format_autocomplete?q=csv
（オ）フォロー機能に関するメタデータの取得
指定したユーザのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/user_follower_count?id=[user]
指定したデータセットのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_follower_count?id=aed
指定したカテゴリのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/group_follower_count?id=gr-0100
指定した組織のフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/organization_follower_count?id=aigid
指定したデータセットのフォロー状況を取得する
https://www.geospatial.jp/ckan/api/3/action/am_following_dataset?id=aed
指定したカテゴリのフォロー状況を取得する
https://www.geospatial.jp/ckan/api/3/action/am_following_group?id=gr-0100
指定したユーザがフォローしている数を取得する
https://www.geospatial.jp/ckan/api/3/action/followee_count?id=[user]
指定したユーザがフォローしているデータセット数を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_followee_count?id=[user]
指定したユーザがフォローしているカテゴリ数を取得する
https://www.geospatial.jp/ckan/api/3/action/group_followee_count?id=[user]
指定したユーザのフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/followee_list?id=[user]
指定したユーザのデータセットフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_followee_list?id=[user]
指定したユーザのグループフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/group_followee_list?id=[user]
指定したユーザの組織フォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/organization_followee_list?id=[user]
（カ）ダッシュボードに関するメタデータの取得
ダッシュボードの更新履歴の一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_activity_list
ダッシュボードの更新履歴の一覧をhtml 形式で取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_activity_list_html
ダッシュボード内の新着数を取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_new_activity_count
（キ）CKANの設定に関するメタデータの取得
サイトのリビジョン履歴を取得する
https://www.geospatial.jp/ckan/api/3/action/revision_list
リビジョンの詳細を取得する(リビジョンID を指定）
https://www.geospatial.jp/ckan/api/3/action/revision_show?id=21a4831e-68b3-4b87-80a2-109360005b72
CKAN の設定情報と拡張機能の一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/status_show
指定した更新情報の詳細を取得する(リビジョンID を指定）
https://www.geospatial.jp/ckan/api/3/action/activity_detail_list?id=9d453869-9706-4096-93d5-67421fb17cbc
指定したAPI のヘルプを取得する（API 名を指定する）
https://www.geospatial.jp/ckan/api/3/action/help_show?name=revision_show
CKAN の設定情報を取得する
https://www.geospatial.jp/ckan/api/3/action/config_option_list
指定したCKAN 設定情報の詳細を取得する（設定情報をキーにする）
https://www.geospatial.jp/ckan/api/3/action/config_option_show?key=ckan.site_description
（ク）ライセンスID対応表
No .
license_id
ライセンスタイトル
1
gfdl
GNU Free Documentation License
2
CC-BY
クリエイティブ・コモンズ 表示
3
CC-BY-SA-4.0
クリエイティブ・コモンズ 表示 継承
4
cc-zero
クリエイティブ・コモンズ 表示 CCZero
5
cc-nc
クリエイティブ・コモンズ 表示 非商用
6
ODC-BY
Open Data Commons Attribution License
7
ODC-PDDL
Open Data Commons Public Domain Dedication and Licence
8
ODC-ODbL
Open Data Commons Open Database License
9
other-at
その他（表示）
10
other-open
その他（オープンライセンス）
11
other-closed
その他（非オープンライセンス）
12
other-pd
その他（パブリックドメイン）
13
other-nc
その他（非商用）
14
ogl
政府標準利用規約
15
ol
独自利用規約
16
notspecified
ライセンスが指定されていません
17
plateau
PLATEAU Site Policy 「３．著作権について」に拠る

※APIを使用してデータセットの作成・編集を行う場合は、ライセンスID対応表のlicense_idからライセンスを指定してください。

4-2. プライベートデータのメタデータ取得

プライベートデータの情報を取得する場合は、閲覧権限のあるユーザのAPI キーが必要となります。API キーを使用する場合はcurl コマンドを用い、オプションは以下のように設定します。curl コマンドはwindows のコマンドプロンプト（curl のインストールが必要）やlinuxOS 上で使用します。

引数の指定

-d ‘{“引数1″:”値1″,”引数2″:”値2″,”引数3″:”値3”,,,}’

API キーの指定

-H “X-CKAN-API-Key:<API キー>”
curl https://www.geospatial.jp/ckan/api/3/action/resource_show -d'{“id”:”値”}’ -H “XCKAN-API-Key:<API キー>“

4-3. API を利用した登録、更新、削除例

データの登録、更新、削除 は編集権限を持つユーザのAPI キーが必要となります。
API キーを使用する場合はcurl コマンドを用います。curl コマンドはwindows のコマンドプロンプト（curl のインストールが必要）やlinuxOS 上で使用します。コマンドオプションは以下のように設定します。

引数の指定

-d ‘{“引数1″:”値1″,”引数2″:”値2″,”引数3″:”値3”,,,}’

API キーの指定

-H “X-CKAN-API-Key:<API キー>”
（ア）データセットに関する更新
新規データセットを作成する
curl https://www.geospatial.jp/ckan/api/3/action/package_create -d ‘{“name”:”値”,”private”,”true”,”owner_org”:”値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のデータセットを更新する
curl https://www.geospatial.jp/ckan/api/3/action/package_update -d ‘{“id”:”値”,”name”:”値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のデータセットを削除する
curl https://www.geospatial.jp/ckan/api/3/action/package_delete -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
（イ）リソースおよびリソースビューに関する更新
新規リソースを作成する
curl https://www.geospatial.jp/ckan/api/3/action/resource_create -d ‘{“packageid”:”値”,”url”,”値”}’ -H “X-CKAN-API-Key:<API キー>“
新規リソースビューを作成する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_create -d ‘{“resource_id”:”値”,”title”,”値”,”view_type”:”値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のリソースを更新する
curl https://www.geospatial.jp/ckan/api/3/action/resource_update -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のリソースビューを更新する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_update -d ‘{“id”:”値”}’-H “X-CKAN-API-Key:<API キー>“
特定のリソースを削除する
curl https://www.geospatial.jp/ckan/api/3/action/resource_delete -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のリソースビューを削除する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_delete -d ‘{“id”:”値”}’-H “X-CKAN-API-Key:<API キー>“
（ウ）フォローに関する更新
特定のユーザをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_user -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のデータセットをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_dataset -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のカテゴリをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_group -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のユーザのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_user -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のデータセットのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_dataset -d ‘{“id”:”値”}’ -H “X-CKAN-API-Key:<API キー>“
特定のカテゴリのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_group -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

4-4. データセット作成・編集時のバリデーションチェック

（ア）必須・任意項目表
No .
メタデータ名
データセット項目名
必須
型
入力例
1
title
タイトル
〇
string
{ “title”: “データセットのタイトル”}
2
name
URL
〇
string
{ “name”: “データセットのURL”}
※すでに使用中のURLは使用できません
3
notes
説明
〇
string
{ “notes”: “データセットの説明”}
4
tags
タグ
list(string)
{ “tags”: [{“name”: “データセットのタグ”}] }
5
license_id
ライセンス
〇
string
{ “license_id”: “データセットのライセンスID” }
6
owner_org
組織
〇
string
{ “owner_olg”: “データセットの組織ID” }
例：{ “owner_olg”: “aigid” }
7
private
公開・非公開
bool
{“private”:false}
true：非公開
false ：公開
※指定しなければ公開となります
8
author
作成者
〇
string
{ “author”: “データセットの作成者”}
9
author_email
作成者のemail
〇
string
{ “author_email”: “データセットの作成者のemail” }
※連絡の取れるメールアドレスを記入します
10
maintainer
メンテナー
〇
string
{ “maintainer”: “データセットのメンテナー” }
11
maintainer_email
メンテナーのemail
〇
string
{“maintainer_email”: “データセットのメンテナーのemail” }
※連絡の取れるメールアドレスを記入します
12
spatial
Spatial
areaから計算した地理的範囲が自動入力されます
13
quality
データ品質
string
{ “quality”: “データセットのデータ品質” }
14
restriction
制約
string
{ “restriction”: “データセットの制約” }
15
registerd_date
データ作成日
string
{ “registerd_date”: “データセットのデータ作成日” }
16
charge
有償無償区分
string
{ “charge”: “データセットの有償無償区分” }
例：
{ “charge”: “無償” }
・有償
・無償
上記のいずれかを選択します
17
emergency
災害時区分
string
{ “emergency”: “データセットの災害区分” }
例：
{ “emergency”: “条件付き無償提供” }災害時の無償区分
・設定なし
・条件付き無償提供
・無償提供
上記のいずれかを選択します
18
area
市区町村名
〇
string
{ “area”: “データセットの市区町村名” }
例：
{ “area”: “埼玉県_狭山市” }”日本全国””〇〇地方”
（例：北海道、東北、関東、中部、関西、四国、中国、九州）

“都道府県”
（例：北海道, 東京都, 大阪府　など）

“都道府県_市区町村”
（例：埼玉県_川越市, 東京都_渋谷区, 静岡県_静岡市, 奈良県_上北山村　など）
19
thumbnail_url
サムネイル
string
{ “thumbnail_url”: “データセットのサムネイルURL” }
20
fee
価格情報
string
{ “fee”: “データセットの価格情報” }
※有償データの場合、基本単位の定価を記入します
21
license_agreement
使用許諾
string
{“license_agreement”: “データセットの使用許諾” }
（イ）データセット登録時のAPI例
Windows環境（コマンドプロンプト）
curl https://www.geospatial.jp/ckan/api/3/action/package_create -H “X-CKAN-API-Key: <API キー>” -d @metadata.json

metadata.json
{
  “title”: “example”,
  “name”: “example”,
  “private”: false,
  “notes”: “example”,
  “tags”: [
    {
      “name”: “example”
    }
],
“license_id”: “CC-BY”,
“author”: “example”,
“author_email”: “example@email.com”,
“maintainer”: “example”,
“maintainer_email”: “example@email.com”,
“registerd_date”: “2024/10/7”,
“area”: “埼玉県_川越市”,
“owner_org”: “aigid”,
“quality”: “example”,
“restriction”: “・example”,
“charge”: “無償”,
“emergency”: “設定なし”,
“thumbnail_url”: “https://example.com”,
“fee”: “example”,
“license_agreement”: “example”
}
Linux環境

curl https://www.geospatial.jp/ckan/api/3/action/package_create -H “X-CKAN-API-Key: <API キー>” -d ‘{ “title”: “example”, “name”: “example”, “private”: false, “notes”: “example”, “tags”: [{“name”: “example”}], “license_id”: “CC-BY”, “author”: “example”, “author_email”: “example@email.com”, “maintainer”: “example”, “maintainer_email”: “example@email.com”, “registerd_date”: “2024/10/7”, “area”: “埼玉県_川越市”, “owner_org”: “aigid”, “quality”: “example”, “restriction”: “・example”, “charge”: “無償”, “emergency”: “設定なし”, “thumbnail_url”: “https://example.com”, “fee”: “example”, “license_agreement”: “example” }’

マイページを利用する
使い方（マニュアル）に戻る
リンクバナーについて
マニュアル
FAQ

私たちは最適なウェブ体験を提供するためにCookieを利用しています。このサイトを引き続き閲覧することで、あなたはCookieの使用に同意していることになります。

OK プライバシーポリシー