REST Web Service command

Use the REST Web Service command to test REST Web services using the HTTP methods GET, POST, PUT, and DELETE.

Overview

Methods

GET Method
Retrieves information (in the form of an entity) as identified by the Request URI.
POST Method
Requests that the server accepts the entity enclosed in the request as a new subordinate of the web resource identified.
PUT Method
Updates a record by passing different URI parameters based on the Key-Value pair.
DELETE Method

Requests that the origin server deletes the identified resource.

Variable Support for REST Web Service using F2 Key
  • URL Parametrization: Users can add variables in the Request tab.
  • Parameter: Users can add variables for Parameter tab values which include URL Values, Post values and Authorization Values.

  1. Click Send Request to display the Set Variable From with values of the variables.
    Note: In Request Header or POST Parameter, if a Credential Variable is used, the Set Variable Value does not list the Credential Variable for Send Request. However its value is used to generate the output.

    A displayed message indicates that Credential Variable(s) are excluded from the list of variables. Read more about Assigning credential variables from credential lockers.

  2. Click Get Output to get the Response.
Note: If your REST Web Service is using a proxy server, go to Tools > Options > Advanced Settings.
Troubleshoot Send Request error

If the Send Request has errors after an upgrade to Enterprise Clientfrom v.11.3 or later, you might have to update the default REST Client type configured in the AASettings.xml file.

To troubleshoot, the REST Client type can be configured to use nativerestclient instead of default RestSharp in Player > commands node as shown:

<Player>

<commands>

<restwebservice>

<restclienttype>nativerestclient</restclienttype>

</restwebservice>

</commands>

</Player>