REST API Request

Description

This action component allows you to call REST API with a specific HTTP method.

Input Properties

• URL (String) – The URL to which you want to make the request.
• Body Format (Dropdown) – The format of the request body.
• Request Method (Dropdown) – The request method to be used when calling the API.
• Authentication Type (Dropdown) – Specifies the authentication type to be used when calling the API.
• Client Certificate (String) – Client certificate is needed to complete the API call.
• Client Certificate Password (String) – Client certificate password.
• Consumer Key (String) – The consumer key to be used if the API you are making requests to is based on the OAuth1 authentication method.
• Consumer Secret (String) – The consumer secret to be used if the API you are making requests to is based on the OAuth1 authentication method.
• OAuth1 Token (String) – The access token to be used if the API you are making requests to is based on the OAuth1 authentication method.
• OAuth1 Token Secret (String) – The secret to be used if the API you are making requests to is based on the OAuth1 authentication method.
• OAuth2 Token (String) – The access token to be used if the API you are making requests to is based on the OAuth2 authentication method.
• Username (String) – The Username to be used if the API you are making requests to is based on the Basic authentication method.
• Password (String) – The Password to be used if the API you are making requests to is based on the Basic authentication method.
• Headers (Dictionary>) – Allow you to include custom headers in the HTTP request.
• Query Parameters (Dictionary>) – The request query parameters.
• Cookies (Dictionary>) -The cookies in the HTTP Request.
• URL Segments (Dictionary>) – Custom segments added to the Endpoint URL.
• Attachments (Dictionary>) – List of attachments for the request.
• Request Body (String) -The body of the request.

Output Properties

• Result (RestResponse) – The response received from the HTTP request, as a RestResponse variable.
• Response Content (String) – The response received from the HTTP request, as a string variable.
• Response Status Code(Int) – The status code received from the HTTP request, as a int variable.
• Response Headers (OutArgument>) – The response received from the HTTP request.

General Properties

• GlobalWaits (Checkbox) – Apply global waits when PreWait or PostWait are not specified.
• IgnoreError (Checkbox) – Continue the process flow without throwing error.
• PostWait (Checkbox) – Apply specified wait after execute the action.
• PreWait (Checkbox) – Apply specified wait before execute the action.