Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: update absolute page links

...

Parameter name

Default value

Description

Valid examples

hostName

This parameter contains the URL of the requested server.

method

post

This parameter determines which method will be remotely invoked. “Post” means that the server expects an input in XML-Format which he will process and return. “Get” on the other hand means that the Server will send data without requiring an 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.

postParameter

This parameter 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”.

oauth

basic

oAuthTokenUrl

Required only if authMethod = "oauth"

URL from where to retrieve the oauth token from.

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"}]

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

...