REST plugin use cases

This section describes common use cases for the REST plugin and provides example requests and responses.

GET request with no authentication

A common use for the REST plugin is to create GET requests that retrieve information from RESTful web services without providing authentication. After you enter the required information and run the step, the plugin:

Creates the request and sends it to the server.
Waits for the success or failure response.
Writes the response using the specified method.

The following is an example runRest procedure GET request configuration for this type of use case:

Figure 1. runRest GET example configuration

The following is an example of the server response for the previous request:

Figure 2. runRest GET example server response

POST request with basic authentication

A common use for the REST plugin is to create POST requests that retrieve or change information on your server where authentication is required. After you enter the required information and run the step, the plugin:

Creates the request and sends it to the server.
Waits for the success or failure response.
Writes the response using the specified method.

The following is an example runRest procedure POST request configuration for this type of use case:

Figure 3. runRest POST example configuration

The following is an example of the server response for the previous request:

Figure 4. runRest POST example server response