Qorus Integration Engine®  5.1.19_git
OMQ::QorusSystemRestHelper Class Reference

class used to call the Qorus REST API for a remote Qorus instance More...

Inheritance diagram for OMQ::QorusSystemRestHelper:
OMQ::QorusSystemRestHelperBase DataStreamClient::DataStreamClient

Public Member Methods

 constructor (string user, string pwd)
 creates the object pointing to the first local listener for the current instance using the given user and password for connecting More...
 
 constructor ()
 creates the object pointing to the first local listener for the current instance More...
 
 constructor (hash< auto > info)
 creates the object with the configuration given
 
 constructor (string name)
 creates the object with the configuration given by the name of the remote instance
 
 autoSetUrl (*hash< auto > opts)
 sets the URL automatically; must be reimplemented in subclasses
 
- Public Member Methods inherited from OMQ::QorusSystemRestHelperBase
 constructor (*hash< auto > opts, *softbool do_not_connect)
 Creates the object with the given options. More...
 
 setURL (string url)
 sets the URL for the object
 
hash< auto > restDoWithInfo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt)
 executes the remote REST call and returns the response More...
 
abstract auto restDo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt, *reference< hash< auto >> info)
 executes the remote REST call and returns the response More...
 
hash< auto > getWithInfo (string path, auto args, *hash< auto > hdr)
 executes a GET call on the remote REST service and returns the response More...
 
auto put (string path, auto args, *hash< auto > hdr, *reference< hash< auto >> info)
 executes a PUT call on the remote REST service and returns the response More...
 
hash< auto > putWithInfo (string path, auto args, *hash< auto > hdr)
 executes a PUT call on the remote REST service and returns the response More...
 
auto post (string path, auto args, *hash< auto > hdr, *reference< hash< auto >> info)
 executes a POST call on the remote REST service and returns the response More...
 
hash< auto > postWithInfo (string path, auto args, *hash< auto > hdr)
 executes a POST call on the remote REST service and returns the response More...
 
auto del (string path, auto args, *hash< auto > hdr, *reference< hash< auto >> info)
 executes a DELETE call on the remote REST service and returns the response More...
 
hash< auto > delWithInfo (string path, auto args, *hash< auto > hdr)
 executes a DELETE call on the remote REST service and returns the response More...
 
hash< auto > doRequest (string m, string path, auto body, *reference< hash< auto >> info, softbool decode_errors=True, *hash< auto > hdr)
 sends an HTTP request to the REST server and returns the response More...
 

Private Member Methods

 warning (string fmt)
 logs a warning
 

Additional Inherited Members

- Static Public Member Methods inherited from OMQ::QorusSystemRestHelperBase
static hash< auto > toConfig (hash< auto > info)
 returns a hash of configuration information for the object
 
- Public Attributes inherited from OMQ::QorusSystemRestHelperBase
const Defaults
 default values for connection options
 
hash conn_opts
 connection params
 
*string api_version
 api version
 
*string name
 connection name if known
 

Detailed Description

class used to call the Qorus REST API for a remote Qorus instance

See also
QorusSystemRestHelperBase for the method documentation

Member Function Documentation

◆ constructor() [1/2]

OMQ::QorusSystemRestHelper::constructor ( )

creates the object pointing to the first local listener for the current instance

This method acquires an authentication token automatically that provides internal system access to Qorus APIs and data

Since
Qorus 3.0.2

◆ constructor() [2/2]

OMQ::QorusSystemRestHelper::constructor ( string  user,
string  pwd 
)

creates the object pointing to the first local listener for the current instance using the given user and password for connecting

Parameters
userthe username for the connection
pwdthe password for the connection
Since
Qorus 3.0.2

The documentation for this class was generated from the following file: