v2API.pdf

Type: Document | Status: ready

作成者 JST 作成日 2018/10/12 改定者 JST 改定日 2026/4/7

データ交換機関向け researchmap.v2 取得・更新API 設計書 V4.7

i

目次 1. 概要 ························································································································1 1.1 研究者情報の構成 ································································································1 1.2 公開・研究者のみに公開・非公開について ·······························································1 1.3 用語の説明 ·········································································································1 2. API 共通 ··················································································································4 2.1 API のバージョン ································································································4 2.2 認可方法 ············································································································4 2.2.1 概要 ············································································································4 2.2.2 認可プロトコル ·····························································································4 2.2.3 データ交換等の認可方法(OAuth2 JWT Bearer Flow) ······································5 2.2.3.1 Token エンドポイント リクエスト・レスポンス ········································7 2.3 エラー処理 ·········································································································9 2.3.1 通常のバリデーションエラー ···········································································9 2.3.2 認可後のAPI リファレンス呼び出し時の権限エラー ·········································· 10 2.3.3 エラー時レスポンス表 ·················································································· 10 2.3.4 共通バリデーションエラー レスポンス表 ························································ 12 2.4 制限事項 ·········································································································· 15 2.5 リクエスト、正常時レスポンス ············································································ 15 2.5.1 エンドポイント(ベースURL) ···································································· 15 2.5.2 リクエストヘッダ ························································································ 15 2.5.3 レスポンスヘッダ ························································································ 16 2.5.4 ステータスコード ························································································ 17 2.6 2 の注·············································································································· 18 3. API リファレンス ···································································································· 20 3.1 研究者情報 ······································································································· 20 3.1.1 研究者情報取得 ··························································································· 20 3.1.1.1 研究者情報レスポンス ············································································ 20 3.1.2 研究者情報、代理人情報一括取得 ··································································· 22 3.1.2.1 研究者情報、代理人情報一括取得レスポンス ·············································· 25 3.1.3 研究者情報、代理人情報一括更新 ··································································· 25 3.1.3.1 一括更新結果確認 ·················································································· 31 3.1.4 一括更新時バリデーションエラー レスポンス表 ··············································· 36 3.2 プロフィール情報 ······························································································ 39 3.2.1 プロフィール情報取得 ·················································································· 39 3.2.1.1 プロフィール情報レスポンス ··································································· 39 3.3 業績種別 ·········································································································· 53 3.3.1 業績種別 並べ替え ······················································································ 53

ii

3.4 業績リスト ······································································································· 54 3.4.1 業績リスト取得 ··························································································· 54 3.4.1.1 業績リストレスポンス ············································································ 56 3.5 業績情報 ·········································································································· 57 3.5.1 業績情報取得 ······························································································ 57 3.5.1.1 研究キーワード レスポンス ···································································· 57 3.5.1.2 研究分野レスポンス ··············································································· 59 3.5.1.3 経歴 レスポンス ··················································································· 61 3.5.1.4 学歴 レスポンス ··················································································· 65 3.5.1.5 委員歴 レスポンス ················································································ 67 3.5.1.6 受賞 レスポンス ··················································································· 70 3.5.1.7 論文 レスポンス ··················································································· 75 3.5.1.8 MISC レスポンス ·················································································· 84 3.5.1.9 書籍等出版物 レスポンス ······································································· 94 3.5.1.10 講演・口頭発表等 レスポンス ······························································· 101 3.5.1.11 担当経験のある科目(授業) レスポンス ················································ 108 3.5.1.12 所属学協会 レスポンス ·········································································111 3.5.1.13 Works(作品等) レスポンス ······························································· 114 3.5.1.14 共同研究・競争的資金等の研究課題 レスポンス ······································· 119 3.5.1.15 産業財産権レスポンス ·········································································· 126 3.5.1.16 社会貢献活動 レスポンス ····································································· 132 3.5.1.17 メディア報道 レスポンス ····································································· 138 3.5.1.18 学術貢献活動レスポンス ······································································· 142 3.5.1.19 その他 レスポンス ·············································································· 147 3.6 代理人情報 ····································································································· 150 3.6.1 代理人情報取得 ························································································· 150 3.6.1.1 代理人情報 レスポンス ········································································ 151 3.7 研究者情報検索 ······························································································· 152 3.7.1 検索文字列で使用可能な特殊文字 ································································· 158 3.7.2 条件絞り込みとして使用可能なパラメーター ·················································· 159 3.7.2.1 研究キーワード絞り込み ······································································· 159 3.7.2.2 研究分野絞り込み ················································································ 160 3.7.2.3 委員歴絞り込み ··················································································· 160 3.7.2.4 受賞絞り込み ······················································································ 160 3.7.2.5 論文・MISC 絞り込み ·········································································· 161 3.7.2.6 書籍等出版物絞り込み ·········································································· 163 3.7.2.7 講演・口頭発表等絞り込み ···································································· 163 3.7.2.8 担当経験のある科目(授業)絞り込み ························································· 164 3.7.2.9 所属学協会絞り込み ············································································· 164

iii

3.7.2.10 Works(作品等)絞り込み ···································································· 165 3.7.2.11 共同研究・競争的資金等の研究課題絞り込み ············································ 165 3.7.2.12 産業財産権絞り込み ············································································· 166 3.7.2.13 社会貢献活動絞り込み ·········································································· 166 3.7.2.14 メディア報道絞り込み ·········································································· 168 3.7.2.15 学術貢献活動絞り込み ·········································································· 169 3.7.3 研究者情報検索レスポンス ·········································································· 170 3.8 業績情報検索 ·································································································· 171 3.8.1 業績情報検索レスポンス ············································································· 173 3.9 ピックアップ研究者取得 ··················································································· 174 3.9.1 ピックアップ研究者取得レスポンス ······························································ 175 3.10 研究者情報、代理人情報における取得・更新範囲 ·················································· 175 3.10.1 取得範囲における制限 ················································································ 175 3.10.2 追加・更新・削除範囲における制限 ······························································ 176 3.11 3 の注············································································································ 177 4. 改訂履歴 ·············································································································· 180

1

  1. 概要 国立研究開発法人科学技術振興機構(以下、 「JST」という)が運営する researchmap サービスで提 供する researchmap.v2 API では、主に researchmap.v2 の研究者情報の取得・追加・更新・削除を 行う機能を提供します。 researchmap.v2 API は HTTP ベースで動作しますので、ブラウザを含む HTTP ベースのライブラ リで利用することができます。一部の機能を除いては、JST が発行するクライアント ID を使用し認 可プロセスに接続して、一定時間有効なアクセストークンを取得してから利用する必要があります。 詳しくは「認可方法」をご覧ください。

1.1 研究者情報の構成 researchmap の研究者情報は、プロフィール情報と業績情報から成り立っています。 ➢ プロフィール情報は、アカウント情報と基本情報に分けられます。 ・ アカウント情報とは、 「アカウント設定」画面で設定できる非公開項目です。ログインID、 パスワード、権限、e メール、携帯メール、その他のメール、性別、生年月日、国籍・地域、 タイムゾーン、デフォルト表示言語が該当します。 ・ 基本情報とは、 「基本情報」 「所属」 「学位」 「プロフィール」画面で設定できる項目です。 ➢ 業績情報は、研究分野、論文、MISC、書籍等出版物など 19 種類の業績種別を登録することが できます。

1.2 公開・研究者のみに公開・非公開について researchmap の公開フラグは、以下の 3 種類が設定可能です。 ➢ 公開(disclosed) :researchmap で公開 ➢ 研究者のみに公開(researchers_only) :researchmap にログインしたユーザーのみに公開 ➢ 非公開(closed) :researchmap で非公開

アカウント情報の項目はすべて非公開です。researchmap で公開されない項目のため、取り扱いに はご注意ください。 基本情報の公開フラグ(display)がある項目は、researchmap では公開フラグに従って公開されま す。公開フラグ(display)のない項目は非公開です。 業績情報はレコード毎に公開フラグ(display)があり、researchmap では公開フラグに従って公開 されます。

※ 非公開の情報、 研究者のみに公開の情報を取得した場合は、 研究者総覧などにより機関外部へ公 開しないようお願いいたします。

1.3 用語の説明 本設計書で使用する用語について説明します。

2

➢ researchmap.v2 ・ 2020 年2 月にリリースされたresearchmap のバージョン2 の呼称です。 (以下、 「rmap.v2」 という) ・ researchmap.v2 API とは、rmap.v2 が提供するAPI で、本設計書の説明対象です。 (以下、 「rmap.v2 API」「API」という) ➢ researchmap.v1 ・ 旧バージョンの呼称です。(以下、「rmap.v1」という) ・ researchmap.v1 API は、rmap.v1 が提供していたAPI です。(以下、「rmap.v1 API」とい う) ➢ 利用申請 ・ rmap.v2 API を利用するためには、JST への利用申請が必要です。申請方法については rmap.v2 サイトをご覧ください。利用申請は原則として機関単位でお願いします。 ・ 利用申請を受理すると、JST から利用機関へ接続に必要な情報(後述するAPI キー)を発 行します。 ➢ データ交換 ・ 本設計書では大学等の機関がrmap.v2 API を利用して、rmap.v2 とデータのやり取りを行 うことを示します。 ➢ API キー ・ JST が利用機関へ発行する接続に必要な情報です。クライアントID を含む複数の情報で す。 ➢ API 設定 ・ 利用申請に基づいて、管理者がシステムに対して行う設定のことです。 ・ JST がAPI 設定を行い、利用機関へAPI キーを発行します。 ➢ 会員 ・ rmap.v2 にアカウント登録があるユーザーです。下記の種類があります。 ・ 一般会員(研究者)  rmap.v2 の登録研究者を指します。  権限が「researchmap 会員(研究者)」「ReaD 会員(旧システムから移行された研究 者)」「研究支援事務員・修士課程以下の学生」の会員です。  研究者本人、または、機関担当者によって作成されるアカウントです。 ・ 機関担当者  rmap.v2 を利用する機関の担当者を指します。  権限が「データ交換担当者」「所属機関事務担当者」「機関編集者」の会員です。  利用機関からの申請に基づき、JST によって作成されるアカウントです。 ・ 代理人  rmap.v2 の研究者の情報を、本人に代わって編集する人を指します。  権限が「代理人」の会員です。  権限が「researchmap 会員」のユーザーは、「代理人」を兼ねることもできます。

3

 研究者本人からの依頼、または、機関によって作成されるアカウントです。 ・ 管理者  JST の管理者を指します。 ➢ researchmap 会員 ID ・ 会員を一意に特定する ID です。(以下、「会員 ID」という) ・ rmap.v1 では「研究者コード」という呼称でした。 ➢ 研究者番号 ・ e-Rad が研究者に付与する「研究者番号」のことです。 ・ rmap.v1 では「科研費研究者番号」という呼称でした。 ➢ パーマリンク(permalink) ・ rmap.v2 登録研究者の情報を一意に特定する固定識別子です。 ・ 一般会員の研究者情報は 「https://researchmap.jp/{パーマリンク}」 という URL で公開さ れます。この URL で公開される画面を、その会員の「マイポータル」と呼びます。 ・ アカウント登録時に、本人が設定する値です。 ・ 本人以外がアカウントを作成した場合、本人の初回ログイン時に一度だけパーマリンクを 好きな文字列に変更することができます。(このように変更される可能性があるため、会員 を一意に特定する用途にはパーマリンクではなく会員 ID をご利用ください。) ・ 一般会員以外の会員(機関担当者のように研究者情報を公開しない会員) については、 他と 重複しないランダムな値が設定されます。 ・ rmap.v1 では「リンク識別子」という呼称でした。 ➢ 業績種別(achievement_type) ・ rmap.v2 に登録できる業績の種別で、19 種別あります。 ➢ 業績 ID(achievement_id) ・ rmap.v2 の登録業績の ID です。rmap.v2 の登録業績を一意に特定することができます。 (以下、 「業績ID」という) ➢ リソース ・ rmap.v2 API で操作する対象を意味します。 ・ エラーメッセージ中のリソースという単語は、 「API で取得・更新を行おうとした対象(研 究者アカウント、研究者プロフィール情報、業績情報)」を意味します。 ➢ 未設定 ・ 一括更新 API で業績情報を更新する際、業績ID を指定して value 値を""(未設定)で更新 すると、既登録データを空値で更新します。

4

  1. API 共通

2.1 API のバージョン 本設計書は rmap.v2 API(バージョン 2)について記述します。

2.2 認可方法

2.2.1 概要 rmap.v2 API では OAuth 2.0 を利用したセキュアなアクセス方法を実現します。

rmap.v2 API を利用する機関は、JST から発行されたクライアント ID を使用して認可プロセスに接 続し、 一定期間有効なアクセストークンを取得することができます。 アクセストークンを使用すると、 一時的にセキュアな方法で rmap.v2 API を利用できます。プライバシーをチェックするために、ほ とんどの rmap.v2 API の呼び出しについてはアクセストークンを使用する必要があります。

アクセストークンはランダムな文字列で、 有効期限切れとなる日時と、許可範囲の情報が含まれてい ます。リクエストに含まれるアクセストークンを rmap.v2 が有効と判断した時、リクエストした操 作が可能となります。

2.2.2 認可プロトコル rmap.v2 API を利用するクライアントアプリケーションは、OAuth 2.0 の認可プロトコルを使用し てアクセストークンを取得できます。 アプリケーションのタイプ OAuth2 の認可プロセス 人の許可を介さないサーバー間連携(データ交 換) OAuth2 JWT Bearer Flow ※ OAuth2 の仕様については、RFC6749 (https://openid-foundation-japan.github.io/rfc6749.ja.html)、 RFC6750(https://openid-foundation-japan.github.io/rfc6750.ja.html)、 JWT Bearer RFC7523(https://tools.ietf.org/html/rfc7523)、 RFC7521 (https://tools.ietf.org/html/rfc7521) セキュリティの注意点 RFC6819(https://openid-foundation-japan.github.io/rfc6819.ja.html) に沿って行います。

5

2.2.3 データ交換等の認可方法(OAuth2 JWT Bearer Flow)

利用機関が API キーを使って、自機関の所属研究者のデータの取得・追加・更新・削除を行うため の認可方法です。利用機関が可能な操作は API キーに許可された権限だけではなく、研究者が自機 関に許可している権限と合わせて決定されます 。この認可プロセスでは研究者本人の同意なしに研 究者情報の操作が行われるので、研究者が事前にその旨を承諾している必要があります。

サーバー間での認可プロセスでは、rmap.v2 を利用するクライアントアプリケーション(以下、 「ア プリケーション」 という)で JSON Webトークン(JWT)を作成して暗号署名する必要があります。 以下で認可プロセスを説明します。

  1. エンドユーザーからアプリケーションへアクセスします。
  2. JWT を生成します。JWT は三つの要素から成り立ちます。 (ア) header: 暗号化の方法とトークン方式を含んだ JSON。 (イ) claim: クライアント ID やトークンの有効期限などから成る JSON。 (ウ) signature: header、claim の JSON をそれぞれ URLSafe Base64 エンコードし、ピリオド で連結した文字列に署名を追加したもの。署名アルゴリズムは、header の alg に指定して いる「RS256」(RSA SHA256)が使用されます。例えば PHP では、openssl_sign メソッ ドを使用することで RS256 による署名が可能です。 上記三つの要素を改行なしで URLSafe Base64 エンコードし、その文字列をピリオドで連結し たものが JWT となります。
  3. JWT を rmap.v2 のトークン API に送信します。 トークンAPI の URL については、 次項「2.2.3.1
    Token エンドポイント リクエスト・レスポンス」をご覧ください。

6

rmap.v2 のトークンAPI ではURLSafe Base64 デコードした後、クライアントID に対応した 公開鍵を使ってJWS 署名を復号します。そして復号したもので改ざんチェックが行われ、改ざ んされていないことが確認できたら、claim をリクエストとして処理します。この時点で有効期 限が切れていた場合や一意性がない場合はエラーを返します。 5. rmap.v2 が改ざんチェック、有効期限チェック、クライアントID チェック等を行った後、正し ければアクセストークンを返却します。

各header、claim の内容について以下の表にて説明します。 header フィールド名 内容 説明 alg(必須) 署名アルゴリズム (必須) 「RS256」固定 typ(必須) トークンタイプ(必 須) 「JWT」固定

claim フィールド名 内容 説明 iss トークン(JWT)発 行者(必須) クライアントID を指定します。 aud 利用者(必須) 「https://api.researchmap.jp/oauth2/token」の「/」を エスケープして指定します。 「https:¥/¥/api.researchmap.jp¥/oauth2¥/token」 sub 主体(必須) 「0」固定。 exp JWT の有効期限(To) (必須) 数値日付値(UNIX タイムスタンプ)にする必要があり ます。 ※ 通常、2 分に満たない程度で設定します。 ※ 現在時刻よりも未来の日時を表すUNIX タイムス タンプ値を設定します。 iat JWT の発行時間 (From)(必須) トークンの発行時間のチェックを行うため利用されま す。 ※ 現在時刻よりも過去の日時を表すUNIX タイムス タンプ値を設定します。 ※ 発行時間とリクエストされた時間と比較し5 分以 上ずれがない必要があります。

JWS 署名(JWS Signature) (URLSafe base64encode(header). URLSafe base64encode(claim). URLSafe base64encode(jws signature))

7

2.2.3.1 Token エンドポイント リクエスト・レスポンス API リクエスト方法について説明します。

トークンAPI リクエスト(Token エンドポイント) POST https://api.researchmap.jp/oauth2/token Host: xxxxxx.example.com Content-Type: application/x-www-form-urlencoded

トークンAPI パラメーター(POST BODY) パラメーター名 項目名 説明 grant_type 認可タイプ(必須) 「urn:ietf:params:oauth:grant-type:jwt-bearer」固定。 ※ urlencode をする必要があります。 assertion JWT (必須) JWT については、「データ交換等の認可方法(OAuth2 JWT Bearer Flow)」参照。 scope 許可範囲 デフォルト: API キーに設定された許可範囲。 半角スペース区切りで複数の値を指定できます。 指定できる値については(注i)をご覧ください。 ※ 操作範囲を限定する際に指定します。(利用申請で許 可された範囲を超える設定はできません。) ※ 研究者の情報が取得・更新できるか否かは、scope だけではなく、研究者の権限設定に基づき決定され ます。 version バージョン 「2」固定

① 研究者のプロフィール情報の取得が可能、更新は不可能な権限のトークンを取得するサンプル POST https://api.researchmap.jp/oauth2/token Host: xxxxxx.example.com Content-Type: application/x-www-form-urlencoded { “grant_type”=”urn:ietf:params:oauth:grant-type:jwt-bearer”, “assertion”="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", “scope”=”profile read”, “version”=”2” }

トークンAPI レスポンス HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8

8

X-Frame-Options:DENY Cache-Control: no-cache, no-store, max-age=0, must-revalidate Pragma: no-cache { "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "token_type": "Bearer", "expires_in": 3600 "version": "2", "scope": "read public_only profile basic" }

レスポンスのアクセストークンを使用して、データの取得・更新ができます。アクセストークンの有 効期限が切れた場合、再度、本API を用いて取得しなおしてください。アクセストークン取得後の データ取得・更新方法については「API リファレンス」をご覧ください。

フィールド名 内容 説明 access_token アクセストークン (必須) expires_in で指定された期限まで有効なトークン文字 列。以降、権限が必要なリクエスト時に使用します。 token_type トークンタイプ(必 須) 「Bearer」固定。 expires_in 有効期限(必須) access_token の生存期間が秒単位で表示されます。 例えば、3600 ならば、1 時間後にaccess_token が 失効することを意味します。 version バージョン(必須) 取得するAPI のバージョンを返します。 scope 許可範囲 (必須) 許可範囲をアプリケーションに通知します。リクエス ト時に指定した文字列とは違う文字列となる場合があ ります。

9

2.3 エラー処理

API にリクエストを送ると、様々なエラーが返される場合があります。 エラーの出力方式には、リクエスト先、リクエスト内容、レスポンス先に応じて以下のパターンがあ ります。 ・ 通常のバリデーションエラー ・ 認可後のAPI リファレンス呼び出し時の権限エラー(アクセストークンが不正、有効期限切れ 等)

以下では、各出力方式のエラーコード、エラー内容について説明します。

2.3.1 通常のバリデーションエラー

{ "error": "invalid_request", "error_description": "Invalid field selection hogehoge", "error_uri": "http://xxxxx.xxxxx" "field_name": "gender" "errors": [ { "error": "エラー理由",

"error_description": "エラーの説明文",

"field_name": "フィールド名" } ] } ※ 複数のエラーがある場合、errors の項目が追加されます。これは、更新系API 呼び出し時に複数 の入力チェックのエラー結果を返す場合に利用されます。 ※ フィールド名固有のエラーの場合、field_name の項目が追加されます。こちらも更新系API 呼 び出し時に利用されます。

レスポンスの各項目を以下で説明します。 項目名 内容 備考 error エラー理由 2.3.3 エラー時レスポンス表の error(Reason)参照。 error_description エラーの説明文。 ASCII エンコードされたエラーの説

10

明文です。 error_uri エラーについての追加情報を含む Web ページのURI(あれば表示)

field_name フィールドのバリデーションエラーの 場合、そのフィールド名が記載されま す。 JSON の階層構造の下の項目が エラーになった際は 「name.ja」のようにドットで 階層を表します。

2.3.2 認可後のAPI リファレンス呼び出し時の権限エラー Authorization リクエストヘッダ経由で認証を試み、その際にHTTP ステータスコード 401 (Unauthorized)が返る場合(「エラー時レスポンス表」のstatus code=401 の理由により無効だ った場合)、WWW-Authenticate レスポンスヘッダが出力されます。 また、それと共に2.3.1 通常のバリデーションエラーに沿ったJSON も返却します。通常時のエ ラーについてもレスポンスヘッダは、「WWW-Authenticate」レスポンスヘッダを出力する以外、同 様となります。

HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer realm="api.researchmap.jp", error="{error(Reason)}", error_description="{error_description}", error_uri="{error_uri}", scope="{scope}"

レスポンスの各項目を以下で説明します。 項目名 内容 備考 realm 認証領域 「api.researchmap.jp」 固定

error エラー理由 エラー時レスポンス表のerror (Reason)参照。 error_description エラーの説明文

error_uri エラーについての追加情報を含む Web ページのURI(あれば表示)

scope アクセストークンに紐づくscope の内 容。scope のエラーであった場合、表 示。

詳しくは「WWW-Authenticate レスポンスヘッダフィールド」を参照してください。

2.3.3 エラー時レスポンス表

アクセス時に返すエラー理由と内容について説明します。 status error(Reason) 原因・対処方法

11

code 302 unsupported_response_type 要求されたレスポンスタイプをrmap.v2 がサポートして いません。 400 unauthorized_client クライアントアプリケーションは現在の方法で認可コー ドを取得することを認可されていません。

[対処方法] 利用申請時に許可していない認可プロセスを使用してい ないか、クライアントID が正しいかどうか、JWT によ る署名情報が正しいかどうか確認してください。 400 access_denied rmap.v2 がリクエストを拒否しました。 400 invalid_scope リクエストスコープが不正、あるいは形式に問題があり ます。 400 invalid_grant 提供された認可タイプが不正、有効期限切れ、失効して います。 JWT Bearer Flow のiss、または、sub、alg が不正な場 合でも、本エラーとなります。 400 unsupported_grant_type 要求されたグラントタイプをrmap.v2 がサポートしてい ません。 400 invalid_version バージョンが不正です。 400 parse_error JSON 等のパースに失敗しました。 400 Or 405 invalid_request 認可関連の必須パラメーターが指定されていません。 400 invalid_client 指定されたクライアントID が不正、または有効ではあ りません(秘密鍵を指定していないなど)。 401 invalid_token 使用しているアクセストークンの有効期限が切れている か無効です。または、アクセストークンが指定されてい ません。 401 malformed_token 使用しているアクセストークンが、期限が設定されてい ない不正なトークンです。 401 insufficient_scope 指定されたリソースへの権限が不正です。

以下のような場合、このエラーとなります。 ・更新できる権限が無いにもかかわらず、更新を実行し ようとした。

[対処方法]

12

更新しようとしているリソースに対して更新権限がある かご確認ください。詳しくは「認可方法」の項目を参照 してください。 401 invalid_ip 設定されたIP アドレス外からアクセスしようとしていま す。

[対処方法] ご使用のサーバーのIP アドレスを確認し、必要に応じて IP アドレスの設定変更の申請をしてください。 403 forbidden 研究者が追加・更新・削除を許可していません(注ii)。 アカウント情報までの編集許可がない場合にアカウント 情報を更新しようとした場合も含まれます。 404 not_found 指定されたリソースが見つかりません。

以下のような場合、このエラーとなります。 ・ リクエストされたリソースが存在しない。 ・ アクセスが許可されていないリソースへアクセスし ようとした。 405 method_not_allowed 許可されていないメソッドを使用しようとしています。

以下のような場合、このエラーとなります。 ・POST メソッドの使用が許されていないエンドポイン トへ、POST メソッドでリクエストした。 416 max_search_result データ取得時に検索結果が多すぎる場合に発生します。 start+limit は10000 以下にしなければなりません。 500 database_error データベースでの処理中にエラーが発生しました。 500 server_error 要求の処理中に予期しないエラーが発生しました。

2.3.4 共通バリデーションエラー レスポンス表

rmap.v2 API の更新系API を実行した際の共通バリデーションのエラー理由とチェック内容につい て説明します。 code Reason フィールド名 チェック内容 400 required_value (フィールド共 通) 必須項目チェック

必須項目を記入しないで更新しようとした 場合、本エラーとなります。

13

「※ja(en)の項目に入力があれば必須」と 記入してある日本語と英語を持つ必須項目 は、以下のように必須項目チェックを行い ます。 ・ 日本語項目のいずれかが入力されてい る場合、必須項目(日本語)は必須と なる。 ・ 英語項目のいずれかが入力されている 場合、必須項目(英語)は必須となる。 400 invalid_request (フィールド共 通) リクエストにサポート外のパラメーターが 付与されている、その他不正な形式であっ た場合、このエラーメッセージが表示され ます。 ただし、インポートにて未定義の項目名を 指定した場合は無視されます。 400 disallow_update (フィールド共 通) 更新許可チェック 更新を許可していないカラムを更新しよう とした場合、本エラーとなります。 400 unique_value (フィールド共 通) 重複チェック 400 invalid_string_length (Text フィール ド共通) 文字数チェック テキスト:500 テキストエリア:15000 文字 プロフィール:32000 文字 ※ その他文字長制限がある項目は、個別 に記載されています。 400 invalid_format (Text フィール ド共通) 書式が不正かどうかのチェック 400 invalid_url (Text フィール ド共通) URL チェック 400 invalid_email (Text フィール ド共通) Email チェック 400 invalid_date (Date/DateTime フィールド共通) 日付の型チェック 400 invalid_date_range (Date/DateTime フィールド共通) 日付の期間チェック 400 invalid_numeric (数値フィールド 共通) 数値チェック 400 invalid_numeric_range (数値フィールド 数値範囲チェック

Page 1 of 11