General
Request parameters are of one of the following types.
Argument Types
| Type |
Description |
| PathParm |
Argument value included in the URL. e.g. engine in /matchITHub/engines/<engine> |
| QueryParm |
Argument indicated following '?' in the URL of a GET. e.g. data in /matchITHub/engines/<engine>/tables/1?data=<data> |
| FormParm |
Argument in body of POST with Content-Type: multipart/form-data. |
| JsonParm |
Argument in body of POST with Content-Type: application/json. |
The following format of response is returned by all requests except "POST results".
Success Response
| Name |
Value |
Description |
| status |
“OK” |
Indicates success |
Error Response
| Name |
Value |
Description |
| status |
“FAIL” |
Indicates an error occurred |
| errorMsgs |
<error messages> |
List of error message in an array |
