v2API_OA.pdf

Type: Document | Status: ready

55

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 ヶ月以内。 from_date 出力期間(From) 出力期間(From)-(To)を指定できます(2016 or 2016-08-18 等で指定)。各業績種別について、以下の 項目で絞り込みを行います。出力期間を指定した場 合、以下に記述のない業績種別は出力されません。 ・論文、MISC、書籍等出版物:出版年月(日) ・講演・口頭発表等:発表年月日、または、開催年 月日(From)、開催年月日(To) ・受賞歴:受賞年月 ・経歴、学歴、委員歴、所属学協会、担当経験のあ る科目(授業)、Works(作品等)、その他:年月 (From)、年月(To) ・共同研究・競争的資金等の研究課題:研究期間 (年月)(From)、研究期間(年月) (To) ・社会貢献活動:年月日(From)、年月日(To) ・メディア報道:報道年月(日) ・学術貢献活動:実施年月日(From)、実施年月日 (To) ・産業財産権:出願日、または、公開日、または、 公表日、または、登録日、または、発行日 ・研究データ:掲載日 to_date 出力期間(To) start 取得する業績リス トの開始番号。 デフォルト: 1 limit ページあたりの業 績件数。 デフォルト: 100 件。最大:1000 件。 ※ 最大値をこえた指定をした場合、1000 として出 力されます。

① permalink「sample」ユーザーの論文情報11 件目~20 件目分を取得するサンプル GET https://api.researchmap.jp/sample/published_papers?start=11&limit=10

56

② permalink「sample」ユーザーの Works(作品等)のリストを更新日の降順で取得するサンプ ル GET https://api.researchmap.jp/sample/works?sort=-modified

③ permalink「sample」 ユーザーの受賞年月が 1990 年以降である受賞のリストを取得するサンプ ル GET https://api.researchmap.jp/sample/awards?from_date=1990

3.4.1.1 業績リストレスポンス (3.4.1 ①のレスポンス例) { "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/sample/published_papers?start=11&limit=10", "@type": "published_papers ", "@reverse": "https://api.researchmap.jp/sample", "total_items": "155", "_links": { "previous": { "href": "https://api.researchmap.jp/sample/published_papers?start=1&limit=10" }, "next": { "href": "https://api.researchmap.jp/sample/published_papers?start=21&limit=10" } }, "items": [ {論文レスポンス}, {論文レスポンス}, {論文レスポンス}, … ] }

No. フィールド名 内容

  1. @context フィールド名の IRI 先定義ファイルパス(上記の内容で固定) (注 vi)
  2. @id 業績リスト IRI 識別子(リソースを一意に示す URL -{permalink} は会員により変動)
  3. @type 業績種別 (注 v)

57

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

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

next 次ページへのIRI 識別子 ※ 次ページがある場合のみ表示 9. items コレクションのメンバー n 回繰り返し(n>=0)

{achievement_type}によって、レスポンス内容が異なります。詳 しくは各業績情報取得を参照してください。

3.5 業績情報

3.5.1 業績情報取得

パーマリンクと業績種別と業績ID から成るエンドポイントにリクエストを送信すると、指定した業 績情報を返します。

リクエスト GET https://api.researchmap.jp/{permalink}(注iii)/{achievement_type}(注v) /{achievement_id} ※ {achievement_id}には業績ID を指定します。

パラメーター(GET) パラメーター名 項目名 説明 format 出力フォーマット 「研究者情報取得」 format 項目と同様。

① permalink「sample」ユーザーの業績ID「xxxx」の研究キーワード情報をJSON 形式で取得す るサンプル GET https://api.researchmap.jp/sample/research_interests/xxxx?format=json

3.5.1.1 研究キーワード レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld",

58

"@id": "https://api.researchmap.jp/sample/research_interests/xxxx", "@type": "research_interests", "@reverse": "https://api.researchmap.jp/sample/research_interests", "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": "xxxx", "rm:user_id": "R000282839", "keyword": { "ja": "研究キーワード1", "en": "Research keyword1" }, "display": "disclosed", "major_achievement": true }

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

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

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

@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 (更新不可)

59

(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. keyword 研究キーワード (注ix) ja、en のどちらか必須 14.
ja 研究キーワード(日本語) 最大文字長(500) 15.
en 研究キーワード(英語) 最大文字長(500) 16. display 公開の有無(注viii) 選択肢からの単一選択 17. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的 に表示されます。 選択肢からの単一選択

3.5.1.2 研究分野レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/research_areas/{achievement_id}", "@type": "research_areas", "@reverse": "https://api.researchmap.jp/{permalink}/research_areas", "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", "discipline_number": "A289", "item_number": "A61030", "discipline": { "ja": "情報通信", "en": "Informatics" }, "research_field": {

60

"ja": "知能情報学", 
"en": "Fundamental theory of informatics" 

}, "research_keyword": { "ja": "xxxx", "en": "xxxx" }, "display": "disclosed", "major_achievement": true }

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

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

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

@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
(更新不可)

61

  1. discipline_number 研究分野 大分類番号 ※ A999 の形式 必須項目 選択肢からの単一選択 ※ 設定値については、分野コ ード表(注x)を参照してく ださい。
  2. item_number 研究分野 小分類番号 ※ A99999 の形式 必須項目 選択肢からの単一選択 ※ 設定値については、分野コ ード表(注x)を参照してく ださい。
  3. discipline 研究分野 大分類名 (注ix) (更新不可:大分類番号によっ て追加・更新を行います)

ja 大分類名(日本語)

en 大分類名(英語)

  1. research_field 研究分野 小分類名 (注ix) (更新不可:小分類番号によっ て追加・更新を行います)

ja 小分類名(日本語)

en 小分類名(英語)

  1. research_keyword 研究分野 キーワード (注 ix)

ja キーワード (日本語) 最大文字長(500) 23.
en キーワード (英語) 最大文字長(500) 24. display 公開の有無(注viii) 選択肢からの単一選択

  1. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優 先的に表示されます。 選択肢からの単一選択

3.5.1.3 経歴 レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/research_experience/{achievement_id}", "@type": "research_experience", "@reverse": "https://api.researchmap.jp/{permalink}/research_experience", "rm:creator_id": "R000282839", "rm:creator_type": "myself",

62

"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", "from_date": "2015-04", "to_date": "2016-03", "rm:institution_code": "1234567890", "affiliation": { "ja": "国立情報学研究所", "en": "Nationnal Institute of Informatics" }, "section": { "ja": "情報社会相関研究系", "en": "Information and Society Research Division" }, "job": { "ja": "教授", "en": "Professor" }, "job_class": "professor", "job_title": { "ja": "xxxxx", "en": "xxxxx" }, "note": { "ja": "xxxxx", "en": "xxxxx" }, "address_country": "JPN", "custom_items": { "field_name2": [ "xxx1", "xxx2", "xxx3", "xxx4" ] },

63

"major_achievement": true, "display": "disclosed" }

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

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

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

@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. from_date 年月(From) ※ yyyy-MM or yyyy 有効な日付、日付形式 14. to_date 年月(To) ※ yyyy-MM or yyyy ※ 「現在まで」の場合、「9999」と します。 有効な日付、日付形式 15. rm:institution_code 機関コード(注xi) (更新不可) 16. affiliation 所属名(注ix) ja、en のどちらか必須 17.
ja 所属名(日本語) 最大文字長(500)

64

※ ja の項目に入力があれば 必須 18.
en 所属名(英語) 最大文字長(500) ※ en の項目に入力があれば 必須 19. section 部署名(注ix)

ja 部署名(日本語) 最大文字長(500) 21.
en 部署名(英語) 最大文字長(500) 22. job 職名(注ix)

ja 職名(日本語) 最大文字長(500) 24.
en 職名(英語) 最大文字長(500) 25. job_class 職階 選択肢からの単一選択 ※ 主たる所属 職階と同等 のもの。 ※ scope にwrite が指定さ れた場合のみ表示・更新 可。 26. job_title 称号(注ix)

ja 称号(日本語) 最大文字長(500) 28.
en 称号(英語) 最大文字長(500) 29. note 備考(注ix)

ja 備考(日本語) 最大文字長(100) 31.
en 備考(英語) 最大文字長(100) 32. address_country 国・地域 (ISO 3166-1 alpha-3 形式) ISO 3166-1 alpha-3 形式 ※ 設定値については、国・ 地域コード一覧(注x) を参照してください。 33. custom_items カスタム項目 フィールド名(field_name)を object として出力。 レスポンスサンプルは、チェックボ ックスの出力例です。 カスタム項目設定時の入力タ イプでチェック内容が異なり ます ・テキスト:最大文字長 (500) ・テキストエリア:最大文字 長 (15000) ・チェックボックス、セレク トボックス、ラジオボタン: 選択肢の中から選択

65

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

3.5.1.4 学歴 レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/education/{achievement_id}", "@type": "education", "@reverse": "https://api.researchmap.jp/{permalink}/education", "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", "from_date": "2015-04", "to_date": "2016-03", "rm:institution_code": "1234567890", "affiliation": { "ja": "XX 大学", "en": "XX University" }, "department": { "ja": "XXX", "en": "XXXX" }, "course": { "ja": "XX", "en": "XX" }, "note": {

66

"ja": "xxxxx", 
"en": "xxxxx" 

}, "address_country": "JPN", "custom_items": { "field_name": "xxxxxx" }, "major_achievement": true, "display": "disclosed" }

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

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

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

@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. from_date 年月(From) ※ yyyy-MM or yyyy 有効な日付、日付形式 14. to_date 年月(To) 有効な日付、日付形式

67

※ yyyy-MM or yyyy ※ 「現在まで」の場合、「9999」と する from,to どちらも指定された場 合、from<=to であること 15. rm:institution_code 機関コード(注xi) (更新不可) 16. affiliation 学校名(注ix) ja、en のどちらか必須 17.
ja 学校名(日本語) 最大文字長(500) ※ja の項目に入力があれば必須 18.
en 学校名(英語) 最大文字長(500) ※en の項目に入力があれば必須 19. department 学部・研究科等(注ix)

ja 学部・研究科等(日本語) 最大文字長(500) 21.
en 学部・研究科等(英語) 最大文字長(500) 22. cource 学科等 (注ix)

ja 学科等(日本語) 最大文字長(500) 24.
en 学科等(英語) 最大文字長(500) 25. note 備考(注ix)

ja 備考(日本語) 最大文字長(100) 27.
en 備考(英語) 最大文字長(100) 28. address_country 国・地域

ISO 3166-1 alpha-3 形式 設定値については、国・地域「コ ード一覧(注x)を参照してくだ さい。 29. custom_items カスタム項目 フィールド名(field_name)をobject として出力。 レスポンスサンプルは、テキスト(言 語毎の出力なし)の出力例です。 カスタム項目設定時の入力タイプ でチェック内容が異なる ・テキスト:最大文字長(500) ・テキストエリア:最大文字長 (15000) ・チェックボックス、セレクトボ ックス、ラジオボタン:選択肢の 中から選択 30. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択 31. display 公開の有無(注viii) 選択肢からの単一選択

3.5.1.5 委員歴 レスポンス

68

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/committee_memberships/{achievement_id}", "@type": "committee_memberships", "@reverse": "https://api.researchmap.jp/{permalink}/committee_memberships", "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", "from_date": "2015-04", "to_date": "2016-03", "committee_name": { "ja": "XX 委員", "en": "XX Committee" }, "association": { "ja": "XXX", "en": "XXXX" }, "description": { "ja": "XX", "en": "XX" }, "committee_type": "society", "custom_items": { "field_name":[ "xxx1", "xxx2", "xxx3" ] }, "major_achievement": true, "display": "disclosed" }

69

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

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

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

@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. from_date 年月(期間)(From) ※ yyyy-MM or yyyy 有効な日付、日付形式 14. to_date 年月(期間) (To) ※ yyyy-MM or yyyy ※ 「現在まで」の指定の場合、 「9999」とします。 有効な日付、日付形式 from,to どちらも指定された場 合、from<=to であること 15. committee_name 委員名(注ix) ja、en のどちらか必須 16.
ja 委員名(日本語) 最大文字長(500) ※ja の項目に入力があれば必須 17.
en 委員名(英語) 最大文字長(500) ※en の項目に入力があれば必須 18. association 団体名(注ix)

ja 団体名(日本語) 最大文字長(500) 20.
en 団体名(英語) 最大文字長(500)

70

  1. description 特記事項 (注ix)

ja 特記事項(日本語) 最大文字長(15000) 23.
en 特記事項(英語) 最大文字長(15000) 24. committee_type 団体区分 デフォルト: 未選択 "society": 学協会 "government": 政府 "autonomy": 自治体 "others": その他 選択肢からの単一選択 25. custom_items カスタム項目 フィールド名(field_name)をobject として出力。 レスポンスサンプルは、セレクトボッ クスの出力例です。 カスタム項目設定時の入力タイ プでチェック内容が異なる ・テキスト:最大文字長(500) ・テキストエリア:最大文字長 (15000) ・チェックボックス、セレクト ボックス、ラジオボタン:選択 肢の中から選択 26. major_achievement 主要な業績かどうか。 デフォルト: false ※ true に設定した業績が優先的に表 示されます。 選択肢からの単一選択 27. display 公開の有無(注viii) 選択肢からの単一選択

3.5.1.6 受賞 レスポンス

{ "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}/awards/{achievement_id}", "@type": "awards", "@reverse": "https://api.researchmap.jp/{permalink}/awards", "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",