GetHTTP

Using the GetHTTP function to retrieve a web page

The following IPL policy will retrieve a web page and log the response:

HTTPHost="maps.googleapis.com";
HTTPPort=80;
Protocol="http";
Path="/maps/api/geocode/xml?address=07002&sensor=false";   
ChannelKey="";
Method="";
AuthHandlerActionTreeName="";
FormParameters=null;
FilesToSend=null;
HeadersToSend=NewObject();
HeadersToSend["Accept-Charset"]="utf-8";
HttpProperties=NewObject();
HttpProperties.ConnectionTimeout=Int(60000);
HttpProperties.ResponseTimeout=Int(60000);
x=GetHTTP(HTTPHost, HTTPPort, Protocol, Path, ChannelKey, Method, AuthHandlerActionTreeName, FormParameters, FilesToSend, HeadersToSend, HttpProperties);
Log(x);

Log(ResultCode); // The http response code
Log(ThePage); // The response body
Log(HeadersSent);  // The http request headers
Log(HeadersReceived); // The http response headers
Log(ErrorReason);  // The error message associated with the response

var FormParameters=NewObject();
var FilesToSend=NewObject();
var HeadersToSend=NewObject();

The following JavaScript policy will retrieve a web page and log the response:

var HTTPHost="maps.googleapis.com";
var HTTPPort=80;
var Protocol="http";
var Path="/maps/api/geocode/xml?address=07002&sensor=false";   
var ChannelKey="";
var Method="";
var AuthHandlerActionTreeName="";
var FormParameters={};
var FilesToSend={};
var HeadersToSend=NewObject();
HeadersToSend["Accept-Charset"]="utf-8";
var HttpProperties=NewObject();
HttpProperties.ConnectionTimeout=Int(60000);
HttpProperties.ResponseTimeout=Int(60000);
var x=GetHTTP(HTTPHost, HTTPPort, Protocol, Path, ChannelKey, Method, AuthHandlerActionTreeName, FormParameters, FilesToSend, HeadersToSend, HttpProperties);
Log(x);

Log(ResultCode); // The http response code
Log(ThePage); // The response body
Log(HeadersSent);  // The http request headers
Log(HeadersReceived); // The http response headers
Log(ErrorReason);  // The error message associated with the response

Using the GetHTTP function with URL encoding

If the resource path contains a query string with non-ASCII text, you must encode the strings using the URLEncode function (see URLEncode) otherwise the request may fail with a java.net.URISyntaxException error.

HTTPHost="example.com";
HTTPPort=443;
Protocol="https";
Path="/api/now/table/incident?" +
  "sysparm_fields=" +
  URLEncode("num,assign_group,state") +
  "&sysparm_limit=500" +
  "&sysparm_offset=0" +
  "&sysparm_query=" +
  URLEncode("sys_updated_on>=1979-01-01T00:01:00.000Z^sys_created_by=test");
ChannelKey="";
Method="";
AuthHandlerActionTreeName="";
FormParameters=null;
FilesToSend=null;
HeadersToSend=NewObject();
HeadersToSend["Accept-Charset"]="utf-8";
HttpProperties=NewObject();
HttpProperties.TrustCertificate=true

x=GetHTTP(HTTPHost, HTTPPort, Protocol, Path, ChannelKey, Method, AuthHandlerActionTreeName, FormParameters, FilesToSend, HeadersToSend, HttpProperties);
Log(x);

Using the GetHTTP function to connect through a proxy server

function sendRequestToServerWithProxy(Host,Port,Protocol,Username,Password, Path, 
 body) {
   body = ""+ body;
    HTTPHost=Host;
    HTTPPort=Port;
    Log("Connecting to Server: " + Host + " on port: " + Port + " with user: " 
        + Username);
    ChannelKey="";
    Method="GET";
    AuthHandlerActionTreeName="";
    Log("Content info: " + body);
    HttpProperties=NewObject();
    HttpProperties.ConnectionTimeout=Int(60000);
    HttpProperties.ResponseTimeout=Int(60000);
    HttpProperties.Content=body;
    Headers = NewObject(); 
    Headers['Connection']='close';
    HttpProperties.UserId = Username;
    HttpProperties.Password = Password;

//optional Password can be encrypted using Encrypt() function or nci_crypt script, 
//if so the following property must be added:
HttpProperties.DecryptPassword = true;

// following section enables proxy redirect.
    HttpProperties.UseProxy = true;
    HttpProperties.ProxyHost = "localhost";  
    HttpProperties.ProxyPort = 8080; 

    GetHTTP(HTTPHost, HTTPPort, Protocol, Path, ChannelKey, Method, 
            AuthHandlerActionTreeName, null, null, Headers, HttpProperties);
  
   return  ThePage;
}  

Path="/full/path/to/server/actios?parameter1=val1&parameter2=val2";  
result=sendRequestToServerWithProxy
         ("localhost",16310,"http","username","password",Path,null); 
Log("result: " + result);   

//make sure to replace all required fields with actual values. 

Authenticating with a proxy server

function sendRequestToServerWithProxy(Host,Port,Protocol,Username,Password, Path, 
 body) {
   body = ""+ body;
    HTTPHost=Host;
    HTTPPort=Port;
    Log("Connecting to Server: " + Host + " on port: " + Port + " with user: " 
        + Username);
    ChannelKey="";
    Method="GET";
    AuthHandlerActionTreeName="";
    Log("Content info: " + body);
    HttpProperties=NewObject();
    HttpProperties.ConnectionTimeout=Int(60000);
    HttpProperties.ResponseTimeout=Int(60000);
    HttpProperties.Content=body;
    Headers = NewObject(); 
    Headers['Connection']='close';
    HttpProperties.UserId = Username;
    HttpProperties.Password = Password;

//optional Password can be encrypted using Encrypt() function or nci_crypt script, 
//if so the following property must be added:
HttpProperties.DecryptPassword = true;

// following section enables proxy redirect 
// and includes authenticating with the proxy server.
    HttpProperties.UseProxy = true;
    HttpProperties.ProxyHost = "localhost";  
    HttpProperties.ProxyPort = 8080; 
    HttpProperties.UseProxyAuth = true;
    HttpProperties.ProxyUserId = ProxyUsername;
    HttpProperties.ProxyPassword = ProxyPassword;

// the following optional line is only required  
// if endpoint authentication is required
// Or alternatively pass the endpoint username and password via
// the HttpProperties.UserId and Password properties 
Headers['Authorization']='Basic '
              + Base64.encode(endpointuser+":"+endpointpassword); 

    GetHTTP(HTTPHost, HTTPPort, Protocol, Path, ChannelKey, Method, 
            AuthHandlerActionTreeName, null, null, Headers, HttpProperties);  
   return  ThePage;
}  

Path="/full/path/to/server/actios?parameter1=val1&parameter2=val2";  
result=sendRequestToServerWithProxy
        ("localhost",16310,"http","username","password",Path,null); 
Log("result: " + result);   

//make sure to replace all required fields with actual values.