APIのパラメータ
リクエストパラメータとレスポンスパラメータの形式について説明します。
(1) リクエストパラメータ
リクエストパラメータの形式は、次のとおりです。
| リクエストパラメータの形式 | 指定方法 |
|---|---|
| パス形式 |
RESI APIのパスとして指定します。 例：'http://ホスト名:ポート番号/api/v1/REQUESTINGAPI/VALUE' |
| クエリ形式 ※ |
REST APIのパスの末尾にクエリ文字列で指定します。 例：'http://ホスト名:ポート番号/api/v1/REQUESTINGAPI?KEY1=VALUE1&KEY2=VALUE2' |
| JSON形式 |
curlコマンドの場合、-dオプションで指定します。 例：-d '{ "KEY1": "VALUE1","KEY2": "VALUE2"}' |
| 配列形式 |
curlコマンドの場合、-dオプションで指定します。 例：-d '["VALUE1","VALUE2"]' |
| formデータ形式 |
ファイルのアップロードで使用します。 curlコマンドの場合、--formオプションで指定します。 例：--form 'file=@ファイル名' |
|
※
|
:
|
クエリ形式のリクエストパラメータについては、URLエンコードしてください。 「受信開始日時」に「Fri Jan 19 14:27:49 2018」を指定する場合の、URLエンコードの例を次に示します。 URLエンコードの例：receivingStartDateStr=Fri+Jan+19+14:27:49+2018 |
(2) レスポンスパラメータ
REST APIの実行後に返却されるレスポンスパラメータの形式は、JSON形式のみです。
|
= 備考 =
返却する値がない場合、レスポンスパラメータの値はnullになります。 |