Qorus Integration Engine
3.0.4.p7
|
qrest
[options] [put|delete|post] path
[?action=...;arg1=...]This script provides a command-line interface to the Qorus REST API. It sends REST requests to the server according to the command-line options and displays the response. Responses are deserialized into a Qore data structure, and the resulting data is then displayed on the screen.
By default, qrest
uses YAML serialization for message bodies to communicate with the Qorus server.
Note that message bodies (to give arguments to a request) may be given in the Qore programming language syntax; qrest
will attempt to parse the command-line arguments and convert to Qore data to be serialized as the message body. Additionally, text separated by commas will be interpreted as a list, and text in the form name=value[,name=value...] will be interpreted as a hash. In this way complex arguments can be passed as the body of the REST request.
Be aware that this program is delivered as a Qore-language script, and, as such, requires the $OMQ_DIR
environment variable to be set to find the Qorus client module.
Options Supported by ocmd
Long Option | Short | Description |
–proxy-url=ARG | -p | Set the proxy URL: "http://host:port" ; at least host or port must be given; ex: "http://proxy1:8080" ; see UNIX Socket Support in URLs |
–path=ARG | -P | use alternate leading REST path in URL |
–timeout=ARG | -t | Set the HTTP timeout in seconds (also the connect timeout) |
–literal | -l | Show literal responses, giving the option 2 times shows HTTP headers |
–show-url | -W | show default Qorus system REST API URL (with path prefix) and exit |
–reformat | -R | reformat data with -l+ for better readability |
–help | -h | Prints command help text |