Availability
This routine is available starting with katl-commons 4.1.0.
Syntax
httpGet(url, request)
Description
Executes an HTTP GET for the given URL using the specified HttpRequest object. The needed parameters can either be included in the initial url or they can be created using the httpCreateParameter routine and added to the HttpRequest parameter.Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | The URL. |
| request | HttpRequest | Yes | An HttpRequest object containing headers, cookies, parameters. |
The request parameter should have the HttpRequest type described here.
Return type
variable return type - depending on the left hand side operator type
Example
You can check whether something exists in the external system. For instance, you can check whether a certain user exists in Salesforce and get the user parameters if such exist.
struct serverInfo{
string baseUrl;
string version;
number [] versionNumbers;
string deploymentType;
number buildNumber;
string buildDate;
string serverTime;
string serverTitle;
}
//Create request
HttpRequest request;
HttpHeader authHeader = httpBasicAuthHeader("admin", "admin");
request.headers += authHeader;
//Post data and get response
serverInfo si = httpGet("http://localhost:8080/rest/api/2/serverInfo?doHealthCheck=false", request);
return si.baseUrl;
See also