What can we help you with?
What is Response?
- A response is a message that the server receives in return for a Request which you send.
- When you send the request, the server accepts that request and sends back a packet of the requested information, which is called the response.
- After sending the request, API sends back the response for the requested information.
Why do we need Response?
- Helps the user to understand the information that you have requested in a better way.
- To perform some action in other features by making use of response.
- When the user sends a request, the response is generated in the response section.
- Response status code is displayed on the right-hand side of this section which indicates the status of the request
- Time taken to respond to the sent request is displayed in milliseconds next to the status, with the label as Time.
- When the user collapses this section “Response” text is provided.
- When it is expanded, it will display the following tabs- i) Response Body, ii) Response Header, and iii) Assert Results.
1. Response Body
What is a Response Body?
- Response body is the place where the user gets the information for which you have requested.
- In the response body, it consists of the body in the format which the user has requested. By default, it will be in the String form.
- There are three options under the response body tab. The user can select the format in which they want to see the response body. The options are explained below.
- JSON/XML: This option is a dynamic option, which will vary based on the request body sent by the user. i.e. If the user has sent the request in JSON language, there will be a JSON option in the response body. And, if the user has sent the request in XML language, it will be an XML option in the response body.
- Text: When the user selects this option, all the responses present in the Response Body tab are changed to Text.
- HTML: When the user selects this option, all the response present in the Response Body tab is changed to HTML code.
- Copy to Clipboard icon is provided in the top right-side corner of the Response Body tab. Upon clicking on which, all the responses present in the Response Body tab should get copied to the clipboard.
- The Save Response icon is provided beside the Copy to Clipboard icon and it is disabled by default. To enable it, the user needs to select any one of the options. Upon clicking on it, the response is downloaded in the selected tab format. The downloaded file name will be in the format of <<Request Name>>. <<option selected>>.
2. Response Header
What is a Response Header?
- Response Header contains the response for all the headers sent in Request Headers.
- It will auto-populate the response in the table form for all the headers that are sent in the Request Header
- Response for the headers is displayed in the table form that has key and value columns.
3. Assert Results
What is Assert Results?
- It contains the response for the assert script which you send in the Assert tab.
- It provides the results, whether assert scripts are passed or failed.
- IIt contains four sub-tabs where the All tab is selected by default.
- All tabs will display all the assert script results, irrespective of whether it is pass or fail.
- Passed tab displays only the passed assert script results.
- Failed tab displays only the failed assert script results.
- Skipped tab displays only the skipped assert script results.
Note: Overall Assert Results status will be displayed beside the “Rest API” header which includes both custom assert and default assert. Always highest priority is for Failed status after Skipped and the last is for Passed status.
- How to update the web service step?
- Once after adding a web service request as a step, the user can also edit that step by clicking on the particular step which he wants to edit.
- After clicking on the particular step, the user will be navigated to the web service page, and all the data which the user has provided while creating a step will be prefilled in the respective tab.
- Once after making changes to the web service page, the user needs to click on the send button and once the user gets the proper response he can click on the “Update Step” button.
- A popup will be displayed with the header as “Update API Request as Step” where all the data will be prefilled.
- Once the user clicks on the Update button, the popup will get closed and the user will be navigated back to the steps tab and the step will be updated.