Provides actions to manipulate HTTP Requests and Responses.

Summary

Actions
AddAttributeToHtmlTag Adds an attribute to the outermost HTML tag of the document (e.g. xmlns, manifest...).
This method has no effect in Ajax Requests.
AddFaviconTag Allows setting the favicon for the current page. You can use "omlresources" to add an icon file to your oml.
This method has no effect in Ajax Requests.
AddHeader Adds an header to the current HTTP response.
This method has no effect in Ajax Requests.
AddJavaScriptTag Adds a <script> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
AddLinkTag Adds a <link> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
AddMetaHttpEquivTag Adds a <meta> tag with the http-equiv attribute to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
AddMetaTag Adds a <meta> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
AddPostProcessingFilter This method has no effect in Ajax Requests.
Not implemented in Java.
AddSessionToURL Adds the current session identifier to a specified URL.
AddStyleSheetTag Adds a <link rel="stylesheet"> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
GetCookie Gets a cookie value.
GetEntryURL Returns the URL of an Entry. Includes the Personal Area and the session identifier if applicable.
GetFormValue Gets the value of a form field of the current HTTP request.
If the field does not exist in the request an empty String will be returned. The same applies when the field exists but has an empty string as a value.
GetIP Gets the IP host address of the remote client (IP of the user machine performing the HTTP request).
GetPageExtension Returns the extension of the physical page that corresponds to the current screen, including the dot. Examples: ".aspx" or ".jsf".
GetPageName Returns the name of the physical page that corresponds to the current screen. It is usualy the same as the screen name, except when nameclashes occur.
GetRawURL Returns the current relative requested URL, without the http://[server] part and without the session identifier.
If SEO rules are being applied, the URL displayed in the user's browser is returned, and not the final URL after the rule is applied.
GetReferrerURL  
GetRequest_AddArgument Builds the arguments string for an HTTP request with method GET, adding a new parameter to the arguments string.
GetRequest_Submit Submit an HTTP GET request given the GET arguments and the URL. Returns the request response content as a string and as binary data.
GetRequestContent Gets the content of the current HTTP request.
GetRequestDomain Returns the domain of the current HTTP request.
GetRequestFiles Returns the list of files submitted in the current HTTP request.
GetRequestHeader Gets the value of a specific header in the current HTTP request. Returns an empty string if the header is not present or has no value.
GetRunningESpaceJQueryVersion Returns the jQueryVersion of the Running ESpace
GetSessionId Gets the session identifier of the current HTTP request.
GetURL Returns the current absolute requested URL, without the session identifier.
If SEO rules are being applied, the final URL after the rule is applied is returned, and not the URL displayed in the user's browser.
GetURLMethod Gets the request method (GET or POST) of the current requested URL.
GetURLWithSession Gets the current requested URL (with the session identifier).
GetUserAgent Gets the user agent of the current HTTP request.
GetUserLanguages Gets a sorted record list of client language preferences.
GetValueFromInputId  
GetValueFromInputIdDecoded  
IsAjaxRequest Returns true if this is running in an AJAX request.
Not Implemented in Java.
IsSecureConnection Tells if the current request is being made via HTTPS.
MakeAbsoluteURL Makes an absolute URL based on the URL provided.
PostRequest_AddArgument Builds arguments list for a POST HTTP request, adding a new text parameter to the arguments list. If argument name is not supplied, the post will only submit the supplied value (this can be used for xml posts for example).
PostRequest_AddBinaryArgument Builds arguments list for an HTTP request, adding a new binary parameter to the arguments list. If argument name is not supplied, the post will only submit the supplied value (this can be used for xml posts for example).
PostRequest_Submit Submit an HTTP POST request given the POST arguments and the URL. Returns the request response content as a string and as binary data.
ReplaceURLDomain Replaces the domain in the URL by the new domain. This function doesn't accept JavaScript as an URL. If the new domain is not provided, the domain of the current request is used.
RunJavaScript  
SetBaseTag Sets the base tag of the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
SetCookie Sets a cookie.
SetLastModified Sets the Last Modified Date HTTP header of the current response.
SetPageTitle Sets the page title of the HTML of the current HTTP response.
This method has no effect in Ajax Requests.
SetRequestTimeout Sets the timeout of the current HTTP request.
SetStatusCode Sets the status code of the current HTTP response.
URLEncode Encodes a URL string for reliable HTTP transmission from the Web server to a client

Structures
RequestFile  
UserLanguage  

Actions

AddAttributeToHtmlTag

Adds an attribute to the outermost HTML tag of the document (e.g. xmlns, manifest...).
This method has no effect in Ajax Requests.

Inputs


Name
Type: Text. Mandatory.
Value
Type: Text. Mandatory.

AddFaviconTag

Allows setting the favicon for the current page. You can use "omlresources" to add an icon file to your oml.
This method has no effect in Ajax Requests.

Inputs


IconFilename
Type: Text. Mandatory.
The filename of the icon, e.g. "outsystems.ico".
MimeType
Type: Text.
Default: "image/x-icon"
The mime type of the icon file. By default this is "image/x-icon".

AddHeader

Adds an header to the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


Name
Type: Text. Mandatory.
Name of the header.
Value
Type: Text. Mandatory.
Value of the header.

AddJavaScriptTag

Adds a <script> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


JavaScriptURL
Type: Text. Mandatory.
The URL of the JavaScript file.
Defer
Type: Boolean.
Default: False
Defines if the defer attribute is added to the <script> tag. Defaults to False.
Charset
Type: Text.
Default: "UTF-8"
The charset attribute of the <script> tag. Defaults to UTF-8.

AddLinkTag

Adds a <link> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


Rel
Type: Text. Mandatory.
Href
Type: Text. Mandatory.
Type
Type: Text.

AddMetaHttpEquivTag

Adds a <meta> tag with the http-equiv attribute to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


HttpEquiv
Type: Text. Mandatory.
Content
Type: Text. Mandatory.

AddMetaTag

Adds a <meta> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


Name
Type: Text. Mandatory.
Content
Type: Text. Mandatory.

AddPostProcessingFilter

This method has no effect in Ajax Requests.
Not implemented in Java.

Inputs


matchingRegexp
Type: Text. Mandatory.
replacement
Type: Text. Mandatory.

AddSessionToURL

Adds the current session identifier to a specified URL.

Inputs


URL
Type: Text. Mandatory.
URL without session id.

Outputs


URLWithSession
Type: Text.
URL with session id.

AddStyleSheetTag

Adds a <link rel="stylesheet"> tag to the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


StyleSheetURL
Type: Text. Mandatory.
The URL of the CSS file.
Charset
Type: Text.
Default: "UTF-8"
The charset attribute of the <script> tag. Defaults to UTF-8.

GetCookie

Gets a cookie value.

Inputs


CookieName
Type: Text. Mandatory.
Cookie name.

Outputs


CookieValue
Type: Text.
Value for the specified cookie.

GetEntryURL

Returns the URL of an Entry. Includes the Personal Area and the session identifier if applicable.

Inputs


EntryName
Type: Text. Mandatory.
Name of the Entry.
eSpaceName
Type: Text.
Name of the eSpace. If not specified, assumes the current eSpace and gives a relative URL.
FirstParameterName
Type: Text.
First parameter name.
FirstParameterValue
Type: Text.
First parameter value.
SecondParameterName
Type: Text.
Second parameter name.
SecondParameterValue
Type: Text.
Second parameter value.
ThirdParameterName
Type: Text.
Third parameter name.
ThirdParameterValue
Type: Text.
Third parameter value.
FourthParameterName
Type: Text.
Fourth parameter name.
FourthParameterValue
Type: Text.
Fourth parameter value.
FifthParameterName
Type: Text.
Fifth parameter name.
FifthParameterValue
Type: Text.
Fifth parameter value.

Outputs


URL
Type: Text.
URL of the Entry.

GetFormValue

Gets the value of a form field of the current HTTP request.
If the field does not exist in the request an empty String will be returned. The same applies when the field exists but has an empty string as a value.

Inputs


Name
Type: Text. Mandatory.

Outputs


Value
Type: Text.

GetIP

Gets the IP host address of the remote client (IP of the user machine performing the HTTP request).

Outputs


UserIP
Type: Text.
IP of the user machine performing the HTTP request.

GetPageExtension

Returns the extension of the physical page that corresponds to the current screen, including the dot. Examples: ".aspx" or ".jsf".

Outputs


PageExtension
Type: Text.
Extension of the physical page that corresponds to the current screen.

GetPageName

Returns the name of the physical page that corresponds to the current screen. It is usualy the same as the screen name, except when nameclashes occur.

Outputs


PageName
Type: Text.
Name of the physical page that corresponds to the current screen.

GetRawURL

Returns the current relative requested URL, without the http://[server] part and without the session identifier.
If SEO rules are being applied, the URL displayed in the user's browser is returned, and not the final URL after the rule is applied.

Outputs


RawURL
Type: Text.

GetReferrerURL

Outputs


ReferrerURL
Type: Text.

GetRequest_AddArgument

Builds the arguments string for an HTTP request with method GET, adding a new parameter to the arguments string.

Inputs


ArgumentsIn
Type: Text.
Current arguments string.
Name
Type: Text. Mandatory.
New argument name.
Value
Type: Text. Mandatory.
New argument value.

Outputs


ArgumentsOut
Type: Text.
Inputed arguments string concatenated with the pair <argument name> = <argument value>.

GetRequest_Submit

Submit an HTTP GET request given the GET arguments and the URL. Returns the request response content as a string and as binary data.

Inputs


URL
Type: Text. Mandatory.
URL for which to create the GET HTTP request.
Ex: "http://mydomain.com/hello/test.aspx"
Arguments
Type: Text. Mandatory.
GET arguments string.
Ex: "param1=valueOne&param2=valueTwo"
Timeout
Type: Integer.
Number of milliseconds to wait before the request times out.
KeepAlive
Type: Boolean.
Indicates whether to make a persistent connection (True) to the Internet resource or not (False).

Outputs


TextContent
Type: Text.
Response text content.
BinaryContent
Type: BinaryData.
Response binary content.
BinaryContentType
Type: Text.
Value of the Content-Type header returned with the response.

GetRequestContent

Gets the content of the current HTTP request.

Inputs


IncludeHeaders
Type: Boolean.
Default: True
Defines if the headers are included. Defaults to True.

Outputs


RawContent
Type: Text.
The content of the current HTTP request.

GetRequestDomain

Returns the domain of the current HTTP request.

Outputs


Domain
Type: Text.
The domain of the current HTTP request.

GetRequestFiles

Returns the list of files submitted in the current HTTP request.

Outputs


RequestFiles
Type: RecordList of RequestFile.

GetRequestHeader

Gets the value of a specific header in the current HTTP request. Returns an empty string if the header is not present or has no value.

Inputs


HeaderName
Type: Text. Mandatory.
The name of the header

Outputs


Value
Type: Text.
Returns an empty string if the header is not present or has no value.

GetRunningESpaceJQueryVersion

Returns the jQueryVersion of the Running ESpace

Outputs


JQueryVersion
Type: Text.

GetSessionId

Gets the session identifier of the current HTTP request.

Outputs


SessionId
Type: Text.
Session identifier.

GetURL

Returns the current absolute requested URL, without the session identifier.
If SEO rules are being applied, the final URL after the rule is applied is returned, and not the URL displayed in the user's browser.

Outputs


URL
Type: Text.
Current requested URL.

GetURLMethod

Gets the request method (GET or POST) of the current requested URL.

Outputs


Method
Type: Text.
Current request method (GETor POST).

GetURLWithSession

Gets the current requested URL (with the session identifier).

Outputs


URL
Type: Text.
Current requested URL with the session identifier.

GetUserAgent

Gets the user agent of the current HTTP request.

Outputs


UserAgent
Type: Text.

GetUserLanguages

Gets a sorted record list of client language preferences.

Outputs


Languages
Type: RecordList of UserLanguage.
Sorted record list of client language preferences.

GetValueFromInputId

Inputs


InputId
Type: Text. Mandatory.

Outputs


Value
Type: Text.

GetValueFromInputIdDecoded

Inputs


InputId
Type: Text. Mandatory.

Outputs


Value
Type: Text.

IsAjaxRequest

Returns true if this is running in an AJAX request.
Not Implemented in Java.

Outputs


IsAjaxRequest
Type: Boolean.
Returns true if this is running in an AJAX request.

IsSecureConnection

Tells if the current request is being made via HTTPS.

Outputs


IsSecureConnection
Type: Boolean.

MakeAbsoluteURL

Makes an absolute URL based on the URL provided.

Inputs


URL
Type: Text. Mandatory.
Relative or absolute URL.

Outputs


AbsoluteURL
Type: Text.
Absolute URL.

PostRequest_AddArgument

Builds arguments list for a POST HTTP request, adding a new text parameter to the arguments list. If argument name is not supplied, the post will only submit the supplied value (this can be used for xml posts for example).

Inputs


ArgumentsIn
Type: BinaryData.
Current arguments list in Binary format.
Name
Type: Text.
New text argument name.
Value
Type: Text. Mandatory.
New text argument value.

Outputs


ArgumentsOut
Type: BinaryData.
Inputed arguments list concatenated with the pair <argument name> = <argument value> in binary format.

PostRequest_AddBinaryArgument

Builds arguments list for an HTTP request, adding a new binary parameter to the arguments list. If argument name is not supplied, the post will only submit the supplied value (this can be used for xml posts for example).

Inputs


ArgumentsIn
Type: BinaryData.
Current arguments list in Binary format.
Name
Type: Text.
New text argument name.
Value
Type: BinaryData. Mandatory.
New binary argument value.

Outputs


ArgumentsOut
Type: BinaryData.
Inputed arguments list concatenated with the pair <argument name> = <argument value> in binary format.

PostRequest_Submit

Submit an HTTP POST request given the POST arguments and the URL. Returns the request response content as a string and as binary data.

Inputs


URL
Type: Text. Mandatory.
URL for which to create the GET HTTP  request.
Arguments
Type: BinaryData.
POST arguments.
Timeout
Type: Integer.
Number of milliseconds to wait before the request times out.
KeepAlive
Type: Boolean.
Indicates whether to make a persistent connection (True) to the Internet resource or not (False).

Outputs


TextContent
Type: Text.
Response text content.
BinaryContent
Type: BinaryData.
Response binary content.
BinaryContentType
Type: Text.
Value of the Content-Type header returned with the response.

ReplaceURLDomain

Replaces the domain in the URL by the new domain. This function doesn't accept JavaScript as an URL. If the new domain is not provided, the domain of the current request is used.

Inputs


URL
Type: Text. Mandatory.
The URL to replace the domain
Domain
Type: Text.
The new domain to put in the URL.

Outputs


SafeURL
Type: Text.
The URL with the new domain.

RunJavaScript

Inputs


Script
Type: Text. Mandatory.
JavaScript code to be sent to the browser

SetBaseTag

Sets the base tag of the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


HREF
Type: Text. Mandatory.
Target
Type: Text.
Default: ""

SetCookie

Sets a cookie.

Inputs


CookieName
Type: Text. Mandatory.
Cookie name.
CookieValue
Type: Text.
Cookie value.
CookieExpirationSpan
Type: Integer.
Cookie expiration span in minutes. If lower than or equal to zero the cookie will only be valid during current session.
CookiePath
Type: Text.
Cookie path. Defaults to path of the current eSpace, Tenant and Personal Area combination.
CookieDomain
Type: Text.
Cookie domain. Defaults to the current domain.

SetLastModified

Sets the Last Modified Date HTTP header of the current response.

Inputs


LastModifiedDate
Type: DateTime. Mandatory.
Last Modified Date.

SetPageTitle

Sets the page title of the HTML of the current HTTP response.
This method has no effect in Ajax Requests.

Inputs


Title
Type: Text. Mandatory.

SetRequestTimeout

Sets the timeout of the current HTTP request.

Inputs


Timeout
Type: Integer. Mandatory.
Timeout in seconds, or -1 for an infinite timeout.

SetStatusCode

Sets the status code of the current HTTP response.

Inputs


StatusCode
Type: Integer. Mandatory.
Status code of the response. Examples: 404, 403.

URLEncode

Encodes a URL string for reliable HTTP transmission from the Web server to a client

Inputs


StrIn
Type: Text. Mandatory.
String URL
Encoding
Type: Text.
Encoding type: ASCII, Unicode, UTF7 or UTF8

Outputs


StrOut
Type: Text.
Encoded string URL

Structures

RequestFile

Attributes
FileName
Type: Text (50). Mandatory.
FileType
Type: Text (50). Mandatory.
FileSize
Type: Integer. Mandatory.
BinaryContent
Type: BinaryData. Mandatory.

UserLanguage

Attributes
Value
Type: Text (50). Mandatory.

See Also

About APIs