Skip to main content


class HS.HC.RESTOptions extends %Library.RegisteredObject

This class is used to provide additional options either in the creation of a RESTClient to provide default options (if passed to HS.HC.RESTClient:FromURL() or HS.HC.RESTClient:FromHTTPService(), or in a single request to override defaults (if passed to one of the HTTP request methods).

Property Inventory

Method Inventory


property IsReturnStream as %Boolean;
If true, the return value to any request will be null, The returned stream data is accessed via the HttpResponse.Data property after a successful request to
Property methods: IsReturnStreamDisplayToLogical(), IsReturnStreamGet(), IsReturnStreamIsValid(), IsReturnStreamLogicalToDisplay(), IsReturnStreamNormalize(), IsReturnStreamSet()
property IsThrowOnError as %Boolean;
Property methods: IsThrowOnErrorDisplayToLogical(), IsThrowOnErrorGet(), IsThrowOnErrorIsValid(), IsThrowOnErrorLogicalToDisplay(), IsThrowOnErrorNormalize(), IsThrowOnErrorSet()
property Timeout as %Numeric;
Duration (in seconds) after which the HttpClient will abandon the request and return a $$$CSPTimeout status. NOTE for Long Polling: If this value is larger than the "Request Timeout" setting of the Web Gateway, then the server may respond with a 500 error before the client times out.
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet()


method AddHeader(name As %String, value As %String)
Adds a Header to be included into the request headers.
method AddQueryParam(name As %String, value As %String)
Adds a query parameter to be appended to the request URL. The same name may be provided more than once.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab