Scriptworks Logo

REST POST Request 400

17th May 2021 | API Testing Tutorials

banner resources

This tutorial covers the HTTP method POST, requests made to a REST API to create resources at the Wrong URI, and validation of the response through Scriptworks.

Introduction

In this article, we will perform an API Request which generates a response code 400 and will validate it through Scriptworks - A Visual Programming/low Code Automation tool.

First, I will demonstrate the exercise we need to perform, followed by practically demonstrating the automation through the Drag and Drop of relevant Scriptworks Blocks for achieving it.

HTTP Status Code Discussed in this Article:- 

400:- HTTP Status code 400 belongs to the Client Error Codes Category, it states that the Server didn’t understand the request due to something that has happened as a client error (e.g., malformed syntax request, invalid request message, or deceptive request routing).

Note – Here, We are using https://reqres.in/ to practice the REST API’s query and response validation.

Exercise:-

 

1) Open your preferred browser chrome, firefox, etc. 

Navigate to any browser

2) Navigate to https://reqres.in/

3) Perform Post Request and validate the response code 400. 

Reqres_400 in reqres.in

Practical Demonstration

Now following are the Steps to Perform the above Exercise, including validation, using Visual Programming/Low code approach in the ‘Scriptworks’ IDE:-

Pre-requisite: Users should be able to login to Scriptworks via their Credentials, and the Scriptworks Client should be up and running. 

To know more about the Scriptworks Client and Selenium Standalone Server, please follow this Article.

1) Open Scriptworks on your system with your credentials and open the project where you want to create the REST API Request and Automated validations on the API response.

Open Project MyTest

2) Now click on the Block symbol present on the left side panel and then click on getting started 

BlockSymbol → Getting Started → API Test

As we know, we are going to initiate an API test. Drag and Drop “API Test” onto the Canvas After clicking on the Getting Started link.

Getting Started link should be clicked

API Test to Get Started

Putting API Test Block into the Canvas

3) Now, we will use the comment block to let others know what we are performing. For that, we are going to click on the search text box and write comment and hit return.

Search → Comment → Drag and Drop to Canvas

put your cursor in search box

Put Comment Block into the Canvas

Commenting to show what we gonna perform

4) Now, we will drag and drop some basic blocks required for a REST API request. 

For the REST API Request, we need four basic things from Scriptworks.

i) REST Call Block

ii) Method Block

iii) URI Block

iv) Response Block 

We have searched the comment block in step 3 similarly we have to do for required blocks and drag and drop them to the canvas.

  1. Search → REST Call → Drag and Drop to Canvas
  2. Search → Method → Drag and Drop to Canvas
  3. Search → URI → Drag and Drop to Canvas
  4. Search → Body → Drag and Drop to Canvas
  5. Search → get Response → Drag and Drop to Canvas

Demonstrating Drag and Drop of REST call Block to Canvas

Search for Rest Block from Left Hand Side of Panel

Rest Call Block inside the canvas

Demonstrating Drag and Drop of Method Block into Canvas

Method Block inside the canvas

By default, we would have GET as the HTTP method. Change it to POST by clicking the drop-down present in the method block.

Select POST Method from the Dropdown

POST Method inside the Canvas

Demonstrating Drag and Drop of URI Block into Canvas

Search URI Block from Left Side Panel

In URI Block Enter https://reqres.in/api/register

Putting URI Block Inside the Canvas

Demonstrating Drag and Drop of Add Body Block into Canvas

Search Add Body Block from Left Hand Side Panel

Now enter the Payload inside the add body block.

Putting AddBody Block inside the Canvas

OR

It’s not that you have to enter your payload linearly always. Scriptworks provide you the outstanding feature of adding a multiline block that can be expanded to your query level. Let’s see that as well.

Click on Block symbol → Click on Input Values Link → Choose Multiline block → Drag and drop to Canvas

Looking forward to add Multiline Block from left hand side panel

Filling up Body in Multiline Block

Demonstrating Drag and Drop of get response Block into Canvas

Search for get response block from the left hand side panel

Putting Get Response Block Inside the Canvas

5) Let’s give it a dry run and see what we are receiving in response after the run.

Request Details with Response Headers

In the above screenshot, we can see what request we have sent to the REST API query with the kind of request headers that have been passed.

In the above screenshot, we can observe how well scriptworks is capturing REST API response.

6) Drag comment to let others know what we are going to do now. And for that, follow Step 3 Above.

Search → Comment → Drag and Drop to Canvas
Pull Validate Response Comments from Left hand side panel

7) Now, to validate the response, or we can say in technical terms, i.e. to Assert the API response received to Scriptworks. Drag the Assert block multiple times for the number of Assertions you want on to the Canvas, and fill it with information you wish to assert from the REST API response.

Search → Assert → Drag and Drop to Canvas

Search Assert from Search Box present on left side panel

We have added the Assert Block. Now, what do we have to Assert?

We have to Assert the status code and message from the API Response. To get these properties of the Response we use the a response properties block. So search for response in the search box and pick the response properties block and drag it into the canvas.

Search → Response → Drag and Drop Response Body into Canvas

Search Response from left hand side panel

select status message from dropdown

Putting final body inside the canvas

8) Now, the final thing is a Test Run. Make sure you have followed the prerequisite mentioned above before the Test Run. Make sure you can see Green Symbol before clicking on the play icon.

highlight play icon and status client icon

Test should be pass . phew....

That’s how we can validate a REST API with the response code and status message in Scriptworks.

 

 

 

 

 

 

 

 

 

Other resources you might be interested in...

Scriptworks logo
© Copyright 2021 | Scriptworks is part of Odin Technology Ltd, a company registered in England no. 03735083