v2API.pdf

Type: Document | Status: ready

145

※ja の項目に入力があれば必須 15.
en 学術貢献活動タイトル(英語) 最大文字長(500) ※en の項目に入力があれば必須 16. academic_contributi on_type 学術貢献活動種別 デフォルト: 未選択 "academic_society_etc":学会・研究会等 "competition_etc": 大会・シンポジウム 等 "exhibition": 展覧会 "review": 審査・学術的助言 "academic_research":学術調査 "peer_review_etc": 査読等 "cultural_property_protection": 文化財 保護 "others": その他 選択肢からの単一選択 17. academic_contributi on_roles 役割 以下を配列で複数記載できます。 "planning_etc": 企画立案・運営等 "panel_chair_etc": パネル司会・セッシ ョンチェア等 "supervision": 監修 "review": 審査・評価 "academic_research_planning": 学術 調査立案・実施 "peer_review": 査読 "save_or_restore": 保存・修復 "others": その他 選択肢から選択されていること (複数選択可) ※必須項目 18. promoter 主催者・責任者(注ix)

ja 主催者・責任者(日本語) 最大文字長(500) 20.
en 主催者・責任者(英語) 最大文字長(500) 21. from_event_date 実施年月日(From) ※ yyyy-MM-dd or yyyy-MM or yyyy 有効な日付、日付形式 22. to_event_date 実施年月日(To) ※ yyyy-MM-dd or yyyy-MM or yyyy ※ 「現在まで」の場合、「9999」とし ます。 有効な日付、日付形式 from,to どちらも指定された場 合、from<=to であること 23. dataset 添付ファイル ※ 添付ファイルなし、あるいはパスワ ード付きで本人以外の取得の場合、 (dataset 以下、更新不可)

146

本項目は表示されません。 24.
dataset_name ファイル名

  1. dataset_type 添付種別 デフォルト: 未選択 "preprint": プレプリント・著者最終稿 "published": 発表資料 "experimental": 実験データ "summary": 要約 "others": その他

dataset_other_type 添付種別その他(注ix)

ja 添付種別その他(日本語)

en 添付種別その他(英語)

  1. access_url 添付ファイルのURL

  2. rm:media_type メディアタイプ

  3. rm:use_password パスワードの有無

  4. thumbnail_url サムネイルのURL

  5. location 場所(注ix)

ja 場所(日本語) 最大文字長(500) 35.
en 場所(英語) 最大文字長(500) 36. description 概要(注ix)

ja 概要(日本語) 最大文字長(15000) 38.
en 概要(英語) 最大文字長(15000) 39. is_international_coll aboration 国際学術貢献か否か。 デフォルト: 未選択 false: 国際学術貢献にあたらない true: 国際学術貢献している 選択肢からの単一選択 40. identifiers 識別子(曖昧性がなく区別できる IDs)

rm:research_proje ct_id 紐づいた共同研究・競争的資金等の研 究課題の業績ID ※ 配列に値がはいります。 (更新不可) 42. see_also 対象リソースに関する詳細情報 ※ 記載していないものも出力すること があります。

@id 対象リソースのIRI
URL 形式 RFC に準拠していること 最大5000 バイト 44.
label 対象リソースタイトル(注xii) (url 以外は、更新不可)

147

※ url, rm:research_project がはいり ます 45. custom_items カスタム項目 フィールド名(field_name)をobject として出力。 レスポンスサンプルは、テキスト(言 語毎の出力)の出力例です。 カスタム項目設定時の入力タイ プでチェック内容が異なる ・テキスト:最大文字長(500) ・テキストエリア:最大文字長 (15000) ・チェックボックス、セレクト ボックス、ラジオボタン:選択 肢の中から選択 46. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択 47. display 公開の有無(注viii) 選択肢からの単一選択

3.5.1.19 その他 レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/others/{achievement_id}", "@type": "others", "@reverse": "https://api.researchmap.jp/{permalink}/others", "rm:creator_id": "R000282839", "rm:creator_type": "myself", "rm:created": "2017-02-15T14:17:04Z", "rm:modifier_id": "R000282839", "rm:modifier_type": "myself", "rm:modified": "2017-02-15T14:17:04Z", "rm:id": "{achievement_id}", "rm:user_id": "R000282839", "other_title": { "ja": "その他タイトル", "en": "The other title." }, "from_date": "2015-07", "to_date": "2015-07", "dataset": {

148

"dataset_name": "file_name.pdf", 
"dataset_type": "preprint", 
"dataset_other_type": { 
  "ja": "XX", 
  "en": "XX" 
}, 
"access_url": "https://researchmap.jp/xxxxxxxxxx.pdf", 
"rm:media_type": "application/pdf", 
"rm:use_password": true, 
"thumbnail_url":"https://researchmap.jp/xxxxxxxxxx.pdf?thumbnail" 

}, "description": { "ja": "xxxxxx", "en": "xxxxxxxx" }, "custom_items": { "field_name": { "ja": "xxxxxx", "en": "xxxxxx" } }, "major_achievement": true, "display": "disclosed" }

No. フィールド名 内容 登録/更新時のチェック内容 1. @context フィールド名のIRI 先定義ファイルパ ス(上記の内容で固定)(注vi)

@id 業績IRI 識別子(リソースを一意に示 すURL - {achievement_id}は業績 ID)

@type 業績種別名 "others"固定。

@reverse 親データIRI 識別子(上記の内容で固 定-{permalink}は会員により変動)

rm:creator_id 作成者の会員ID (ai からの登録:ai:(AI の種別key), API からの登録: client_id: (更新不可)

149

(client_id)) 6. rm:creator_type 作成者種別(注vii) (更新不可) 7. rm:created 登録日時(GMT) (更新不可) 8. rm:modifier_id 更新者の会員ID (ai からの更新:ai:(AI の種別key), API からの更新: client_id: (client_id)) (更新不可) 9. rm:modifier_type 更新者種別(注vii) (更新不可) 10. rm:modified 更新日時(GMT) (更新不可) 11. rm:id 業績ID (更新不可) 12. rm:user_id 会員ID (更新不可) 13. other_title その他タイトル(注ix) ja、en のどちらか必須 14.
ja その他タイトル(日本語) 最大文字長(500) ※ja の項目に入力があれば必須 15.
en その他タイトル(英語) 最大文字長(500) ※en の項目に入力があれば必須 16. from_date 年月(From) ※ yyyy-MM or yyyy 有効な日付、日付形式であるこ と 17. to_date 年月(To) ※ yyyy-MM or yyyy ※ 「現在まで」の場合、「9999」と します。 有効な日付、日付形式であるこ と。from,to どちらも指定され た場合、from<=to であること 18. dataset 添付ファイル ※ 添付ファイルなし、あるいはパス ワード付きで本人以外の取得の場 合、本項目は表示されません。 (dataset 以下、更新不可) 19.
dataset_name ファイル名

  1. dataset_type 添付種別 デフォルト: 未選択 "preprint": プレプリント・著者最終 稿 "published": 発表資料 "experimental": 実験データ "summary": 要約 "others": その他

  2. dataset_other_type 添付種別その他(注ix)

ja 添付種別その他(日本語)

en 添付種別その他(英語)

150

  1. access_url 添付ファイルのURL

  2. rm:media_type メディアタイプ

  3. rm:use_password パスワードの有無

  4. thumbnail_url サムネイルのURL

  5. description 内容(注ix)

ja 内容(日本語) 最大文字長(15000) 30.
en 内容(英語) 最大文字長(15000) 31. custom_items カスタム項目 フィールド名(field_name)をobject として出力。 レスポンスサンプルは、テキスト(言 語毎の出力)の出力例です。 カスタム項目設定時の入力タイ プでチェック内容が異なる ・テキスト:最大文字長(500) ・テキストエリア:最大文字長 (15000) ・チェックボックス、セレクト ボックス、ラジオボタン:選択 肢の中から選択 32. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択 33. display 公開の有無(注viii) 選択肢からの単一選択

3.6 代理人情報

代理人情報では、指定した研究者の代理人情報を出力します。

3.6.1 代理人情報取得

リクエスト GET https://api.researchmap.jp/{permalink}(注iii)/assistants

パラメーター(GET) パラメーター名 項目名 説明 start 取得する代理人の 開始番号。 デフォルト: 1 limit 開始番号から取得 する代理人件数。 デフォルト: 20 件。最大:100 件。 ※ 最大値を超過して指定した場合、100 として出力 されます。

151

① 代理人情報を先頭10 人分のみ取得するサンプル GET https://api.researchmap.jp/{permalink}(注iii)/assistants?limit=10

② 代理人情報の6 人目~10 人目分を取得するサンプル GET https://api.researchmap.jp/{permalink}(注iii)/assistants?start=6&limit=5

3.6.1.1 代理人情報 レスポンス

(3.6.1 ②のレスポンス例) { "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/assistants?start=6&limit=5", "@type": "assistants", "@reverse": "https://api.researchmap.jp/{permalink}", "total_items": "155", "_links": { "previous": { "href": "https://api.researchmap.jp/{permalink}/assistants?start=1&limit=5" }, "next": { "href": "https://api.researchmap.jp/{permalink}/assistants?start=11&limit=5" } }, "items": [ {"id": "value1", "assistant_id": "value2"}, {"id": "value1", "assistant_id": "value3"}… ] }

No. フィールド名 内容 1. @context IRI 先定義ファイルパス(上記の内容で固定)(注vi) 2. @id 代理人情報IRI 識別子(リソースを一意に示すURL - {permalink}は会員により変動) 3. @type assistants 固定 4. @reverse 親データIRI 識別子(上記の内容で固定-{permalink}は会員 により変動) 5. total_items 総件数 6. _links リソースのビュー

152

Previous 前ページへのIRI 識別子 ※ 前ページがある場合のみ表示 8.

Next 次ページへのIRI 識別子 ※ 次ページがある場合のみ表示 9. Items コレクションのメンバー n 回繰り返し(n>=0) 10. Id 代理人が編集できる会員 ID 11. assistant_id 代理人の会員 ID

3.7 研究者情報検索

研究者情報検索API では、研究者を検索することができます。登録情報とは別に検索用のデータ を作成するため、情報更新が検索結果に反映されるまで若干時間がかかります。指定した業績を 登録している研究者を検索することができますが、その場合、研究者のみに公開を含む公開情報 が検索の対象となります。 ※ 検索範囲については、3.10.1 取得範囲における制限の[機関による取得における制限]を参照し てください。

リクエスト GET https://api.researchmap.jp/researchers

パラメーター(GET) 業績の条件絞り込みのパラメーターについては、業績種別ごとに分けて「条件絞り込みとして使用可 能なパラメーター」に記載します。また、使用可能な検索文字列として次項の特殊文字をサポートし ています。

パラメーター名 項目名 説明 q フリーワード プロフィール情報の「研究者氏名」、あるいは、 「所属」・「部署」・「職名」から検索できます。 ※ 特殊文字使用可。 name 研究者氏名 氏名(日本語・カナ・英語)、通称等の別名(日本 語・英語)が対象

※ 特殊文字使用可。 user_id 会員ID 例:R000282839 permalink パーマリンク 半角スペース区切りで複数指定可能(or) affiliation_type 所属区分 以下のいずれか。 "general_researcher" : 大学,高等専門学校,研

153

究開発法人,政府系研究機関等 "general_full_time_researcher": 常勤研究者 "general_full_time_staff": 常勤職員(URA 等) "general_part_time_researcher": 非常勤研究 員,職員 "general_doctoral_researcher": 博士研究員 (ポスドク) "general_doctoral_course": 学生(博士課程) "general_masters_course": 学生(修士課程) "general_undergraduate": 学生(学部) "general_other": その他 "company": 企業 "government": 政府,地方自治体 "npo_ngo": NPO,NGO "independent_researcher": 独立系研究者 "other": その他 institution_code 機関コード 機関コード10 桁に満たない検索を行う場合、 「9999*」としても検索可能です (「9999000000」と同等)。

※ 自機関以外の機関コードでの検索は許可して いません。 main_institution_code 主所属の機関コ ード 機関コード10 桁に満たない検索を行う場合、 「9999*」としても検索可能です (「9999000000」と同等)。

※ affiliation_search_range パラメーターで代替 可 affiliation_search_range 所属検索範囲 以下のいずれか。 "main_affiliations":主所属 "affiliations":現所属(主所属+その他所属)
"research_experience ":経歴 "affiliations+research_experience":現所属・経歴 デフォルト: main_affiliations ※ affiliation、section、job、job_title とセット で利用します。 affiliation 所属名 ※ 特殊文字使用可。 section 部署名 ※ 特殊文字使用可

154

job 職名 ※ 特殊文字使用可 job_title 称号 ※ 特殊文字使用可 institution_type 機関タイプ 以下のいずれか。 A11:国立研究機関 A12:独立行政法人・国立研究開発法人等 A13:大学共同利用機関法人 A03:公設試験研究機関 A04:学校機関 A05:公益法人等 A06:企業研究施設 A09:その他機関 university_type 学校機関タイプ 以下のいずれか。 A1:国立大学法人 A2:公立大学 A3:私立大学 A4:高等専門学校 A5:大学校 A6:その他学校機関 public_corp_type
公益法人等タイ プ 以下のいずれか。 A1:一般社団法人 A2:一般財団法人 A3:公益社団法人 A4:公益財団法人 A5:その他 industry_type 企業研究施設タ イプ 以下のいずれか。 A100:ゴム A110:ガラス A120:鉄鋼 A130:非鉄 A140:金属 A150:機械 A160:電機 A170:輸送 A180:精密 A190:他製品 A200:電気ガス A210:陸運 A220:海運 A230:空運

155

A240:倉庫運輸 A250:通信 A260:卸売 A270:小売 A280:銀行 A290:証券、商先 A300:保険 A310:他金融 A320:不動産 A330:サービス A010:水産農林 A020:鉱業 A030:建設 A040:食料品 A050:繊維 A060:パルプ紙 A070:化学 A080:医薬品 A090:石油石炭 country 所属機関の国コ ード ISO 3166-1 alpha-3 形式で指定。 ※ 設定値については、国・地域コード一覧(注 x)を参照してください。 area 地方コード 以下のいずれか。 A01:北海道 A02:東北 A03:関東 A04:中部 A05:近畿 A06:中国 A07:四国 A08:九州 A99:その他 prefecture

以下のいずれか。 A01:北海道 A02:青森県 A03:岩手県 A04:宮城県 A05:秋田県 A06:山形県

156

A07:福島県 A08:茨城県 A09:栃木県 A10:群馬県 A11:埼玉県 A12:千葉県 A13:東京都 A14:神奈川県 A15:新潟県 A16:富山県 A17:石川県 A18:福井県 A19:山梨県 A20:長野県 A21:岐阜県 A22:静岡県 A23:愛知県 A24:三重県 A25:滋賀県 A26:京都府 A27:大阪府 A28:兵庫県 A29:奈良県 A30:和歌山県 A31:鳥取県 A32:島根県 A33:岡山県 A34:広島県 A35:山口県 A36:徳島県 A37:香川県 A38:愛媛県 A39:高知県 A40:福岡県 A41:佐賀県 A42:長崎県 A43:熊本県 A44:大分県 A45:宮崎県

157

A46:鹿児島県 A47:沖縄県 erad_id 研究者番号

orc_id ORCID iD

researcher_id Researcher ID

j_global_id J-Global ID

last_modified 最終更新日 指定された最終更新日時以降のデータを出力しま す。 2016 or 2016-08 or 2016-08-18 or 2016-08-18- 090000 等で指定できます。 また、以下のように指定することもできます。(注 xiii) "-1 week":1 週間以内 "-2 week":2 週間以内 "-1 month":1 ヶ月以内 "-2 month":2 ヶ月以内 "-3 month":3 ヶ月以内 format 出力フォーマッ ト レスポンスの形式を指定します。 以下のいずれかを選択できます。 デフォルト: json json: JSON 形式

※ HTML リクエストヘッダのAccept ヘッダで 以下の記載でも動作します。 "application/ld+json":json (application/json) sort ソート順 デフォルト: スコア順 name.ja: 氏名(日本語)の昇順 name.en: 氏名(英語)の昇順 name.ja.kana: 氏名(カナ)の昇順 last_modified: 最終更新日の昇順 job_class: 職階の昇順 number_of_achievements: 研究分野、研究キーワ ード、経歴、学歴以外の業績数の昇順

※ 昇順を降順にする場合、先頭に「-」をつけま す。例:氏名(日本語)の降順…「&sort=- name.ja」 ※ 複数指定する場合、「,」で区切ります。例:最

158

終更新日の降順、氏名(日本語)の昇順… 「&sort=-last_modified, name.ja」 ※ すべてデフォルトの順が第2 ソート順となり ます。例えば、同姓同名がいた場合、よりス コアが高く、業績数が多い人が上位となりま す。 ※ 職階の昇順は、プロフィール情報レスポンス job_class 順に並べ替えられます。ただし、職 階未設定は最後尾になります。 start 取得する研究者 情報リストの開 始番号。 デフォルト: 1 (page) 取得する研究者 情報リストのペ ージ番号 start 指定の代わりに利用できます。start と同時 に指定された場合、page が優先されます。 limit ページあたりの 研究者件数。 デフォルト: 60 件。最大:300 件。 ※ 最大値をこえた指定をした場合、300 として 出力されます。

3.7.1 検索文字列で使用可能な特殊文字

特殊文字 意味 説明 (空白文 字) ※ 半角ス ペー ス・全 角スペ ース AND 検索 入力したすべてのキーワードを含むデータを検索します。空白文 字で区切り、指定します。 例:「有機化学 物理化学」…「有機化学」と「物理化学」の両方 を含むデータを検索します。 | OR 検索 入力したすべてのキーワードのいずれかを含むデータを検索しま す。「|」で区切り、指定します。 例:「有機化学|物理化学」…「有機化学」あるいは「物理化学」 のいずれかを含むデータを検索します。

NOT 検索 入力したキーワードは含むが特殊文字の後に入力したキーワード は含まないデータを検索します。単体で使うと大部分のデータが 検索対象となりますので、必ずAND 検索(空白文字)とセットで 利用します。「-」で区切り、指定します。「A -B」の場合、「A」の うち「B」を含まないデータを検索することになります。 例: 「有機化学 -物理化学」…「有機化学」を含むが、「物理化

159

学」を含まないデータを検索します。 ※ 「有機化学-物理化学」としますと、有機化学を含む、あるい は、物理化学を含まない単語で検索されますので、必ず「有機 化学(空白文字)-物理化学」としてください。 " フレーズ検 索 複数のキーワード文字列が入力順に並んでいるデータを検索する 場合に利用します。 「"」で検索文字を囲みます。 例: 「"like logic"」…普通はそれぞれの単語の AND 検索となり、 「like a dog. The logic …」のようなデータにもマッチします。 しかし、この場合、それをそのまま「フレーズ」として検索しま す。つまり「そのような単語の並び」があるデータを検索するこ とになります。

  • プレフィッ クス検索 指定したプレフィックスで始まるデータを検索します。キーワー ド直後に「」を指定し、 「」より前のキーワードに一致するすべ てのデータが返されます。 例: 「有機*」…先頭が「有機」ではじまるデータを検索します。 ただし、研究者氏名、論文名、誌名などのようなテキストの項目 の検索では、 「AND 検索」と同様の結果となります。キーワード としてデータを保持している「研究キーワード」 、 「機関コード」 、 その他 ID 関連で有効です。 ( および ) 優先順位 「(」および「)」を指定し、論理演算の優先度を指定できます。 例: 「研究所 -(国立 情報)」…「研究所」を含み、 「国立」と 「情報」の両方を含むデータが存在しないデータを検索します。 「国立遺伝学研究所」はマッチしますが、 「国立情報学研究所」は マッチしないことになります。 ※ これらの特殊文字を検索するには、¥でエスケープする必要があります。

3.7.2 条件絞り込みとして使用可能なパラメーター

指定した業績を登録している研究者を検索することができます。 ※ パラメーター指定例: 称号が「センター長」で、研究キーワードに ”オープンソースソフトウェア” を登録している研 究者を検索する場合 ? job_title=センター長&research_interests[keyword]=オープンソースソフトウェア (この例ではパラメーターをエンコードしていませんが、 実際に指定する際にはbase64_encode した文字列を指定してください。)

3.7.2.1 研究キーワード絞り込み パラメーター名 項目名 説明 research_interests[keyword] 研究キーワ 特殊文字使用可。

160

ード

3.7.2.2 研究分野絞り込み パラメーター名 項目名 説明 research_areas[discipline_number] 大分類番号 ※ 設定値については、分野コード表(注x) を参照してください。 research_areas[item_number] 小分類番号 ※ 設定値については、分野コード表(注x) を参照してください。

3.7.2.3 委員歴絞り込み パラメーター名 項目名 説明 committee_memberships[committee_name] 委員名 特殊文字使用可。 committee_memberships[date][from][year] committee_memberships[date][from][month] 年月 (from)

committee_memberships[date][to][year] committee_memberships[date][to][month] 年月 (to)

committee_memberships[association] 団体名 特殊文字使用可。 committee_memberships[committee_type] 団体区分 society:学協会 government:政府 autonomy:自治体 others:その他

3.7.2.4 受賞絞り込み パラメーター名 項目名 説明 awards[award_name] 受賞名 特殊文字使用可。 awards[award_date][from][year] awards[award_date][from][month] 受賞年月 (from)

awards[award_date][to][year] awards[award_date][to][month] 受賞年月 (to)

awards[association] 授与機関 特殊文字使用可。 awards[award_title] 対象とな った業績 名 特殊文字使用可。 awards[address_country] 受賞国・ 地域 ISO 3166-1 alpha-3 形式

※ 設定値については、国・地域コー ド一覧(注x)を参照してくださ い。

161

3.7.2.5 論文・MISC 絞り込み パラメーター名 項目名 説明 published_papers[paper_title] タイト ル 特殊文字使用可。 published_papers[include_misc] MISC を含め る 0:MISC は含めない 1: MISC を含め検索する published_papers[publication_name] 誌名 特殊文字使用可。 published_papers[publisher] 出版 者・発 行元 特殊文字使用可。 published_papers[publication_date][from][ye ar] published_papers[publication_date][from][m onth] 出版年 月 (from )

published_papers[publication_date][to][year] published_papers[publication_date][to][mont h] 出版年 月 (to)

published_papers[languages] 記述言 語 ISO 639-3 に形式

※ 設定値については、言語コード一 覧(注x)を参照してください。 published_papers[published_paper_type] 掲載種 別 scientific_journal:研究論文(学術雑 誌) international_conference_proceedin gs:研究論文(国際会議プロシーディ ングス) research_institution: 研究論文(大 学,研究機関等紀要) symposium: 研究論文(研究会,シ ンポジウム資料等) research_society: 研究論文(その他 学術会議資料等) in_book: 論文集(書籍)内論文 master_thesis: 学位論文(修士) doctoral_thesis: 学位論文(博士) others: その他 report_scientific_journal: 速報,短

162

報,研究ノート等(学術雑誌) report_research_institution: 速報, 短報,研究ノート等(大学,研究機 関紀要) summary_international_conference: 研究発表ペーパー・要旨(国際会 議) summary_national_conference: 研 究発表ペーパー・要旨(全国大会, その他学術会議) technical_report: 機関テクニカルレ ポート,技術報告書,プレプリント 等 introduction_scientific_journal: 記 事・総説・解説・論説等(学術雑 誌) introduction_international_proceedi ngs: 記事・総説・解説・論説等(国 際会議プロシーディングズ) introduction_research_institution: 記事・総説・解説・論説等(大学・ 研究所紀要) introduction_commerce_magazine: 記事・総説・解説・論説等(商業 誌、新聞、ウェブメディア) introduction_other: 記事・総説・解 説・論説等(その他) lecture_materials:講演資料等(セミ ナー,チュートリアル,講習,講義 他) book_review: 書評論文,書評,文献 紹介等 meeting_report: 会議報告等 published_papers[referee] 査読の 有無 0: 査読無し 1: 査読有り published_papers[invited] 招待の 有無 0: 招待無し 1: 招待有り published_papers[doi] DOI

published_papers[issn] ISSN