Post request

Actions of type Post request allow form data to be sent as a POST request to the specified URL, thus providing a universal interface to other services.

Parameters

POST request details

Send URL

Represents the address to which the POST request should be sent.

XSL template

In most cases, the external service to which the POST-Request was transmitted will return a response in the form of XML or HTML. In some cases, it may be necessary for these to be displayed or further processed in other actions. By selecting an XSL template you have the possibility to prepare the returned response or format it differently.

Character set of the call

Determines with which character set the POST-Request is sent.

Character set of the response page

Specifies with which character set the response is to be received.

Provide as completion page

Deliver the response of the action to the client. If this option is disabled, the default FORMCYCLE response will be delivered.

Additional parameters

Additional headers

A list of headers can be stored here, which will be transmitted in any case.
Transfer all form values

Is the possibility to transfer all data collected from the form. The name of the form element or Alias is here the field identifier within the POST-Request. The value is the input from the form.

Use aliases (for form elements and uploads).

Form fields are submitted with their form field aliases instead of form field names.

Additional parameters

A list of parameters can be stored here, which will be transferred in any case. Often additional static information is stored here, which is required by the external service, or if field identifiers are expected to be different from those stored in the form.

Add files to the request (multipart request)

files
Selection of files that can be added to the request.

Advanced connection settings

HTTP Basic Authentication

Use HTTP Basic Authentication

Name: Username for the URL

Password: Password for the user

Use proxy server.

Forwarding to a proxy server

proxy-server hostname: Name of the proxy server

Port: Port of the proxy server. Default is 80{/code}}.
:; Proxy authentication: Authentication to the proxy server.
:: //Login//: Username for the proxy server
:: //password//: Password for the proxy user

=== Filing the created files ===

; Attach to operation
: If this option is checked, files created in this action will be attached to the operation. Otherwise, they are only available within the workflow for actions within the same processing chain.

== Action variables ==

Actions of type //Post request// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.

=== Standard action variables ===

; [%$<action name>.SUCCESS%]
: Return whether action was successfully executed. Returns Boolean (true/false).
; [%$<action name>.RESULT%]
: Return all results provided by the action in structured form.

; [%$<action name>.ERROR_CODE%]
: The error code thrown in case of an error in the action. Empty if no error occurred.
; [%$<action name>.ERROR_MESSAGE%]
: The thrown error message in the action's error case. Empty if no error occurred.

=== Action specific action variables ===

; [%$<action name>.RESULT.redirectUrl%]
: Contains the URL to the destination in case of a redirect.
; [%$<actionName>.RESULT.redirected%]
: Returns true if the HTTP word results in a redirect, false otherwise.
; [%$<actionName>.RESULT.responseBody%]
: Contains the response returned by the POST request that was triggered. In the case of a redirect, this value is empty.
; [%$<actionName>.RESULT.responseCode%]
: Contains the returned HTTP status code.
; [%$<actionName>.RESULT.responseJson%]
: Contains a JSON object or JSON array if the HTTP response is not a redirect and the content-type of the returned content is application/json
; [%$<actionName>.RESULT.responseReasonPhrase%]
: In case of a successful POST request, contains the status message, such as "OK" or "Found".
; [%$<ActionName>.RESULT.responseStatusLine%]
: In case of a successful POST request, contains the status message, such as "OK" or "Found".
; [%$<actionName>.ERROR.message%]
: Error message returned if the specified external URL resource does not match a valid format, the attached server cannot be reached or does not return a response, errors occurred while adding files to the post request, or the configured XSLT transformation failed.