v2API_OA.pdf

Type: Document | Status: ready
← All sources

145

等 "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 以下、更新不可) 24.
dataset_name ファイル名

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

146

"summary": 要約 "others": その他 26.
dataset_other_type 添付種別その他（注ix）

ja 添付種別その他（日本語）

en 添付種別その他（英語）

  1. access_url 添付ファイルのURL

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

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

  4. location 場所（注ix）

ja 場所（日本語） 最大文字長（500） 34.
en 場所（英語） 最大文字長（500） 35. description 概要（注ix）

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

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

@id 対象リソースのIRI
URL 形式 RFC に準拠していること 最大5000 バイト 43.
label 対象リソースタイトル（注xii） (url 以外は、更新不可) 44. custom_items カスタム項目 フィールド名（field_name）をobject として出力。 レスポンスサンプルは、テキスト（言 語毎の出力）の出力例です。 カスタム項目設定時の入力タイ プでチェック内容が異なる ・テキスト：最大文字長（500） ・テキストエリア：最大文字長 （15000） ・チェックボックス、セレクト ボックス、ラジオボタン：選択 肢の中から選択

147

  1. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択
  2. 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": { "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, },

148

"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: （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 （更新不可）

149

  1. other_title その他タイトル（注ix） ja、en のどちらか必須

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": プレプリント・著者最終 稿 "summary": 要約 "others": その他

  2. dataset_other_type 添付種別その他（注ix）

ja 添付種別その他（日本語）

en 添付種別その他（英語）

  1. access_url 添付ファイルのURL

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

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

  4. description 内容（注ix）

ja 内容（日本語） 最大文字長（15000） 29.
en 内容（英語） 最大文字長（15000） 30. custom_items カスタム項目 フィールド名（field_name）をobject として出力。 レスポンスサンプルは、テキスト（言 語毎の出力）の出力例です。 カスタム項目設定時の入力タイ プでチェック内容が異なる ・テキスト：最大文字長（500） ・テキストエリア：最大文字長 （15000） ・チェックボックス、セレクト ボックス、ラジオボタン：選択

150

肢の中から選択 31. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択 32. display 公開の有無（注viii） 選択肢からの単一選択

3.5.1.20 研究データレスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/research_data/{achievement_id}", "@type": "research_data", "@reverse": "https://api.researchmap.jp/{permalink}/research_data", "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", "research_data_title": { "ja": "研究データタイトル", "en": "The research_data title." }, "creators": { "ja": [ { "name": "情報太郎" }, { "name": "情報花子" } ], "en": [ { "name": "Jyouhou Taro"

151

  }, 
  { 
    "name": " Jyouhou Hanako" 
  } 
]

}, "description": { "ja": "xxxxxx", "en": "xxxxxxxx" }, "publisher": { "ja": "xxxxxx", "en": "xxxxxxxx" }, "posted_date": "2015-07-01", "updated_posted_date": "2015-07-01", "languages": ["jpn"], "data_field": "XX", "data_type": "XX", "format": "XX", "dataset": { "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", "embargo_date": "2015-07" }, "rm:is_open_access": false, "identifiers": { "doi": ["xxxx", "xxxx"], "rm:research_project_id": ["xxxx"] }, "see_also": [

152

{ 
  "@id": "http://xxxxxx", 
  "label": "url", 
  "is_downloadable": true 
}, 
{ 
  "@id": "http://xxxxxxxx", 
  "label": "url" 
}, 
{ 
  "@id": "http://dx.doi.org/xxxxxx", 
  "label": "doi", 
  "embargo_date": "2015-07-01" 
  "doi_type": "repository", 
  "doi_type_name": "xxxxxx" 
}, 
{ 
  "@id": "http://ci.nii.ac.jp/naid/xxxxxx", 
  "label": "cinii_articles" 
}, 
{ 
  "@id": "https://api.researchmap.jp/{permalink}/research_projects/xxxx", 
  "label": "rm:research_projects" 
}

], "related_url": ["http://xxxxxxxx "," http://xxxxxxxx "], "rights": "XX", "access_right": "embargoed access", "access_rights_date": "2015-07-01", "host_institution": "XX", "custom_items": { "field_name": { "ja": "xxxxxx", "en": "xxxxxx" } }, "major_achievement": true, "display": "disclosed" }

153

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

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

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

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

rm:creator_id 作成者の会員ID （ai からの登録:ai:（AI の種別key）, API からの登録: client_id:（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. research_data_title 研究データタイトル（注ix） ja、en のどちらか必須 14.
ja 研究データタイトル（日本語） 最大文字長（500） ※ja の項目に入力があれば 必須 15.
en 研究データタイトル（英語） 最大文字長（500） ※en の項目に入力があれば 必須 16. creators 作成者

ja （en） 言語種別（en 言語の記載、省略） n 回繰り返し（n>=0） （注ix）

name 作成者 最大文字長（500） 19. description 概要 （注ix）

ja 概要（日本語） 最大文字長（15000） 21.
en 概要（英語） 最大文字長（15000） 22. publisher 出版者

154

ja 出版者（日本語） 最大文字長（500） 24.
en 出版者（英語） 最大文字長（500） 25. posted_date 掲載日 ※ yyyy-MM-dd or yyyy-MM or yyyy 有効な日付、日付形式 ※必須項目 26. updated_posted_date 掲載更新日 ※ yyyy-MM-dd or yyyy-MM or yyyy 有効な日付、日付形式 27. languages 記述言語 ※ 配列に値がはいります。 ISO 639-3 形式 設定値については、言語コ ード一覧（注x）を参。 28. data_field データの分野 デフォルト: 未選択 "Life Science": ライフサイエンス "Informatics": 情報通信 "Environmental science": 環境 "Nanotechnology/Materials": ナノテク・ 材料 "Energy Engineering": エネルギー "Manufacturing Technology": ものづくり 技術 "Social Infrastructure": 社会基盤 "Frontier Technology": フロンティア "Humanities & Social Sciences": 人文・ 社会 "Natural Science": 自然科学一般 "Others": その他 選択肢からの単一選択 29. data_type データ種別 デフォルト: 未選択 "Audiovisual": オーディオビジュアル "Award": 授与物 "Collection": コレクション "ComputationalNotebook": 仮想ノートブ ック環境 "DataPaper": データ論文 "Dataset": データセット "Event": イベント "Image": 画像 "Instrument": 機器 "InteractiveResource": 対話型リソース "Model": モデル 選択肢からの単一選択

155

"OutputManagementPlan": データマネジ メントプラン等 "PhysicalObject": 対象物 "Preprint": プレプリント "Project": プロジェクト "Service": サービス "Software": ソフトウエア "Sound": 音 "Standard": 標準 "StudyRegistration": 研究計画の詳細な説 明（タイムスタンプ付） "Text": テキスト "Workflow": ワークフロー "Other": その他 30. format フォーマット 最大文字長（500） 31. dataset 添付ファイル ※ 添付ファイルなし、あるいはパスワー ド付きで本人以外の取得の場合及び、 公開開始（予定）日より前の場合、本 項目は表示されません。 (dataset 以下、更新不可) 32.
dataset_name ファイル名

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

  2. dataset_other_type 添付種別その他（注ix）

ja 添付種別その他（日本語）

en 添付種別その他（英語）

  1. access_url 添付ファイルのURL

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

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

  4. thumbnail_url サムネイルのURL

  5. embargo_date 公開開始（予定）日 ※ yyyy-MM-dd or yyyy-MM or yyyy 有効な日付、日付形式

  6. rm:is_open_access オープンアクセスか否か 以下のいずれか （更新不可）

156

false: オープンアクセスではない true: オープンアクセスである 43. identifiers 識別子（曖昧性がなく区別できるIDs）

doi DOI ※ 配列に値がはいります。ただし、本人 以外の取得の場合で、公開開始（予 定）日より前の場合、値は設定されま せん。 書式チェック 10.[スラッシュ以外の文字１ つ以上]/[出版社指定の文字 列]

rm:research_project _id 紐づいたの共同研究・競争的資金等の業績 ID ※ 配列に値がはいります。 (更新不可) 46. see_also 対象リソースに関する詳細情報 ※ 記載していないものも出力することが あります。 ※ 本人以外の取得の場合で、公開開始 （予定）日より前の場合、要素は表示 されません。

@id 対象リソースのIRI
URL 形式 RFC に準拠していること 最大5000 バイト 48.
label 対象リソースタイトル（注xii） (url,doi 以外は、更新不可) 49.
is_downloadable 無償でアクセスできるURL（リソースの 定義場所） であるかどうか。 以下のいずれか デフォルト: false false: 無償でアクセスできない true: 無償でアクセス可 選択肢からの単一選択 50. embargo_date 公開開始（予定）日 ※ yyyy-MM-dd or yyyy-MM or yyyy 有効な日付、日付形式 51. doi_type DOI ランディング先 “publisher_site”： 出版者サイト “repository"： リポジトリ “others”： その他 選択肢からの単一選択 （label=doi 以外は更新不 可） 52. doi_type_name DOI ランディング先の名称 最大文字長（500） （label=doi 以外は更新不 可） 53. related_url 関連情報URL ※ 配列に値が入ります。

URL 形式 RFC に準拠していること 最大5000 バイト

157

  1. rights ライセンス情報 最大文字長（500）
  2. access_right アクセス権 デフォルト: 未選択 "open access": 公開 "restricted access": 共有 "metadata only access": 非共有・非公開 "embargoed access": 公開期間猶予 選択肢からの単一選択
  3. access_rights_date 公開予定日 ※ yyyy-MM-dd or yyyy-MM or yyyy ア ク セ ス 権 が embargoed access の場合は必須
  4. host_institution データ管理機関 最大文字長（500）
  5. custom_items カスタム項目 フィールド名（field_name）を object と して出力。 レスポンスサンプルは、テキスト（言語毎 の出力）の出力例です。 カスタム項目設定時の入力 タイプでチェック内容が異 なる ・ テ キ ス ト ： 最 大 文 字 長 （500） ・ テキストエリア ： 最大文字 長（15000） ・チェックボックス、セレ クトボックス、ラジオボタ ン：選択肢の中から選択
  6. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表示さ れます。 選択肢からの単一選択
  7. display 公開の有無（注 viii） 選択肢からの単一選択

3.6 代理人情報

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

3.6.1 代理人情報取得

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

パラメーター（GET） パラメーター名 項目名 説明

158

start 取得する代理人の 開始番号。 デフォルト: 1 limit 開始番号から取得 する代理人件数。 デフォルト: 20 件。最大：100 件。 ※ 最大値を超過して指定した場合、100 として出力 されます。

① 代理人情報を先頭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 -

159

{permalink}は会員により変動） 3. @type assistants 固定 4. @reverse 親データIRI 識別子（上記の内容で固定-{permalink}は会員 により変動） 5. total_items 総件数 6. _links リソースのビュー 7.

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 研究者氏名 氏名（日本語・カナ・英語）、通称等の別名（日本 語・英語）が対象

160

※ 特殊文字使用可。 user_id 会員ID 例：R000282839 permalink パーマリンク 半角スペース区切りで複数指定可能（or） affiliation_type 所属区分 以下のいずれか。 "general_researcher" : 大学，高等専門学校，研 究開発法人，政府系研究機関等 "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 ":経歴

161

"affiliations+research_experience":現所属・経歴 デフォルト: main_affiliations ※ affiliation、section、job、job_title とセット で利用します。 affiliation 所属名 ※ 特殊文字使用可。 section 部署名 ※ 特殊文字使用可 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：輸送

162

A180：精密 A190：他製品 A200：電気ガス A210：陸運 A220：海運 A230：空運 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

以下のいずれか。

Page 9 of 12