2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md

APIリクエストサンプル 統合検索機能 利⽤者向けVer 1.00
2022/07/22

改訂履歴
改定⽇

バージョン

改訂内容

xxxx/xx/xx

Ver x.xx

xxxxxxxxx

1 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md

各APIリクエストサンプル
1-1メタデータ検索機能
URL
メソッド
JSONリクエストサンプル
検索結果に付加するフィールド(fields)
検索対象機関の指定(institute)
検索対象機関データベースの指定(database)
検索結果の並び順をデータベースのヒット数を多い順に並び替える。
(groupByDatabase)
特定のフィールドを検索対象とする(field指定)
全フィールドを検索対象とする(field指定なし)
完全⼀致("match": "is")前⽅⼀致("match": "is")
後⽅⼀致("match": "end")
部分⼀致("match": "contain")
正規表現("match": "regex")
時間範囲（〜以前）("operator" : "LE")時間範囲（〜以降）("operator" : "GE")
時間範囲（〜から〜の間）("operator" : "BETWEEN")
空間範囲（北⻄及び南東の経緯度座標）
論理演算（AND）
論理演算（OR）
論理演算（NOT）(A OR B) AND C
NOT(A AND B)
配列形式により複数の研究資源 ID を指定する
異体字同定
データ並び替え
1-2メタデータ検索(HIT数)
機能
URL
メソッド
JSONリクエストサンプル
1-3メタデータ取得(GET)
機能
URL
メソッド
1-3メタデータ取得(POST)
機能
URL
メソッド
JSONリクエストサンプル

各APIリクエストサンプル
2 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md

1-1メタデータ検索機能
メタデータを検索し、該当する研究資源の⼀覧を取得します。

URL
https://api.bridge.nihu.jp/v1/integratedsearch/metadatas/search/

メソッド
POST

JSONリクエストサンプル
検索結果に付加するフィールド(fields)
指定可能フィールドは『API仕様書_統合検索機能_利⽤者向け』AAppendix

フィールド⼀覧を参照。

{"query": {"conditions": [{"queries": [{"query": {"terms": ["京都"]}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

検索対象機関の指定(institute)
指定可能データベースIDは『API仕様書_統合検索機能_利⽤者向け』Appendix 機関ID⼀覧を参照。

3 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md{"institute": ["ircjs","nmjh"],"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

検索対象機関データベースの指定(database)
指定可能データベースIDは『API仕様書_統合検索機能_利⽤者向け』Appendix 機関データベース⼀覧
を参照。

{"database": ["ircjs_ir","nmjh_kanzoukinsei_kindai"],"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}}]
4 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

検索結果の並び順をデータベースのヒット数を多い順に並び替える。 (groupByDatabase){"groupByDatabase": true,"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]
}
}
]
}
],
"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

特定のフィールドを検索対象とする(field指定)
指定可能フィールドは『API仕様書_統合検索機能_利⽤者向け』AAppendix
上記資料にて『検索でのfieldへの指定可能』が〇のフィールドが指定可能。

{"query": {5 / 21

フィールド⼀覧を参照。

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

全フィールドを検索対象とする(field指定なし){"query": {"conditions": [{"queries": [{"query": {"terms": ["京都"]}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

完全⼀致("match": "is")6 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md{"query": {"conditions": [{"queries": [{"query": {"field": "researchResourceId","terms": ["16477620"],"match": "is"}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

前⽅⼀致("match": "is"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"],"match": "start"
}
}
]
}
],
"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100
7 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md}}}

後⽅⼀致("match": "end"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"],"match": "end"}}]}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

部分⼀致("match": "contain"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"],"match": "contain"}}]}
8 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

正規表現("match": "regex"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都(市|府)"],"match": "regex"
}
}
]
}
],
"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

時間範囲（〜以前）("operator" : "LE"){"query": {"conditions": [{"queries": [{9 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"query": {"field": "title","terms": ["京都"]}},{"connect": "AND","query": {"field": "temporal","term": "1100-03-31T00:00:00+09:00","operator": "LE"}}]}],"fields": ["title","temporal","researchResourceId"],"paging": {"start": 0,"size": 100}}}

時間範囲（〜以降）("operator" : "GE"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}},{"connect": "AND","query": {"field": "temporal","term": "1100-03-31T00:00:00+09:00","operator": "GE"}}]}10 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md],"fields": ["title","temporal","researchResourceId"],"paging": {"start": 0,"size": 100}}}

時間範囲（〜から〜の間）("operator" : "BETWEEN"){"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}},{"connect": "AND","query": {"field": "temporal","term": "1824-01-31T00:00:00+09:00,1825-02-17T00:00:00+09:00","operator": "BETWEEN"}}]}],"fields": ["title","temporal","researchResourceId"],"paging": {"start": 0,"size": 100}}}

空間範囲（北⻄及び南東の経緯度座標）
11 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]}},{"connect": "AND","query": {"field": "spatial","term": "(35.0,135.0),(30.0,130.0)"
}
}
]
}
],
"fields": ["title","spatial","researchResourceId"],"paging": {"start": 0,"size": 100}}}

論理演算（AND）{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["江⼾"]}},{"connect": "AND","query": {"field": "creator",
12 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"terms": ["広重"]
}
}
]
}
],
"fields": ["title","creator","researchResourceId"],"paging": {"start": 0,"size": 100}}}

論理演算（OR）{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["江⼾"]}},{"connect": "OR","query": {"field": "creator","terms": ["広重"]
}
}
]
}
],
"fields": ["title","creator","researchResourceId"],"paging": {"start": 0,"size": 100}
13 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md}}

論理演算（NOT）{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["江⼾"]}},{"connect": "AND","query": {"field": "creator","terms": ["広重"],"negation": true}}]}],"fields": ["title","creator","researchResourceId"],"paging": {"start": 0,"size": 100}}}

(A OR B) AND C{"query": {"conditions": [{"queries": [{"query": {14 / 212022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"field": "title","terms": ["江⼾"]}},{"connect": "OR","query": {"field": "creator","terms": ["広重"]
}
}
]
},
{
"connect" : "AND","query" : {"field": "description","terms": ["ロシア"],"match": "contain"}}],"fields": ["title","creator","description","researchResourceId"],"paging": {"start": 0,"size": 100}}}

NOT(A AND B){"query": {"conditions": [{"negation": true,"queries": [{"query": {"field": "title","terms": ["江⼾"]}},{"connect": "OR",15 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"query": {"field": "creator","terms": ["広重"]
}
}
]
}
],
"fields": ["title","creator","researchResourceId"],"paging": {"start": 0,"size": 100}}}

配列形式により複数の研究資源 ID を指定する{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["江⼾"]}},{"connect": "AND","query": {"field": "researchResourceId","terms": ["10027251","10049918","10053092"]
}
}
]
}
],
"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}
16 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md}}

異体字同定"normalize": true, 異体字同定を⾏う(既定値){"query": {"conditions": [{"query": {"field": "title","terms": ["萬福寺"],"match": "contain","normalize": true}}],"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100}}}

"normalize": false, 異体字同定を⾏わない{"query": {"conditions": [{"query": {"field": "title","terms": ["萬福寺"],"match": "contain","normalize": false}}],"fields": ["title","researchResourceId"],"paging": {17 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md"start": 0,"size": 100}}
}データ並び替え{"query": {"conditions": [{"queries": [{"query": {"field": "title","terms": ["京都"]
}
}
]
}
],
"fields": ["title","researchResourceId"],"paging": {"start": 0,"size": 100},"sort": [{"field": "researchResourceId","order": "desc"},{"field": "title","order": "asc"}]}}

18 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md

1-2メタデータ検索(HIT数)
機能
メタデータを検索し、該当する研究資源の集計⼀覧を取得します。

URL
https://api.bridge.nihu.jp/v1/integratedsearch/metadatas/search-hits/メソッド
POST

JSONリクエストサンプル
conditionsの指定⽅法は、1-1メタデータ検索と共通{"query": {"conditions": [{"queries": [{"query": {"field": "title","term": "⽇本"}},{"connect": "AND","query": {"field": "creator","terms": ["広重"]
}
}
]
}
],
"aggregate": [{"field": "title","order": "desc","size": "10"},{"field": "creator","order": "desc","size": "10"}]19 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md}}

20 / 21

2022/7/22

APIリクエストサンプル_統合検索機能_利⽤者向け.md

1-3メタデータ取得(GET)
機能
メタデータの１つのレコードを取得します。

URL
https://api.bridge.nihu.jp/v1/integratedsearch/metadatas/15217747

メソッド
GET

1-3メタデータ取得(POST)
機能
メタデータの１つのレコードを取得します。

URL
https://api.bridge.nihu.jp/v1/integratedsearch/metadatas/

メソッド
POST

JSONリクエストサンプル{"researchResourceId": "15217747"}

21 / 21