---

Purpose

Executes any valid HTTP query, via an Agent Connection and outputs a JObject.

---

Macro Compatibility

---

Usage

This macro cannot be run using Post, Put, Patch, or Delete methods unless the Schedule is locked by an Admin. Your Admin will need to set this up. This also means that in Report Studio, only Admins can use these methods. Note: this macro always outputs a JObject in Normal or Legacy Modes.

---

Parameter	Type	Presence	Purpose	Options	Default
url	String	Mandatory	The URL. This is an absolute URL.	N/A	N/A
body	String	Optional	The HTTP body to send. It is sent as raw, but you have several sub-choices with the 'bodyFormat' parameter.	N/A	N/A
bodyFormat	HttpBodyFormat	Optional	The HTTP body format to send.	Text Json	Text
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
connectionName	String	Optional	The name of the Agent Connection.	N/A	N/A
criticalAfter	DateTimeOffset	Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset	Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String	Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color	Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color	Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double	Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String	Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String	Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	String	Optional	The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
criticalLe	String	Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String	Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String	Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color	Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorAfter	DateTimeOffset	Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset	Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String	Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color	Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean	Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color	Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double	Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String	Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String	Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	String	Optional	The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
errorLe	String	Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String	Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String	Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
errorTableCellBackgroundColor	Color	Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
fatalAfter	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String	Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color	Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean	Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color	Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double	Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String	Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String	Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalIf	String	Optional	The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
fatalLe	String	Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String	Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String	Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color	Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
headers	List<String>	Optional	The HTTP headers to send. They should be specified using this format: header1=value1;header2=value2,... You may also use any alternative to '=' to split header name and value, e.g. if the value itself might contain '=' (for example a Cookie header name with value JSESSION ID=123456789), then the input can instead be delimited by another character such as: headerValueDelimiter=^, headersCookie^JSESSION ID=123456789,...	N/A	N/A
headerValueDelimiter	Char	Optional	The character used to split the header names and values in the 'headers' parameter.	N/A	=
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
infoAfter	DateTimeOffset	Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset	Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String	Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color	Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean	Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color	Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double	Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String	Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String	Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String	Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String	Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String	Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String	Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color	Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
method	HttpRequestMethod	Optional	The HTTP method to use e.g. Get, Post, Put, Patch, or Delete.	Get Post Put Patch Delete	Get
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
normalFontBackgroundColor	Color	Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBold	Boolean	Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontColor	Color	Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontSize	Double	Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalTableCellBackgroundColor	Color	Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
properties	List<String>	Optional	The property or properties to obtain.	All AllAsJObject AllAsJson Content Headers IsSuccess ReasonPhrase StatusCode	AllAsJObject
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
serverType	SystemAccess.ServerType	Optional	The type of server.	Mssql None Postgres	Mssql
singleValueList Normal mode	Boolean	Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A
timeoutMs	Int32	Optional	The timeout in milliseconds.	From 1000 to 2147483647	60000
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
warningAfter	DateTimeOffset	Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset	Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String	Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color	Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean	Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color	Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double	Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String	Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String	Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	String	Optional	The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
warningLe	String	Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String	Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String	Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color	Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

---

Examples (11)

Example 1:

This example shows how to use 'method=Post' to fetch the contents of a website, then creates a JObject that contains all the details. It then uses the [Calculate:] macro shorthand of [.:] to obtain the status code:

[Agent.WebQuery: url="http://www.google.com", method=Get, timeoutMs=120000, storeAsHidden=GetResult1]
The status code is: [.:GetResult1.StatusCode]

---

Example 2:

This example shows how to use 'method=Get' to obtain an entity via a REST API:

[Agent.WebQuery: url="https://api.test.testsite.net/odata/people(154)", method=Get, headers=`Authorization=Bearer v2 token:xxxxx/xxxxx;Host=api.test.testsite.net;User_Agent=PostmanRuntime/7.41.2`, properties=Content;StatusCode;ReasonPhrase, timeoutMs=12000, storeAs=GetResult2]

---

Example 3:

This example shows how to use 'method=Get' to obtain an entity via a REST API:

[Agent.WebQuery: url="http://httpbin.org/anything?a=b&c=d", method=Get, properties=Content;StatusCode;ReasonPhrase, storeAs=GetResult3]

---

Example 4:

This example shows how to use 'method=Post' to create an entity via a REST API:

[Agent.WebQuery:url="https://api.test.testsite.net/odata/people", method=Post, headers=`Authorization=Bearer v2 token:xxxxx/xxxxx;Host=api.test.testsite.net;User_Agent=PostmanRuntime/7.41.2`, body=`{ "UserName" : "Banana1", "IsSuperAdmin" : false, "IsApproved" : false, "BadgeEmailNotify" : true, "IsTenantAdministrator" : false, "Name" : "Banana user created via web query macro", "Description" : "For Testing" }`, bodyFormat=Json, properties=Content;StatusCode;ReasonPhrase, storeAs=PostResult1]

---

Example 5:

This example shows how to use 'method=Post' to create an entity via a REST API:

[Agent.WebQuery:url="http://httpbin.org/anything?a=b&c=d", method=Post, headers=`Header1=value1;Header2=value2`, body=`{ "thing1" : "thing2" }`, bodyFormat=Json, properties=Content;StatusCode;ReasonPhrase, storeAs=PostResult2]

---

Example 6:

This example shows how to use 'method=Patch' to update an entity via a REST API:

[Agent.WebQuery:url="https://api.test.testsite.net/odata/people(154)", method=Patch, headers=`Authorization=Bearer v2 token:xxxxx/xxxxx;Host=myhost.net;User_Agent=PostmanRuntime/7.41.2`, body={ "Description" : "abcde1" }, bodyFormat=Json, properties=Content;StatusCode;ReasonPhrase, timeoutMs=120000, storeAs=PatchResult1]

---

Example 7:

This example shows how to use 'method=Patch' to update an entity via a REST API:

[Agent.WebQuery:url="http://httpbin.org/anything?a=b&c=d", method=Patch, headers="Header1=value1;Header2=value2", body="Body as text", bodyFormat=Text, properties=Content;StatusCode;ReasonPhrase, storeAs=PatchResult2]

---

Example 8:

This example shows how to use 'method=Delete' to delete an entity via a REST API:

[Agent.WebQuery:url="https://api.test.testsite.net/odata/people(434)", method=Delete, headers=`Authorization=Bearer v2 token:xxxxx/xxxxx;Host=myhost.net;User_Agent=PostmanRuntime/7.41.2`, properties=Headers;StatusCode;ReasonPhrase, timeoutMs=120000, storeAsHidden=DeleteResult1]

---

Example 9:

This example shows how to use 'method=Delete' to delete an entity via a REST API:

[Agent.WebQuery:url="http://httpbin.org/anything?a=b&c=d", method=Delete, headers="Header1=value1;Header2=value2", properties=Headers;StatusCode;ReasonPhrase, storeAsHidden=DeleteResult2]

---

Example 10:

This example shows how to use 'method=Put' to put an entity via a REST API:

[Agent.WebQuery:url="http://httpbin.org/anything?a=b&c=d", method=Put, headers="Header1=value1;Header2=value2", properties=Content;StatusCode;ReasonPhrase, storeAsHidden=PutResult]

---

Example 11:

This example shows how to use the 'headerValueDelimiter' parameter to change the delimiter between the header names and values:

[Agent.WebQuery:url="http://api.test.testsite.net/odata/people(154)", method=Get, headerValueDelimiter=`*`, headers="Header1*value1;Header2*value2;Header3*JSESSION ID=123456", properties=Content;StatusCode;ReasonPhrase, storeAsHidden=CustomHeaderResult]