API parameters
This section explains the format of request parameters and response parameters.
(1) Request parameter
The formats for specifying request parameters are as follows:
| Request parameter formats | How to specify |
|---|---|
| Path format |
Specify as a part of the path for RESI API. Example: 'http://HOSTNAME:PORTNUMBER/api/v1/REQUESTINGAPI/VALUE' |
| Query format * |
Specify by adding characters after the path of REST API in the query format. Example: 'http://HOSTNAME:PORTNUMBER/api/v1/REQUESTINGAPI?KEY1=VALUE1&KEY2=VALUE2' |
| JSON format |
In a curl command, specify -d option. Example: -d '{ "KEY1": "VALUE1","KEY2": "VALUE2"}' |
| Array format |
In a curl command, specify -d option. Example: -d '["VALUE1","VALUE2"]' |
| Form data format |
This format is used for uploading a file. If you use a curl command, specify the parameter by using a --form option. Example: --form 'file=@FILENAME' |
|
*
|
:
|
For the request parameters in the query format, URL encoding is necessary. If you want to specify "Fri Jan 19 14:27:49 2018" for "Reception Start Date and Time", an example of URL encoding is as follows: URL encoding example: receivingStartDateStr=Fri+Jan+19+14:27:49+2018 |
(2) Response parameter
The format for response parameters that are returned after executing REST API function is JSON format only.
|
= Remarks =
If there is no value to be returned, null is set as the value for the response parameter. |