HTTP Request

Kalipso - Form - Actions - Actions Description - Group Communications - HTTP Request

Executes a HTTP Request to a HTTP Server.

Action available for the following operating systems:

Parameters

General

• Run From - This parameter allows user to choose between executing a HTTP Request locally (option "locally") or executing a HTTP Request remotely (option "Remotely"). If the user chooses option "Remotely", its necessary to define the following parameters:

  • Communication Profile - Name of the communication profile used to execute the remote HTTP Server.

  • Hidden - This parameter allows user to define if he wants to run the remote HTTP Request in hidden mode or not.

  • Timeout - The timeout defined for connection. The value 0 is System Default. The timeout value is in milliseconds.

• Target Answer Body <string> - The control or variable to save the result of the HTTP Request.

• Target Answer Header <string> - The control or variable to save the result of the HTTP Request Header.

• Target Status Code <string> - The control or variable to save the result of the status code.

• Target Status Text <string> - The control or variable to save the result of the status text.

• Fail if status code isn't 2xx - Defines whether fails if status code isn't 2xx.

Details

• Server <string> - The name of the server to execute the HTTP Request.

• Object <string> - The name of the object to execute the HTTP Request.

• Port <numeric> - The port to communicate with the HTTP server.

• Encoding <string> - The encoding schema used for the communication. The possible options for this parameter are:

  • utf-8

  • utf-7

  • ansi

  • unicode

• Mode numeric - The mode of the HTTP Request. The possible values for this parameter are:

  • 1 - GET

  • 2 - POST

  • 3 - PUT

  • 4 - DELETE

  • 5 - PATCH

  • 6 - HEAD

  • 7 - CONNECT

  • 8 - OPTIONS

  • 9 - TRACE

  • -2 - Reset Session

Note: -2 is only for Win32 clients. It ends the browser session, so that the next HTTP request is equivalent to being executed as if the applications just started. In Android and Win10 clients, it does nothing.

Request

• Additional Header <string> - Defines a additional request header for the HTTP Request.

• Data <string> - The string that represents the request to HTTP Server.

Security

• User <string> - The name of the user for the HTTP Request. If there is no defined user for the web service call, just put "" on this parameter.

• Password <string> - The password of the user of the HTTP Request. If there is no user and password, just put "" on this parameter.

• Certificate File <string> - Path of the client certificate file.

• Certificate File Password <string> - Client certificate File Password.

These last two parameters are not supported on Windows 10 Clients.

• Ignore Invalid Certificates - Defines whether ignores or not Invalid Certificates.

• Certificate Fingerprint List <string> - List of Public Key SHA256 Hash for certificate pinning, separated by CR.

• Public Key Fingerprint List <string> - List of Public Key SHA256 Hash for certificate pinning, separated by CR.

These last two parameters are not supported on Windows Mobile/CE.

In the Server parameter there should be only the server address, without any "/" and the remainder should go in the request Object parameter.

For example when you have a request address like http://www.myserver.com/Name1/Name2 you should call: Server= "http://www.myserver.com" Object="Name1/Name2"

When using Self-signed Certificates, you should set the parameter Ignore Invalid Certificates to Yes, and add the certificate fingerprint in the Certificate Fingerprint List or the Public Key Fingerprint to the Public Key Fingerprint List.

Client certificates and certificate fingerprint validation are not used when executing remotely by using MISCommunicator