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

G 空間情報センター

API 利用マニュアル内容
1.共通連携基盤（ＡＰＩ）とは ............................................................................................ 2
2. API キーおよび ID の確認 ................................................................................................ 2
2-1.ユーザ API キーおよびユーザＩＤの確認 .................................................................. 2
2-2.組織 ID の確認 ............................................................................................................ 3
2-3.カテゴリＩＤの確認 .................................................................................................... 4
2-4.データセットＩＤの確認............................................................................................. 4
2-5.リソースＩＤの確認 .................................................................................................... 4
3.ＡＰＩの一覧 ..................................................................................................................... 5
4.ＡＰＩの利用例.................................................................................................................. 9
4.1.API を利用した情報の取得例 ..................................................................................... 9（ア）組織に関するメタデータの取得 .......................................................................... 9（イ）カテゴリに関するメタデータの取得................................................................. 10（ウ）タグに関するメタデータの取得 ........................................................................ 10（エ）データセットやリソースに関するメタデータの取得........................................ 11（オ）フォロー機能に関するメタデータの取得 ......................................................... 12（カ）ダッシュボードに関するメタデータの取得 ...................................................... 13（キ）ＣＫＡＮの設定に関するメタデータの取得 ...................................................... 13
4-2 プライベートデータのメタデータ取得 ..................................................................... 14
4-3 API を利用した登録、更新、削除例 ......................................................................... 15（ア）データセットに関する更新 ............................................................................... 15（イ）リソースおよびリソースビューに関する更新 .................................................. 15（ウ）フォローに関する更新 ...................................................................................... 16

1

G 空間情報センター

API 利用マニュアル

1.共通連携基盤（ＡＰＩ）とは
G 空間情報センターではシステム連携を実現するため、各システムから共通で使用可能な G
空間情報センター側の共通連携基盤（API）（以降、API）を実装しています。API は、URL+

引数で構成されています。一例として、ブラウザ上で API の URL を指定すると、実行結果が表示されます。

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

また、ユーザ名＝ユーザ ID として、ユーザ ID を引数に指定するＡＰＩが利用できます。

2

G 空間情報センター

API 利用マニュアル
利用マニュアルユーザ名（=ユーザＩＤ）
ユーザ名（ ユーザＩＤ）

API キー

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

3

G 空間情報センター

API 利用マニュアル

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

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

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

リソース ID

4

G 空間情報センター

API 利用マニュアル

3.ＡＰＩの一覧
Ｇ空間情報センターで提供されるＡＰＩの一覧を次ページに示します。

5

G 空間情報センター

API 利用マニュアル

必須／オ デフォ 戻り値のパラメータ説明
プション ルト値
タイプ
1 api/3/action/package_list
データセット一覧を取得する。
取得する最大のデータセット件数を指定す
limit オプション
10 intる。
api/3/action/current_package_list_ データセット一覧(リソースを含む)を
2「limit」の値で複数ページに分割されたデータ
with_resources
取得する。
page オプション
0 int
セット一覧から、返却対象とするページの番号を指定する。
nameでソートする場合は「name」、データ
order_
オプション name string
セット数でソートする場合は「packages」を指
by
定する。
group
list ofオプション 取得するグループの名称を指定する。
3 api/3/action/group_list
グループ一覧を取得する。
sstrings
すべてメタデータ項目を取得する場合は
all_fiel「true」、
オプション false
booleands「name」のみを取得する場合は「false」を指定する。
nameでソートする場合は「name」、データ
order_
オプション name string
セット数でソートする場合は「packages」を指by定する。
organilist ofzation オプション 取得する組織の名称を指定する。
4 api/3/action/organization_list
組織一覧を取得する。
stringss

No. API

説明

引数

all_fiel
オプション falsedsboolean

5 api/3/action/license_list

ライセンス一覧を取得する。

query オプション -string

6 api/3/action/tag_list

タグ一覧を取得する。

all_fiel
オプション falsedsboolean

7 api/3/action/package_show

データセットの詳細を取得する。

id

必須

-

string

8 api/3/action/resource_show
9 api/3/action/group_show

リソースの詳細を取得する。
グループの詳細を取得する。

id
id

必須
必須

-

stringstring

10 api/3/action/organization_show

組織の詳細を取得する。

id必須

string

11 api/3/action/group_package_show

グループのデータセット一覧を取得 id
する。
limit

必須

stringオプション -

int

12 api/3/action/tag_show

タグの詳細を取得する。

id必須

string

q
fq

rows

必須
*：*
stringオプション string
relevance asc,オプション metadat string
a_modifi
ed descオプション
10 int

start

オプション

sort

13 api/3/action/package_search

14 api/3/action/resource_search

0 int

facet オプション true

stringfacet.
minco オプション unt

int

facet.l
オプション
imit

50 int

データセットを検索する。

facet.f
オプション ield

list ofstrings

query 必須

string orlist ofstrings of
リソースの検索クエリを指定する。
the form“{field}:{te
rm1}”

-

リソースを検索する。
order_
オプション by
limit

オプション -

offset オプション

15 api/3/action/tag_search

指定した文字列が含まれたタグを検索する。

すべてメタデータ項目を取得する場合は「true」、「name」のみを取得する場合は「false」を指定する。
取得するタグに含まれる文字列を指定する。
すべてメタデータ項目を取得する場合は「true」、「name」のみを取得する場合は「false」を指定する。
取得するデータセットの「id」または、「name」
を指定する。
取得するリソースの「id」を指定する。
取得するグループの「id」を指定する。
取得する組織の「id」または、「name」を指定する。
取得するグループの「id」または、「name」を指定する。
取得する最大のグループ数を指定する。
取得するタグの「id」または、「name」を指定する。
データセットの検索クエリを指定する。
検索フィルターを指定する。
データセット一覧のソート順を指定する。
注：フィールド名称とソート順（「asc」または「desc」）を半角スペース区切リで設定し、複数のソート順を設定する場合はパラメータを
カンマ区切りで与えること。
取得するデータセット数を指定する。
複数ページに分割されたデータセット一覧を表示する場合、表示を開始するページ番号を指定する。
ファセットを有効化する場合は「true」、無効化する場合は「false」を指定する。
ファセットが含むデータセットの最小数を指定する。
この値よりもファセットが含むデータセット数が少ない場合は、そのファセットは表示されない。
ファセットの最大取得数を指定する。
0より小さい値を指定した場合は全て取得される。
ファセットを生成する対象のフィールド名を指定する。
指定しなかった場合、ファセットは空値で返却される。

query 必須-

limit オプション offset オプション -6

stringint
0 int
string orlist ofstrings
int
int

リソース一覧のソート順を指定する。
取得する最大のデータセット件数を指定する。
取得するオフセットの番号を指定する。
検索する文字列を指定する。
取得する最大のタグ数を指定する。
取得するオフセットの番号を指定する。

G 空間情報センター

16 api/3/action/package_activity_list

API 利用マニュアル

データセット更新履歴を取得する。

id

必須

limit

オプション

-

31 intoffset オプション

17 api/3/action/group_activity_list

グループ更新履歴を取得する。

id

必須

limit

オプション

0 int
-

api/3/action/organization_activity_li
組織更新履歴を取得する。
st

id

必須

0 int
-

api/3/action/recently_changed_pac 最近更新されたデータセット履歴を limit オプション
kages_activity_list
取得する。
offset オプション
20 api/3/action/revision_list
サイトのリビジョン履歴を取得する データセットのリビジョン履歴を取得
21 api/3/action/package_revision_list
id
必須
する

19

23 api/3/action/group_list_authz

編集権限をもつカテゴリの一覧を取 am_m
オプション
得する
ember

グループのリビジョン履歴を取得する
api/3/action/organization_revision_l26
組織のリビジョン履歴を取得する
ist

25 api/3/action/group_revision_list28

api/3/action/package_rerationhips_l 指定したデータセットと他のデータ
ist
セットとの関係の一覧を取得する

29 api/3/action/resource_view_show

string31 intoffset オプション
18

stringstring31 int0 int
string

FALSE boolean

取得するデータセットの「id」または、「name」
を指定する。
取得する最大のアクティビティ数を指定する。
取得するオフセットの番号を指定する。
取得するグループの「id」または、「name」を指定する。
取得する最大のアクティビティ数を指定する。
取得するオフセットの番号を指定する。
取得する組織の「id」または、「name」を指定する。
取得する最大のアクティビティ数を指定する。
取得するオフセットの番号を指定する。
取得するデータセットの「id」または、「name」
を指定する「True」の場合はログインユーザが所属するグループのみが返却され、「False」の場合はユーザの「name」または「id」を指定する。

id

必須

-

stringid

必須-

stringid

必須-

stringid2

必須-

stringrel
id

オプション 必須-

stringstring

データセットの「id」または、「name」を指定す
る
一つ目のデータセットの「id」または「name」を指定する
二つ目のデータの「id」または「name」指定する
リレーションシップタイプを指定する
リソースビューの「id」を指定する-

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

stringstring10 intstring10 intstring10 intstring10 int

リソースビューの詳細を取得する
特定リソースのリソースビューの一id
必須覧を取得する31 api/3/action/revision_show
リビジョンの詳細を取得する
id必須
api/3/action/package_autocomplet 検索文字列に一致するデータセット q必須
33eの一覧を取得する
limit オプション
検索文字列に一致する拡張子の一 q
必須
34 api/3/action/format_autocomplete
覧を取得する
limit オプション
api/3/action/organization_autocom 検索文字列に一致する組織の一覧 q
必須
36
plete
を取得する
limit オプションq
必須
検索文字列に一致するタグの一覧 limit オプション
37 api/3/action/tag_autocomplete
を取得する
offset オプション

30 api/3/action/resource_view_list

CKANの設定情報と拡張機能の一39 api/3/action/status_show
覧を取得する
指定した更新情報の詳細を取得す
41 api/3/action/activity_detail_list
id
必須
る
id
必須
api/3/action/package_activity_list_h データセットの更新履歴をhtml形式
43
limit オプション
tml
で取得する
offset オプション
id
必須
カテゴリの更新履歴をhtml形式で取44 api/3/action/group_activity_list_html
limit オプション
得する
offset オプション
api/3/action/organization_activity_li 組織の更新履歴をhtml形式で取得
45
id
必須
st_html
する
指定したユーザのフォロワー人数を
46 api/3/action/user_follower_count
id
必須
取得する
api/3/action/dataset_follower_coun 指定したデータセットのフォロワー人
47
id
必須
t
数を取得する
指定したカテゴリのフォロワー人数を
48 api/3/action/group_follower_count
id
必須
取得する
api/3/action/organization_follower_ 指定した組織のフォロワー人数を取
49
id
必須
count
得する
指定したデータセットのフォロー状況
id
必須
を取得する
指定したカテゴリのフォロー状況を取56 api/3/action/am_following_group
id
必須
得する
指定したユーザがフォローしている
57 api/3/action/followee_countid
必須数を取得する
api/3/action/dataset_followee_cou 指定したユーザがフォローしている
59
id
必須
nt
データセット数を取得する指定したユーザがフォローしている
60 api/3/action/group_followee_countid
必須
カテゴリ数を取得する指定したユーザのフォロー一覧を取 id
必須
61 api/3/action/followee_list
得する
q
オプション
指定したユーザのデータセットフォ
63 api/3/action/dataset_followee_list
id
必須
ロー一覧を取得する指定したユーザのグループフォロー
64 api/3/action/group_followee_list
id
必須
一覧を取得する
api/3/action/organization_followee_ 指定したユーザの組織フォロー一覧
65
id
必須
list
を取得する
ダッシュボードの更新履歴の一覧を limit オプション
66 api/3/action/dashboard_activity_list
取得する
offset オプション
api/3/action/dashboard_activity_list ダッシュボードの更新履歴の一覧を limit オプション
67_html
html形式で取得する
offset オプション
55 api/3/action/am_following_dataset

7-

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

リビジョンの「id」を指定する
検索クエリを指定する
取得する最大のリソース件数を指定する
検索クエリを指定する
取得する最大の拡張子件数を指定する
検索クエリを指定する
取得する最大の組織件数を指定する
検索クエリを指定する
取得する最大のタグ件数を指定する
limitを指定している場合、取得するオフセットの番号を指定する-

string----string

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

stringint
0 int
string
int
0 int

-

データセットの「id」または「name」を指定する
取得する最大の更新履歴件数を指定する
取得するオフセットの番号を指定する。
カテゴリの「id」または「name」を指定する
取得する最大の更新履歴件数を指定する
取得するオフセットの番号を指定する。

-

string

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

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

string

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

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

string

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

string

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

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

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

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

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

stringstringカテゴリの「id」または「name」を指定する
検索クエリを指定する-

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

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

string31 int0 int
31 int0 int

カテゴリの「id」または「name」を指定する
取得する最大のアクティビティ数を指定する
取得するオフセットの番号を指定する。
取得する最大のアクティビティ数を指定する
取得するオフセットの番号を指定する。

G 空間情報センター

API 利用マニュアル

api/3/action/dashboard_new_activit ダッシュボード内の新着数を取得す
y_count
る
70 api/3/action/help_show
指定したAPIのヘルプを取得する
name
71 api/3/action/config_option_list
CKANの設定情報を取得する指定したCKAN設定情報の詳細を取
72 api/3/action/config_option_show
key
得する

68

-

-

-

-

必須
-

-

string-

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

必須

-

string

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

name 必須-

stringオプション -

stringtitle

privat必須eauthor オプション
authorオプション_emailmaintaオプション
iner
maintainer_e オプション
maillicensオプション
e_id
notes オプション
url
オプション
versioオプション
n-boolean-string-string-string

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

string

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

string

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

stringstring-string

データセットに関する説明を指定する
データセットのソースＵＲＬを指定する
データセットのバージョンを指定する。100文
字以下でなければならない
データセットのステータスを指定する。デフォ
ルト：アクティブ
作成するデータセットのタイプを指定する

state オプション active
type

73 api/3/action/package_create

新規データセットを作成する

74 api/3/action/resource_create

新規リソースを作成する

新規データセットの菜目を指定する。長さは２～100文字で、小文字の半角英数字および半角
新規データセットのタイトルを指定する。デ
フォルト値は菜目と同様である
trueを指定したい場合、作成するデータセット
はプライベート扱いとなる
データセットの作成者の名称を指定する
データセットの作成者のE-mailアドレスを指定する

stringオプション dataset string
list of tag
tags オプション dictionarie データセットのタグを指定する
slist of tag
group
オプション dictionarie データセットが属するグループを指定する
s
s
owner
必須
string
データセットを所有する組織のＩＤを指定する_org
データセットの領域を指定する。本パラメータ
spatial オプション GeoJSON を指定させると、地図でのデータセット検索でヒットさせることが可能である
データセットの品質を指定する。本パラメータ
quality オプション string
はＧ空間情報センター固有である
restric
データセットの制約を指定する。本パラメータ
オプション stringtion
はＧ空間情報センター固有である
regist
データセットの作成日時を指定する。本パラ
erd_da オプション string
メータはＧ空間情報センター固有である
te
データセットが有償・無償の区分を指定す
charg
オプション string
る。本パラメータはＧ空間情報センター固有eである。値：有償、無償
災害発生時におけるデータセットの取り扱い
emergを指定する。本パラメータはＧ空間情報センオプション stringency
ター固有である。値：無償提供、条件付き無償提供、設定なし
データセットの地理的範囲を指定する。本パ
area オプション string
ラメータはＧ空間情報センター固有である
データセットが有償の場合に価格情報を指fee
オプション string
定する。本パラメータはＧ空間情報センター
固有である
licens
データセットの使用許諾を指定する。本パラ
e_agre オプション string
メータはＧ空間情報センター固有である
ement
リソースを追加するデータセットのＩＤを指定
packa
必須
stringge_id
する
登録したいファイルのパスあるいは外部ＵＲ
url必須
string
Ｌを指定する
descriオプション string
リソースに関する説明を指定する
ption
format オプション string
リソースの拡張子を指定する
name オプション string
リソースのタイトルを指定する
metad
リソースのメタデータ形式を指定する。本パラ
ata_ty オプション string
メータはＧ空間情報センター固有である
pe
data_cリソースが空間データの場合に座標参照系
オプション string
rsを指定する
standa
リソースが有償データの場合に標準価格をしrd_pric オプション stringている。本パラメータはＧ空間情報センター
e
固有である
ackno
リソースを使用するにあたって留意すべき注
wledg オプション string
意事項を指定する。本パラメータはＧ空間情
ement
報センター固有であるリソースの利用規約を指定する。本パラメー
tos
オプション string
タはＧ空間情報センター固有である
selectリソースが有償の場合、購入データの選択
ion_ty オプション string
単位を指定する。値：空間、時間、時空間
pe8

G 空間情報センター

API 利用マニュアル

75 api/3/action/resource_view_create 新規リソースビューを作成する

resour
必須
ce_id
title
必須
descriオプション
ption
view_t必須
ype-string76 api/3/action/follow_user

特定のユーザをフォローする

id

オプション -

string77 api/3/action/follow_dataset

特定のデータセットをフォローする

id

オプション -

string79 api/3/action/follow_group

特定のカテゴリをフォローする-

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

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

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

id

オプション -

string80 api/3/action/resource_update
特定のリソースを更新する
81 api/3/action/resource_view_update 特定のリソースビューを更新する

id
id

オプション オプション -stringstring82 api/3/action/package_update

特定のデータセットを更新する

id

オプション -

string

83 api/3/action/package_delete

特定のデータセットを削除する

idオプション -

stringid
id

オプション オプション -stringstring

特定のユーザのフォローを中止する id

オプション -

stringオプション -

stringオプション -

string

特定のリソースを削除する
84 api/3/action/resource_delete
85 api/3/action/resource_view_delete 特定のリソースビューを削除する
86 api/3/action/unfollow_user
87 api/3/action/unfollow_dataset
89 api/3/action/unfollow_group

特定のデータセットのフォローを中止
idする
特定のカテゴリのフォローを中止すid
る

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

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
9

G 空間情報センター

API 利用マニュアル

指定した組織の詳細情報（例.一般社団法人社会基盤情報流通推進協議会)
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（ウ）タグに関するメタデータの取得
タグの一覧
10

G 空間情報センター

API 利用マニュアル

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&f
acet.field=["title_string"]&fq=tags:全国&rows=0
指定したタグ「全国」を含むカテゴリの検索（10 件取得指定）https://www.geospatial.jp/ckan/api/3/action/package_search?q=*:*&facet.limit=10&f
acet.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-9
8c7-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
11

G 空間情報センター

API 利用マニュアル

データセットのリビジョン履歴を取得する（例．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-4
833-8d0f-c52016a86f3f
特定リソースのリソースビューの一覧を取得する(リソースの ID を指定する）
https://www.geospatial.jp/ckan/api/3/action/resource_view_list?id=2a5afb18-9a08-44
bc-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
12

G 空間情報センター

API 利用マニュアル

指定したカテゴリのフォロー状況を取得する
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（キ）ＣＫＡＮの設定に関するメタデータの取得
サイトのリビジョン履歴を取得する
13

G 空間情報センター

API 利用マニュアル

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-8
0a2-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-40
96-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
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
14

G 空間情報センター

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 キー>“
注意事項：ＡＰＩ経由でデータセットを更新すると、配下のリソースが削除されます。
また、データセット作成時に入力していたパラメータ値が未設定の場合、それらのパラ
メータ値は null となります。
特定のデータセットを削除する
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 キー>“15

G 空間情報センター

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 キー>“16

G 空間情報センター

API 利用マニュアル

特定のカテゴリのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_group -d '{"id":" 値 "}' -H"X-CKAN-API-Key: <API キー>“17