|
Make an HTTP request to a specified URL. All common HTTP request methods are supported for REST calls. For mime types starting with text or containing "charset" information, the response body can be saved to an installer variable. To download large files, use the "Download file" action instead. The action will succeed if a HTTP response code in the 2xx range is received, otherwise it will fail. You can save the response code to a variable to inspect it in a later action. | Applies to: Installation, Uninstallation | Properties: | - Ask for proxy if necessary [Error Handling]
At first, the connection is attempted with the proxy information that is set for the default browser. If that fails, and this property is selected, a proxy dialog will be shown where the user can configure the proxy that should be used to connect to the web server. - Network failure script [Error Handling]
A script that is executed if the HTTP connection fails in such a way, that the proxy dialog would have to be shown. If you return ErrorHandlingMode.IGNORE, the regular proxy or failure handling will proceed, if you return ErrorHandlingMode.CANCEL, the action will fail immediately. If you can take corrective action in the script, you can return ErrorHandlingMode.RETRY to make the same HTTP request again. However, you have to take special care not to enter an infinite loop. Typically, there should be user input before you retry and the user should be given the option to cancel.The script is only executed for actual network failures, and not if the server or the proxy connection require authentication. - Accept all SSL certificates [Error Handling]
If the protocol of the URL starts with "https" and this property is selected, the SSL certificate will not be checked for validity. This is only recommended for testing purposes when working with self-signed certificates. - Connect timeout [Error Handling]
The timeout for establishing the socket connection in milliseconds. A timeout of zero is interpreted as an infinite timeout. - Read timeout [Error Handling]
The timeout for reading data from the socket connection in milliseconds. A timeout of zero is interpreted as an infinite timeout. - URL [Request]
The URL for the HTTP request. The URL must start with http:// or https://. If you add a query string, it must already be URL encoded.To post a query string with URL-encoded key-value pairs, use the "Form data" property instead of adding the query string here. - HTTP request method [Request]
The request method for the HTTP protocol can be one of GET, POST, HEAD, OPTIONS, PUT, DELETE, TRACE. For POST and PUT, the values entered in the "Form data" property are transmitted in the HTTP message body with the mime type "application/x-www-form-urlencoded". For other request methods, the data is appended as a query string to the URL. - Custom request body
If selected, a custom request body is sent. For form data, use the "Form data" property instead. If both form data and a custom request body are present, the form data is appended to the URL.Note: This property is only visible if "HTTP request method" is set to "POST". - Content type
The content type of the request body. For JSON, use application/json.Note: This property is only visible if "Custom request body" is selected. - Request body
The request body as a string.Note: This property is only visible if "Custom request body" is selected. - Form data [Request]
A list of key-value pairs that should be transmitted with this request. Depending on the request method, they are either appended as a query string to the URL or transmitted in the HTTP message body. Key-value pairs that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate key-value pairs, this allows you to build a variable length list of key-value pairs at runtime. - Request headers [Request]
A list of name-value pairs that should be set as additional headers for the request. Request headers that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate request headers, this allows you to build a variable length list of request headers at runtime. - Perform rollback request [Request]
If selected, a request is performed in case of a rollback. You can configure the rollback request with the child properties. All other properties, such as error handling are shared with the regular request. - Rollback URL
The URL for the rollback request. The URL must start with http:// or https://. If you add a query string, it must already be URL encoded.Note: This property is only visible if "Perform rollback request" is selected. - Rollback HTTP request method
The request method for the HTTP protocol can be one of GET, POST, HEAD, OPTIONS, PUT, DELETE, TRACE. For POST and PUT, the values entered in the "Form data" property are transmitted in the HTTP message body with the mime type "application/x-www-form-urlencoded". For other request methods, the data is appended as a query string to the URL.Note: This property is only visible if "Perform rollback request" is selected. - Custom request body
If selected, a custom request body is sent. For form data, use the "Form data" property instead. If both form data and a custom request body are present, the form data is appended to the URL.Note: This property is only visible if "Rollback HTTP request method" is set to "POST". - Content type
The content type of the request body. For JSON, use application/json.Note: This property is only visible if "Custom request body" is selected. - Request body
The request body as a string.Note: This property is only visible if "Custom request body" is selected. - Rollback form data
A list of key-value pairs that should be transmitted with this request. Depending on the request method, they are either appended as a query string to the URL or transmitted in the HTTP message body. Key-value pairs that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate key-value pairs, this allows you to build a variable length list of key-value pairs at runtime. Note: This property is only visible if "Perform rollback request" is selected. - Variable name for response body [Response]
Optionally, you can enter a variable name that will be set with the text of the response body as an instance of java.lang.String. The variable value will not be written to the log file.Enter the variable without the installer prefix and the dollar sign.The variable will not be set if the mime type does not start with text/ or contain "charset" information. - Variable name for response code [Response]
Optionally, you can enter a variable name that will be set with the response code as an instance of java.lang.Integer. Enter the variable without the installer prefix and the dollar sign. - Variable name for response headers [Response]
Optionally, you can enter a variable name that will be set with the response headers as an instance of java.util.Map. The keys in the map are the header names, and the values are instances of java.util.List<String> with the header values. The variable value will not be written to the log file.Enter the variable without the installer prefix and the dollar sign.
|
|