Page Comparison

hostName

This parameter contains the URL of the requested server.

Host name (URL)

method

post

This parameter determines which method will be remotely invoked. Post means that the server expects an input in XML-Format that it will process and return. Get means that the Server will send data without requiring input.

delete

get

head

options

patch

post

put

templatePath

This parameter contains the file path to a JSON file that contains the input for the server.

Path to template

getParameter

This parameter contains the input for the server in JSON-Format.

httpBody

Contains the input for the server in JSON-Format.

responseVariable

This parameter contains the process variable into which the server response should be saved.

user

This parameter is only required if the server requires identification and contains the user name of the user.

pass

This parameter is only needed if the server requires an identification and contains the user's password.

authMethod

This parameter is only needed if the server requires identification and contains the encryption which should be applied. One possible encryption is base64, which will be applied by setting this parameter to “basic” basic.

oauth

basic

oAuthGrantTypeAccess

oAuthGrantTypeRefresh

oAuthClientId

oAuthClientSecret

oAuthTokenUrl

oauth_client_id

oauth_client_secret

Required only

URL from where to retrieve the oauth token from.

oAuthTokenBasicAuth

false

oauth_token_url)

oAuthTokenUrl

Required only if authMethod = "oauth"

Secifies the URL from where to retrieve the OAuth token from.

oAuthTokenBasicAuth

false

additionalFields

adding additonal fields to the Rest 

additionalHeaders

adding additonal Headers to the Rest 

call"&method=GET&additionalHeaders=[NAME_OF_VARIABLE=" + variable + ";" + "NAME_OF_VARIABLE2=" + variable2 + "]"

searchByJsonPath

null

Here, the Json path for a specific part of the returned Json file and a variable name under which the specific part of the Json should be saved, are entered. The variable(s) are then saved in an array named 'result'. For better understanding see examples.

[{path: "[*]", resultVariable: "variable_name"}]

contentType

Specifies the content type of the request.

newLineReplacement

Replaces all "\n" with the given value, unless "false" is provided as a value.

urlEncoding

true

If enabled, converts the URL to a US-ASCII string. In addition square brackets will be ascaped with their respective ASCII values.

contentEncodingTest

false

convertBodyToJson

false

Converts query parameters to JSON string.

addNote

false

If enabled, stores the response as a note and attaches it to the current process instance.

addAllDocuments

false

If enabled, creates a mulitpart request containing all attached documents.
Only relevant for PUT requests.

addLocalDocument

Adds a local file by the given path.

logResponse

If enabled, the response gets logged out in the server log.

logRequest

true

If enabled, the request gets logged out in the server log.

faultTolerance

1

This parameter can be specified as either 0 or 1. It only makes a difference if an exception is thrown. If an exception is thrown, the process is stopped if the parameter is set to 0 and if it is set to 1 the exception message is saved in the responseVariable and the process can continue as usual.

0

1

onErrorRepetition

0

Repeat execution if there is a faulty request (if its an IOException (like 403, 401))

isRestCallButton

false

This parameter is used when you want to call the rest handler from a TSD button .