OMQ::QorusLocalRestHelper Class Reference

class for local REST API calls More...

Public Member Methods
auto	doRequest (string m, string path, *hash< auto > args)
	makes a local REST request and returns the response
auto	get (string path, *hash< auto > args)
	makes a local REST GET request and returns the response
auto	put (string path, *hash< auto > args)
	makes a local REST PUT request and returns the response
auto	post (string path, *hash< auto > args)
	makes a local REST POST request and returns the response
auto	del (string path, *hash< auto > args)
	makes a local REST DELETE request and returns the response

Detailed Description

class for local REST API calls

Since

Qorus 4.1

Member Function Documentation

del()

auto OMQ::QorusLocalRestHelper::del	(	string	path,
		*hash< auto >	args
	)

makes a local REST DELETE request and returns the response

Parameters

path	the REST URI path
args	the arguments in the message body for the request

Returns

the response from the server

doRequest()

auto OMQ::QorusLocalRestHelper::doRequest	(	string	m,
		string	path,
		*hash< auto >	args
	)

makes a local REST request and returns the response

Parameters

m	the HTTP method in upper case
path	the REST URI path
args	the arguments in the message body for the request

Returns

the response from the server

get()

auto OMQ::QorusLocalRestHelper::get	(	string	path,
		*hash< auto >	args
	)

makes a local REST GET request and returns the response

Parameters

path	the REST URI path
args	the arguments in the message body for the request

Returns

the response from the server

Note

GET requests should not contain a message body

post()

auto OMQ::QorusLocalRestHelper::post	(	string	path,
		*hash< auto >	args
	)

makes a local REST POST request and returns the response

Parameters

path	the REST URI path
args	the arguments in the message body for the request

Returns

the response from the server

put()

auto OMQ::QorusLocalRestHelper::put	(	string	path,
		*hash< auto >	args
	)

makes a local REST PUT request and returns the response

Parameters

path	the REST URI path
args	the arguments in the message body for the request

Returns

the response from the server

---

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

• QorusLocalRestHelper.qc