httpGet

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

Availability

This routine is available starting with SIL Engine™ 4.1.0.

Syntax

httpGet(url, request)

Starting with SIL Engine™ 4.5.0:

httpGet(url, request [, proxy])

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.

Requests can also be sent through a proxy.

Parameters

Parameter	Type	Required	Description
url	string	Yes	The URL.
request	HttpRequest	Yes	An HttpRequest object containing headers, cookies, parameters.
proxy	HttpProxy	No	An HttpProxy object containing the host and port of the proxy server.

The request parameter should have the HttpRequest type described here. The HttpProxy type is described here.

Return type

Variable return type - depending on the left hand side operator type. EG: can be a custom struct, string etc.

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;

Note

The request is required, and at least a http header should be set. For example, you can set the "Content-Type" header.

Simple Issue Language™