REST

Properties

INPUT

Accept: This specifies the type / format of the web method to accept while processing the URL. Select the options from the drop-down,

1. None
2. JSON
3. XML
4. URLENCODED
5. PLAINTEXT
6. FORM-DATA

This field is auto filled by the REST wizard after saving. By default, if “None” is chosen, it will be considered as “JSON”.

ContentType:* This specifies the type/format of the input body request provided. Select the options from the drop-down,

1. None
2. JSON
3. XML
4. URLENCODED
5. PLAINTEXT
6. FORM-DATA

By default, if “None” is chosen, it will be considered as “JSON”.

DelayAfter: It assists the user to add a delay before initiating subsequent activities. The delay duration here is in milliseconds. By default, it is set to “1000” milliseconds. When the option is left blank, the delay will not be considered.

DelayBefore: It assists the user in adding a delay before starting the execution of the activities. The delay duration here is in milliseconds. By default, it is set to “1000” milliseconds. When the option is left blank, the delay will not be considered.

DownloadPath: Mention the path of the file where the resources need to be downloaded after calling the method. This is a not a mandatory field.

Encode: This specifies the encode format. Select the options from the drop-down,
1. NONE,
2. ASCII
3. DEFAULT
4. BigEndianUnicode
5. Unicode
6. UTF32
7. UTF7
8. UTF8.

GrantType: This field specifies the grant type/ domain of the URL. This is not a mandatory field

InputParameters: This specifies the inputs / parameters that is used to request in the URL. This is not a mandatory field.

Method:* This parameter specifies the method that is required when calling the API URL. The methods that are available are GET, POST, PUT, DELETE, PATCH, UPDATE, OPTIONS AND TRACE. This is a mandatory field.

Parameters: This specifies the parameters that enables to add a custom header to the URL. 

Password: This field specifies the password that is used to access the web page/ URL. 

RequestText:* This specifies body request needs to be included in the URL. This field supports strings and string variables, JSON, XML, URLENCODED AND PLAINTEXT.  This is a mandatory field.

ResTURL:* This specifies the URL that is used to communicate and get the service. This is a mandatory field.

ServiceAuthentication: This specifies the authentication type of the method.

Timeout: This parameter indicates the timeout value for establishing a connection to the provided URL. If the connection cannot be established within this specified time, it will throw an exception.

This parameter accepts values in “String” datatype. You can either enter the values hardcoded in “String” format or pass the values as “String” datatype.

UploadPath: Mention the path of the file that needs to be uploaded as a resource to the URL.

Username: This specifies the username that is used to access the webpage/ URL. 

MISC

Display Name: Displays the name of the activity. You can also customize the activity name to help troubleshoot issues faster. This name will be used for logging purposes.

SkipOnError: It specifies whether to continue executing the workflow even if it throws an error. This supports only Boolean value “True or False.”
True: Continues to execute the workflow irrespective of any error thrown.
False: Stops the workflow if it throws any error
Version: It specifies the version of the Web client automation feature in use.

OUTPUT

Response: ResponseRest: It helps to view the output of the activity as the response from the REST along with the status code of the URL in “Dataset” datatype.

Text: Declare a variable here to see the output of the soap activity in an output box. This is not a mandatory field.

*Represents mandatory field to execute the workflow.