データ種別識別子ごとの検索用パラメータ名の定義内容を更新するためのWebAPIです。
本APIはシステム管理者が使用することを想定しています。
指定されたデータ種別識別子の検索用パラメータ名を指定された検索パラメータ名と同じになるように更新します。
既存の検索用パラメータ名が指定されなかった場合は、データテーブルにすでに登録されている検索用パラメータ値も削除されます。
検索用パラメータの定義更新の手順は下記の通りです。
現状の検索用パラメータを知らない場合は、検索用パラメータ定義取得APIを実行する。
本APIを実行し、定義を更新する。
検索用パラメータの定義を設定ファイルなどに記載していた場合は、ファイルとマスタデータの2か所を更新する必要がありますが、定義内容の取得後に更新とすれば更新手順の漏れが発生しにくくなります。
また、事前に検索用パラメータの定義内容を把握していれば、本APIの実施のみとなり、更新漏れを減らすことができます。
項目 | 値 | 備考 | ||
|---|---|---|---|---|
APIエンドポイント (相対URI) | /masterupdate | |||
HTTPメソッド | POST | |||
HTTPリクエストヘッダ | Content-Type | application/json | ||
HTTPリクエストボディ | data_type | 必須 | データ種別識別子 | 任意の値(数字文字列)を指定することができます 例) 出荷予定データの場合：10 |
parameter_names | 必須 | 検索用パラメータ名一覧 | string配列 変換後の値を検索キーとする場合、下記のように指定してください 例) 変換後のファイルの内容が下記のようなxml形式のファイルの場合、\/test\/recode\/groupと指定 <test>
<recode group=”group1“ ></recode>
<recode group=”group2“ ></recode>
</test> | |
curl -i -s -X POST http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/masterupdate -H "Content-Type:application/json" -d "{\"data_type\":\"20\", \"parameter_names\":[\"xxxxx\"]}"注)インベントリファイルのapi_tomcat_portに設定した値を指定
参照
Apahe Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。
Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。
項目 | 値 | 備考 | |
|---|---|---|---|
HTTPステータス | int(3桁) | 正常時200、異常時は後述 | |
HTTPレスポンスヘッダ | Location | リソース作成先URI | 正常終了時、リソース作成場所を表示 |
Content-Type | application/json;charset=UTF-8 | ||
Transfer-Encoding | 符号化方式 | ||
Date | 日付 | ||
HTTPレスポンスボディ | parameter_names | 検索用パラメータ名一覧 | stringの配列 |
HTTP/1.1 200
Location: /database/dbtech
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 27 Jan 2022 10:35:46 GMT
{"parameter_names":["type3"]}HTTPステータスコード | メッセージ | 利用場面 |
|---|---|---|
200 | OK | リクエストの処理に成功した |
400 | Bad Request | リクエスト違反(必須項目が空など)や他の400番台が適さない |
401 | Unauthorized | 認証されていない、または認証に失敗した |
403 | Forbidden | 認証以外の理由でリソースへアクセスできない |
404 | Not Found | サーバーがリクエストされたリソースを発見できない |
408 | Request Time-out | リクエストがタイムアウトした |
415 | Unsupported Media Type | サポートしていないメディアタイプが指定された |
500 | Internal Server Error | APIで障害が発生した |
503 | Service Unavailable | APIが一時的に処理を行うことができない |
HTTPステータスコード | メッセージボディ |
|---|---|
200 | リソース内容を表示 |
400/500番台 | エラーコードと説明文を表示 |
形式
分類 | 内容 |
|---|---|
code | エラーの詳細な種類（HTTPステータスコードではない） |
message | エラーメッセージ本文 |
HTTP/1.1 503
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 27 Jan 2022 08:08:06 GMT
Connection: close
{"error_codes":[{"code":"303","message":"Service unavailable"}]}エラーリスト
HTTPステータスコード | エラーコード | 内容 |
|---|---|---|
400 | 001 | リクエストボディの形式が誤っている |
400 | 002 | データ種別識別子の値が設定されていない |
400 | 008 | 検索用パラメータ名の値が設定されていない |
400 | 101 | データ種別識別子の値が不正である |
400 | 108 | 検索用パラメータ名の値が不正である （検索用パラメータ名の上限を超えた場合も含む） |
401 | 201 | 認証用トークンによる認証に失敗した |
403 | 202 | アクセスが許可されていないユーザーのアクセスによる認可エラー |
408 | 204 | データへのアクセスがタイムアウトした |
413 | 205 | リクエストボディのサイズが上限値を超えた |
500 | 301 | 予期せぬエラーが発生した場合 |
503 | 303 | API側の不具合によるエラー |
POSTメソッドを用いるため無効
リクエスト送受信時の通信タイムアウトは300秒(注)です。
注)これらのパラメータはユーザーによる変更はできません。変更を希望する場合はシステム管理者への依頼が必要となります。
複数の検索用パラメータを指定する際に、カンマ区切りで指定するため、検索用パラメータ名にカンマを使用しないでください。