B REST Component Keywords

This chapter provides the following REST component keywords:

RS-SETREQUESTHEADER

Sets the header in the defined REST request.

Use case: The attribute value takes the name of the request header.

Usage Details Value

Keyword

RS-SETREQUESTHEADER

Display Name

User Defined Display Name

Attribute Values

User Defined Header Name

Objects Valid

No objects required

RS-SETENDPOINT

Sets the endpoint for the REST request.

Use Case: Defines the static part of the application's REST endpoint.

Usage Details Value

Keyword

RS-SETENDPOINT

Display Name

User Defined Display Name

Attribute Values

User Defined End Point

Objects Valid

No objects required

RS-ARGUMENT

Sets the query parameter or the path parameter for the REST request.

Use Case: Used for setting the query parameter and path variable in the REST request. The values are provided from the test data.

Usage Details Value

Keyword

RS-ARGUMENT

Display Name

User Defined Display Name

Attribute Values

User Defined Query Parameter Name for QueryParameter

None for PathVariable

Objects Valid

QueryParameter - Appends the query parameter name in the component definition and value given in the test data to the REST end point.

PathVariable - Appends the user defined value in test data to the REST end point.

RS-SETMETHOD

Sets the method type for the REST request.

Use Case: Used to set the REST request method type.

Usage Details Value

Keyword

RS-SETMETHOD

Display Name

User Defined Display Name

Attribute Values

None

Objects Valid

GET - Creates a GET method to hit the REST end point.

POST - Creates a POST method to hit the REST end point.

RS-PROCESSRESTREQUEST

Sends the REST request and receives the response from the application for the specified REST.

Use Case: Used to send the REST request using the methods and data provided using the above keywords.

Usage Details Value

Keyword

RS-PROCESSRESTREQUEST

Display Name

User Defined Display Name

Attribute Values

None

Objects Valid

No objects required