v2API_OA.pdf

35

waiting 以外の場合、出力。 9. process_items 処理件数 status がchecking、 processing、error の場合出 力。 10. error_items エラー件数 status がerror の場合のみ出 力。 11. errors エラー内容 「error」、「field_name」 「error_description」の配列がつ きます。 status がerror の場合、出 力。 1 行目は、ファイル自体のエ ラーの場合、出力。 12. messages メッセージ内容 エラーではなく、 Information レベルの場合、 表示されます。 13. action 指定アクション insert、update、delete のいずれ か。

14. action_type アクションタイプ 実際にレコードがどのようにな ったか（なる予定か）を表しま す。以下のいずれか add：追加された merge：既存データとマージ similar_merge：類似データとマ ージ force：強制追加（類似データが 存在しても無視） doc：更新時（action=update 時。action=update でも類似デー タとマージした場合、 similar_merge となります） action がinsert、update の 場合、出力。

15. priority マージ優先順位 input_data 、similar_data のい ずれか。 status がmerge の場合、出 力。

16. type 指定タイプ

17. id 処理されたid

18. link 研究者情報、あるいは業績情報 へのリンク。 該当URL が存在する場合の み出力。

19. error エラー理由 status がerror の場合のみ出

36

力。 各レスポンス表のReason 参 照。 20. message メッセージ理由 エラーではなく、 Information レベルの場合、 表示されます。 21. field_name フィールドのバリデーションエ ラーの場合、そのフィールド名 が配列として記載されます。 status がerror の場合のみ出 力。 階層構造の下の項目がエラー になった際は 「family_name.ja」等とい うようにドットで階層を表し ます。 22. error_description エラーの説明文。メッセージ は、内容によって異なりますの で記載しません。 status がerror の場合のみ出 力。 23. message_description メッセージの説明文 エラーではなく、 Information レベルの場合、 表示されます。

3.1.4 一括更新時バリデーションエラー レスポンス表

研究者情報の各項目におけるバリデーション項目は、「プロフィール情報バリデーションエラー レ スポンス表」、「業績情報バリデーションエラー レスポンス表」をご覧ください。ここでは、一括取 得、一括更新時の不正なデータ、または、エラーによる理由とその内容を説明します。 code Reason 内容 304 not_changed 更新前後で差異が見られなかったために更新しません でした。 304 not_modified 本人相当が登録した既存データが存在したため、更新 しませんでした。 ※ 機関のインポートでの制限は、「追加・更新・削除 範囲における制限」をご覧ください。 304 not_similar_modified 本人相当が登録した類似の業績が存在したため、更新 しませんでした。 更新しようとしている業績以外に類似データがあり （マージ対象になる）、本人相当が登録したデータで あるならば出力されます。 400 invalid_status チェック完了になっていないbulk データをインポー トしようとしました。

37

400 failed_file_open インポートファイル、または一括更新のPOST BODY のファイルオープンに失敗しました。 管理者にお問い合わせください。 400 failed_file_close インポートファイル、または一括更新のPOST BODY のファイルクローズに失敗しました。 管理者にお問い合わせください。 400 parse_error JSON などのパースに失敗しました。 400 invalid_action 一括更新時のアクション名insert,update,delete が不 正です。 400 invalid_action_type 一括更新時のアクション名内のinsert,update に伴う doc,merge,force が不正です。 400 invalid_type 一括更新時のアクション名内のtype 名が不正です。 400 invalid_csv_import_type CSV インポートの1 行目の種別が不正です。 400 invalid_csv_header CSV インポートの2 行目のヘッダ情報が不正です。ヘ ッダ情報が1 列もなかった場合に出力されます。 400 undefined_csv_header CSV インポートの2 行目のヘッダ情報で未定義のラベ ルがあります。 400 invalid_delete_reason 削除理由が不正です。mine or not_mine を指定してく ださい。 400 invalid_name 姓と名を分けずにname 指定でインポートし姓と名の 分割に失敗した場合に出力されます。 400 invalid_authors 論文等の著者名を分けずにインポートし分割に失敗し た場合に出力されます。 400 invalid_user_id 更新、マージする際の入力データのrm:user_id と既 存データのrm:user_id が一致していません。 400 same_id 代理人インポートにおいて自分自身を代理人にしよう とした場合に出力されます。 400 found_similar_data 指定されたリソースは類似のデータが見つかったため 更新できませんでした。 業績ID を指定しないmerge 指定の場合、類似データ がみつかった段階で本エラーとなります。 researchmap に登録されている類似の重複データを削 除してから再度インポートを実施してください。 400 empty_body body 部が空です。 400 disallow_logged_user 一度でもログインしたことがある研究者は削除できま せん。 400 not_similar_changed 既存データを修正した結果、別のデータ（類似デー タ）と完全一致したため、更新できない場合に発生し

38

ます。 403 disallow_role 指定した権限での追加/削除は許可されません。 404 not_found 指定されたリソースが見つかりませんでした。 これ は、以下のケースで発生します。 ・ id 指定している情報が存在しなかった。対象とな る情報が削除されている可能性があります。 409 conflict インポートデータの整合性チェック後に該当データに 対して何らかの更新がかかったため更新しませんでし た。 409 similar_conflict 類似データがみつかり、その業績データにてconflict があった場合に出力されます。 409 existing_conflict インポートデータ中のid 指定してある既存データが存 在しなくなったか、あるいは既存データに対して何ら かの更新がかかったため更新しませんでした。既存デ ータの有無を確認してください。 409 input_conflict インポートデータ中に重複する一意のキーが存在しま す。 対象は以下です。 ・ログインID ・パーマリンク ・e メール、携帯メール、その他メール ・研究者番号

39

3.2 プロフィール情報

3.2.1 プロフィール情報取得

単一の研究者のプロフィール情報を返します。

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

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

① JSON 形式でプロフィール情報を取得するサンプル GET https://api.researchmap.jp/{permalink}（注iii）/profile?format=json

3.2.1.1 プロフィール情報レスポンス json 形式 { "@context": "https://api.researchmap.jp/researcher.jsonld", "@id": "https://api.researchmap.jp/{permalink}", "@type": "researchers", "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:user_id": "R000282839", "permalink": "{permalink}", "login_id": "xxxx", "password": "", "previous_password": "", "role": "researcher", "email": "mailto:[email protected]", "receive_email": true, "mobile_email": "mailto:[email protected]", "receive_mobile_email": false,

40

"other_email": "mailto:[email protected]", "receive_other_email": false, "gender": "male", "birth_date": "2017-02-16", "death_date": "2017-02-16", "timezone": "Asia/Tokyo", "language": "jpn", "family_name": { "ja": "情報", "ja-Kana": "ジョウホウ", "en": "Jyouhou" },
"given_name": { "ja": "太郎", "ja-Kana": "タロウ", "en": "Taro " },
"display_name_kana": "researchers_only", "nickname": { "ja": ["太郎.情報"], "en": ["Taro.J"], }, "display_nickname": "researchers_only", "alternate_names": ["Taro E J", "Jouhou T"], "image": "https://researchmap.jp/xxxxxxxxxx.png", "display_image": "disclosed", "nationality": "JPN", "contact_point": "xxxxx@xxxxxx. xxx", "display_contact_point": "disclosed", "affiliations": [ { "rm:institution_code": "1234567890", "affiliation_type": "general_full_time_staff", "affiliation": { "ja": "XX 大学", "en": "XX University" }, "section": { "ja": "XX 学部",

41

    "en": "XX Department" 
  }, 
  "job": { 
    "ja": "外来研究員", 
    "en": "Outpatient Fellow" 
  }, 
  "job_class": "professor", 
  "job_title": { 
    "ja": "xxxxx", 
    "en": "xxxxx" 
  }, 

"effort_rate": 70, "display_affiliation": "disclosed", "display_job": "disclosed" }, { "rm:institution_code": "1234567890", "affiliation_type": "general_full_time_staff", "affiliation": { "ja": "XX 大学", "en": "XX University" }, "section": { "ja": "XX 学部", "en": "XX Department" }, "job": { "ja": "外来研究員", "en": "Outpatient Fellow" }, "job_class": "professor", "job_title": { "ja": "xxxxx", "en": "xxxxx" }, "effort_rate": 30, "display_affiliation": "disclosed", "display_job": "disclosed" }

42

], "degrees": [ { "degree": { "ja": "修士", "en": "Master" }, "rm:institution_code": "1234567890", "degree_institution": { "ja": "XX 大学", "en": "XX University" }, "degree_date": "2008-03", "display_degree": "disclosed" } ], "profile": { "ja": "プロフィール…<div>テスト</div>", "en": "profile…<div>Test</div>" }, "display_profile": "disclosed", "see_also": [ { "@id": "http://xxxxxx", "label": "url" }, { "@id": "http://xxxxxx", "label": "url_en" }, { "@id": " http://orcid.org/9999-9999-9999-9999", "label": "orcid" }, { "@id": " https://jglobal.jst.go.jp/detail?JGLOBAL_ID=9999999999999", "label": "j_global" } ],

43

"display_url": "disclosed", "identifiers": { "erad_id": ["xxxxxx"], "orc_id": ["0000-0000-0000-0000"], "researcher_id": ["xxxxxx"], "j_global_id": ["xxxxxx"] }, "rm:erad_id_verified": true, "rm:orc_id_verified": false, "display_erad_id": "disclosed", "display_orc_id": "disclosed", "display_researcher_id ": "disclosed", "display_j_global_id": "disclosed", "custom_items": { "field_name": { "ja": "xxxxxx", "en": "xxxxxx" } } }

N o. フィールド名 内容 登録／更新時のチェック内容

1. @context フィールド名のIRI 先定義ファイ ルパス（上記の内容で固定） （注 vi）

2. @id 研究者情報IRI 識別子（リソース を一意に示すURL -{permalink}は 会員により変動）

3. @type 「researchers」固定。

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

5. rm:creator_type 作成者種別（注vii）

（更新不可） 6. rm:created 登録日時（GMT） （更新不可） 7. rm:modifier_id 更新者の会員ID （更新不可）

44

（ai からの登録:ai:（AI の種別 key）, API からの登録:
client_id:（client_id）） 8. rm:modifier_type 更新者種別（注 vii） （更新不可） 9. rm:modified 更新日時（GMT） ※ 研究者情報のいずれかの更新に おける最終更新日時 （更新不可） 10. rm:user_id 会員 ID ※ 先頭一桁を「0-9,A-Z」+9 桁の 連番 （更新不可） 11. permalink パーマリンク

文字長範囲（3～20） 半角英数記号 ※ ただし以下は使用不可 ・使用不可な記号 % # < > + ¥ " ' & ? = ~ : ; , @ $ ^ | ] [ ! ( ) * / ・先頭に使えない文字、文字列 root, admin, system, index. ・末尾に使えない文字 $ ・permalink に使えない文字列 home, null ※ rmap.v2 内で、大文字小文字 区別せず一意である こと ※ 新規追加時のみ設定可能 ※ 新規追加時に未設定だと、自 動的に生成されたランダムな文字 列が登録される 12. login_id ログイン ID ※ 追加・更新時のみ設定可。取得 時は項目自体表示されません。 ※ 研究者がアカウント設定画面で login_id を変更できます。 ※ 非公開項目(注 viii) 最小文字長（4） 半角英数記号 ※ ただし以下は使用不可 ・先頭に使えない文字列 root, admin, system ・ログイン ID に使えない文字 列 home, null
※ researchmap 内で、大文字小 文字を区別して一意であること

45

※ 新規追加時に未設定の場合、 自動的に生成されたランダムな文 字列 が登録される 13. password パスワード ※ 追加・更新時のみ設定可。取得 時は項目自体表示されません。 ※ 研究者がアカウント設定画面で password を変更できます。 ※ 非公開項目(注 viii) 最小文字長（8） 半角英数記号 ※ ログイン ID が含まれていな いこと ※ 大小英字、数字、記号すべて を含む 8 文字以上であること ※ 新規追加時に未設定の場合、 自動的に生成されたランダムな文 字列が登録される 14. previous_password 使用中のパスワード ※ 更新時のみ設定可。取得時は項 目自体表示されません。 ※ researchmap に登録されて いるパスワードと同じである こと
※ パスワード更新時には必須 15. role 権限 以下のいずれか "researcher": 研究者 （researchmap 会員） "support_clerk_and_student": 研 究支援事務員・修士課程以下の学 生 "assistant": 代理人 デフォルト: "researcher" ※ 新規追加時のみ設定できます。 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) 選択肢からの単一選択 16. email e メール（value はプレフィックス mailto:をつけます） 。 ※ 更新時は、プレフィックスの有 無に関係なく登録できます。 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 必須項目 メールアドレス形式 RFC に準拠していること

46

※ 非公開項目(注 viii) 17. receive_email e メール受信可否 false：受け取らない。 true：受け取る。 デフォルト: true ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) 選択肢からの単一選択 18. mobile_email 携帯メール（value はプレフィック ス mailto:をつけます） ※ 更新時は、プレフィックスの有 無に関係なく登録できます。 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) メールアドレス形式 RFC に準拠していること

19. receive_ mobile_email 携帯メール受信可否 false：受け取らない。 true：受け取る。 デフォルト: true ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) 選択肢からの単一選択

20. other_email その他のメール（value はプレフィ ックス mailto:をつけます） ※ 更新時は、プレフィックスの有 無に関係なく登録できます。 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) メールアドレス形式 RFC に準拠していること

21. receive_other_email その他のメール受信可否 false: 受け取らない。 選択肢からの単一選択

47

true: 受け取る。 デフォルト: true ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 22. gender 性別 以下のいずれか "male": 男 "female": 女 "other": その他 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 必須項目 選択肢からの単一選択 23. display_gender 性別 公開の有無（注viii） closed：外部へ情報を提供しない （非公開） ※ 一定期間後、廃止予定 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 選択肢からの単一選択 24. birth_date 生年月日 ※ yyyy-MM-dd or yyyy-MM or yyyy ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) 必須項目 有効な日付、日付形式 25. death_date 没年月日（更新不可） ※ yyyy-MM-dd or yyyy-MM or yyy ※ 非公開項目(注 viii) （更新不可） 26. timezone タイムゾーン デフォルト: 「Asia/Tokyo」 ※ 「Asia/Tokyo」、 「America/New_York」等 有効なフォーマット ※ 設定値については、タイムゾ ーン一覧（注 x）を参照して ください。

48

※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注viii) 27. language デフォルト表示言語 （ISO 639-3 に形式） デフォルト: 未選択（自動で表示言 語を判断） jpn: 日本語 eng: 英語 ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注viii) 選択肢からの単一選択 28. family_name 姓 （注ix）

29. ja 姓（日本語） 必須項目 最大文字長（500）

30. ja-Kana 姓（カナ） 最大文字長（500）

31. en 姓（英語）
    必須項目 最大文字長（500）

32. given_name 名（注ix） （ミドルネームも併せて記載）

33. ja 名（日本語） 名(日本語)、名(英語)のいずれか は必須項目 最大文字長（500）

34. ja-Kana 名（カナ） 最大文字長（500）

35. en 名（英語）
    名(日本語)、名(英語)のいずれか は必須項目 最大文字長（500）

36. display_name_kana 氏名（カナ） 公開の有無（注viii） 選択肢からの単一選択

37. nickname 通称等の別名（注ix）

38. ja 通称等の別名（日本語） ※ 配列に値がはいります。 最大文字長（500）

39. en 通称等の別名（英語）
    ※ 配列に値がはいります。 最大文字長（500）

40. display_nickname 通称等の別名 公開の有無（注viii) 選択肢からの単一選択

49

41. alternate_names 業績に使用する名前の表記（複数 記載可） ※ 論文上どのように書かれている かを記載します。 ※ 配列に値がはいります。 ※ 非公開項目(注 viii) 最大文字長（500）

42. image アバター（更新不可） （更新不可）

43. display_image アバター 公開の有無（注 viii） ※ disclosed、あるい は researchers_only を選択可。 選択肢からの単一選択

44. nationality 国籍・地域 （ISO 3166-1 alpha-3 形式） ※ 「生年月日、性別、e メール、 基本情報、業績情報の公開/非 公開情報の表示」が有効であれ ば表示 ※ 非公開項目(注 viii) ISO 3166-1 alpha-3 形式 ※ 設定値については、国・地域 コード一覧（注x）を参照して ください。

45. contact_point 公開用メールアドレス メールアドレス形式 RFC に準拠していること

46. display_contact_point 公開用メールアドレス 公開の有無 （注 viii） ※ disclosed、あるい は researchers_only を選択可。 選択肢からの単一選択

47. affiliations 所属 ※ 配列の一つ目が主たる所属とな ります。 ※ 機関の登録の場合、主たる所 属は必須項目

48. rm:institution_code 機関コード （更新不可）

49. affiliation_type 所属区分 以下のいずれか。 （大学，高等専門学校，研究開発 法人，政府系研究機関等） "general_full_time_researcher" : 常勤研究者 "general_full_time_staff": 常勤 職員（URA 等） "general_part_time_researcher ": 非常勤研究員，職員 選択肢からの単一選択 ※ 所属を登録する場合、研究 者、代理人による登録時には 必須項目（機関による更新時 は必須としない） ※ scope に write が指定された 場合のみ表示・更新可。

50

"general_doctoral_researcher": 博士研究員（ポスドク） "general_doctoral_course": 学 生（博士課程） "general_masters_course": 学 生（修士課程） "general_undergraduate": 学 生（学部） "general_others": その他 "company": 企業 "government": 政府，地方自治体 "npo_ngo": NPO，NGO "independent_researcher": 独立系 研究者 "others": その他 ※ 非公開項目(注viii) 50. affiliation 所属 所属名（注ix） ※ 登録する機関、代理人の所属と 登録しようとしている研究者の 主所属（所属）が等しくない場 合、エラーとなります。 ※ 機関からの登録の場合、自機 関の登録しか許可されないた め、実質、1 つ目の所属は必 須となります。

ja、en のどちらか必須 51. ja 所属 所属名（日本語） 最大文字長（500） ※ ja の項目に入力があれば必須 52. en 所属 所属名（英語） 最大文字長（500） ※ en の項目に入力があれば必須 53. section 所属 部署名（注ix） ※ 登録する機関、代理人の部署と 登録しようとしている研究者の 主所属（部署）が等しくない場 合、エラーとなります。ただ し、部署が空の機関、代理人の 場合、その機関内であれば登録 できます。

ja 所属 部署名（日本語） 最大文字長（500） 55. en 所属 部署名（英語） 最大文字長（500） 56. job 所属 職名（注ix）

ja 所属 職名（日本語） 最大文字長（500） 58. en 所属 職名（英語） 最大文字長（500）

51

job_class 所属 職階 デフォルト: 未選択 "executive": 機関の長相当 "prof_lv": 教授相当 "associate_prof_lecturer_lv": 准教 授・常勤専任講師相当 "assistant_prof_lv": 助教相当 "researcher_postdoc_lv": 研究員・ ポスドク相当 "lecturer": 非常勤講師相当 "research_assistance":研究・教育 補助者相当 "research_admin": 研究管理者相 当 "r_d_engineer": 研究開発・技術者 相当 "curator": 司書・学芸員相当 "expert_etc" :医師・看護士・弁護 士等の専門家相当 "teacher": 専門学校・小中高等の 教員相当 "communicator": コミュニケータ ー相当 "others": その他 ※ 非公開項目(注viii) 選択肢からの単一選択 ※ 所属を登録する場合、研究 者、代理人による登録時には 必須項目（機関による更新時 は必須としない） ※ scope にwrite が指定された 場合のみ表示・更新可。

job_title 所属 称号（注ix）

ja 所属 称号（日本語） 最大文字長（500） 62. en 所属 称号（英語） 最大文字長（500） 63. effort_rate エフォート率（%） 数値範囲（0～100） 数値 ※ scope にwrite が指定された 場合のみ表示・更新可（CSV 形式では更新不可） 64. display_affiliation 所属 所属名・部署名 公開の有無 （注viii） 選択肢からの単一選択

display_job 所属 職名・称号 公開の有無（注 viii） 選択肢からの単一選択

66. degrees 学位 n 回繰り返し（n>=0）

67. degree 学位名（注ix） ja、en のどちらか必須

52

ja 学位名（日本語） 最大文字長（500） ※ ja の項目に入力があれば必須 69. en 学位名（英語） 最大文字長（500） ※ en の項目に入力があれば必須 70. rm:institution_code 学位 授与機関の機関コード（注 xi） （更新不可） 71. degree_institution 学位 授与機関（注ix）

ja 学位 授与機関（日本語） 最大文字長（500） 73. en 学位 授与機関（英語） 最大文字長（500） 74. degree_date 学位 取得年月 ※ yyyy-MM or yyyy 有効な日付、日付形式 75. display_degree 学位 公開の有無（注viii） 選択肢からの単一選択 76. profile プロフィール（注ix）

ja
プロフィール（日本語） 最大文字長（32000） 78. en プロフィール（英語） 最大文字長（32000） 79. display_profile プロフィール 公開の有無（注viii） ※ disclosed、あるい は researchers_only を選択可。 選択肢からの単一選択 80. see_also 対象リソースに関する詳細情報 ※ 記載していないものも出力する ことがあります。

@id 対象リソースのIRI
URL 形式 RFC に準拠していること 最大5000 バイト 82. label 対象リソースタイトル（注xii） （url、url_en 以外は、更新不 可） 83. display_url URL 公開の有無（注viii） 選択肢からの単一選択 84. identifiers 識別子（曖昧性がなく区別できる IDs）

erad_id 研究者番号 ※ rm:erad_id_verified がfalse な らば、更新可。 ※ 配列として複数表示できるよう にしていますが、１項目しか利 用しません。 ※ ユニークキー 研究者番号の正当性チェック ［数字8 桁］ （先頭1 桁がチェックディジット）

orc_id ORCID iD ※ 配列として複数表示できるよう （更新不可）

53

にしていますが、１項目しか利 用しません。 87. researcher_id Researcher ID ※ 配列として複数表示できるよう にしていますが、１項目しか利 用しません。 書式チェック [英大文字(桁数制限なし)]-[数字 4 桁]-[18/19/20 のいずれか][数字 2 桁]

88. j_global_id J-Global ID （更新不可）
89. rm:erad_id_verified 研究者番号が検証されているかど うか。 （更新不可）
90. rm:orc_id_verified ORCID iD が検証されているかど うか。 （更新不可）
91. display_erad_id 研究者番号 公開の有無（注 viii） 選択肢からの単一選択
92. display_orc_id ORCID iD 公開の有無（注 viii） ※ rm:orc_id_verified が false な らば非公開とする 選択肢からの単一選択
93. display_researcher_id Researcher ID 公開の有無（注 viii） 選択肢からの単一選択
94. display_j_global_id J-Global ID 公開の有無（注 viii） 選択肢からの単一選択
95. custom_items カスタム項目 フィールド名（field_name）を object として出力。 レスポンスサンプルは、テキスト （言語毎の出力）の出力例です。 カスタム項目設定時の入力タ イ プでチェック内容が異なる ・テキスト：最大文字長（500） ・テキストエリア：最大文字長 （15000） ・チェックボックス、セレクト ボックス、ラジオボタン：選択 肢の中から選択

3.3 業績種別

3.3.1 業績種別 並べ替え

業績種別のマイポータル上の表示順（研究者情報レスポンスの出力順）を並べ替えるAPI です。 本 API は該当研究者が機関に対して編集を許可し、かつ、機関の更新を「自動的に反映する」と設 定している場合に有効です。「自動的に反映する」と設定していない場合は forbidden エラーとなり ます。また、scope としては、researchers+write が必要です。

リクエスト

54

PATCH https://api.researchmap.jp/{permalink}（注iii）/{achievement_type}（注v） パラメーター（PATCH BODY） No. パラメーター名 項目名 説明 1.

display_sequence 表示順（必 須） 数値で指定。 1 を指定すると、業績種別の１番目に移動さ れます。100 番など大きな値を入力すると最 後尾へ移動されます。

① permalink「sample」ユーザーの論文業績を上から10 番目に並べ替えるサンプル PATCH https://api.researchmap.jp/sample/published_papers {“display_sequence”: “10”}

レスポンス 「研究者情報レスポンス」と同様です。ステータスコード 200 を返します。

3.4 業績リスト

3.4.1 業績リスト取得

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

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

パラメーター（GET） パラメーター名 項目名 説明 format 出力フォーマット 「研究者情報取得」 format 項目と同様。 sort ソート順 デフォルト: 新しい順 ※ 出版年月、受賞年月等、業績毎で利用する項目が 変わります。研究キーワード、研究分野は研究者 が設定した並び順（設定していない場合は、登録 の新しい順）。 modified：更新日の昇順

※ 昇順を降順にする場合、先頭に「-」をつけま す。例：更新日の降順…「&sort=-modified」