2.5.5 検索用パラメータ定義内容取得API

検索用パラメータ名の定義内容を取得する際に用いるWebAPIです。

正常に処理が完了した場合は検索条件に合致した検索用パラメータのリストがJSON形式で返却されます。

情報区分コードの指定がない場合はすべて検索用パラメータ名を返却します。

情報区分コードに指定した値が存在しない場合、data_typeはnull、parameter_namesは空(0件)を返却します。

2.5.5.2 リクエスト設計

2.5.5.2.1 リクエストフォーマット

項目		値		備考
APIエンドポイント (相対URI)		/masterget
クエリパラメータ	data_type	任意	情報区分コード	4桁までの任意の値(数字文字列)を指定することができます例) 出荷予定データの場合：10 出荷確定データの場合：20
HTTPメソッド		GET
HTTPリクエストヘッダ	Content-Type	application/json

例)

curl -i -s   -X GET "http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/masterget?data_type=10" -H "Content-Type:application/json"

注)インベントリファイルのapi_tomcat_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、Apache Tomcatのオンラインマニュアルなどを参照してください。

2.5.5.3 レスポンス設計

2.5.5.3.1 レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	X-Request-Id	リクエストID	リクエストを一意に示す値
	X-Frame-Options	DENY
	X-Content-Type-Options	nosniff
	X-XSS-Protection	1; mode=block
	Content-Type	application/json;charset=UTF-8
	Transfer-Encoding	符号化方式
	Date	日付
HTTPレスポンスボディ	search_parameters	検索結果一覧	下記オブジェクトを持っています data_type parameter_names
	data_type	情報区分コード
	parameter_names	検索用パラメータ名一覧	stringの配列

例)

HTTP/1.1 200
X-Request-Id: b95883b3-05a1-40dc-be60-c0abcc6bc5d5
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 27 Jan 2022 10:20:58 GMT 

{"search_parameters":[{"data_type":"10","parameter_names":["xxxxxxxxxx","xxxxxxxxxx"]}]}

2.5.5.3.2 HTTPステータスコード

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が一時的に処理を行うことができない

2.5.5.4 メッセージボディ

HTTPステータスコード	メッセージボディ
200	リソース内容を表示
400/500番台	エラーコードと説明文を表示

2.5.5.5 エラーメッセージ

形式

分類	内容
code	エラーの詳細な種類（HTTPステータスコードではない）
message	エラーメッセージ本文

例）

HTTP/1.1 503
X-Request-Id: f9f9a47d-a59e-4c3d-8f8f-6904c90c6106
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 26 Jan 2022 12:14:11 GMT
Connection: close

{"error_codes":[{"code":"303","message":"Service unavailable."}]}

エラーリスト

HTTPステータスコード	エラーコード	内容
400	001	リクエストボディに誤りがある
400	101	情報区分コードの値が不正である
408	204	データへのアクセスがタイムアウトした
413	205	リクエストボディのサイズが上限値を超えた
500	301	予期せぬエラーが発生した場合
500	303	API側の不具合によるエラー
503	303	API側の不具合によるエラー