QATTS Technical Docs
2.0.0 Main
2.0.0 Main
  • QATTS Product Documentation
  • Getting Started
    • About QATTS
      • A Quick Tour of QATTS
      • Terminology
      • Relationship
    • Dashboard
  • Getting to know
  • Administration
    • Product
      • How to Add Product
      • Configure Test Data Repository
    • Code Branch
      • How to Add Code Branch
    • Feature
    • Client
      • How to Add Client
    • Deployment
      • How to Add Deployment
      • Database Config
      • Email Config
    • Node
      • Streaming Configuration
      • How to register node for streaming
      • Status And Actions
    • Agent
    • User
    • Role
  • Studio
    • UI Elements
      • text_box
        • Properties Library
        • Trouble Shoot
      • loader
        • Trouble Shoot
      • date
      • button
      • drop_down
        • Trouble Shoot
        • Properties Library
      • label
      • check_box
      • radio_button
      • link
      • Shadow
      • Trouble Shoot
      • Properties Library
      • Pre and Post Actions
      • table
        • Example
        • Trouble Shoot
      • form
      • toogle_button
      • file
      • alert
  • Automation
    • Objects
      • UI Element
        • Drop Down
        • Radio Button
        • Multi Elements
        • table
        • form
      • Product Element
        • Advanced Data Types
          • QIntegerArray
          • QStringArray
          • QArray
          • QData
        • Basic Data Types
      • API
      • Query
      • Smarty
        • Excel: Read data from excel
        • File: Reads file Data
        • EmailRead
        • EmailSend
        • SiteScan
        • PDF Utils
      • New Group
    • Test Case
    • Function
    • Data Table
  • Execution
    • Test Case
      • Clients Summary
      • Search and Manage
      • Context Parameters
      • Details by Functionality
        • Sync
    • Test Suite
      • Create Suite
    • Test Run
      • Schedule Test Run
      • Untitled
    • Test Result
      • Results by Clients
      • Results by Fuctionality
    • Build No
    • Reports
      • All Failed Test Cases
      • Recently Failed Test Cases
  • Others
    • Milestone
  • Settings
    • Builds
    • Milestone
  • Site Scan
  • Using QATTS
    • Guide to API Automation
      • Adding API
      • Request
      • Response
        • Writing Response Schema
    • Guide to Web Automation
      • Performing Web Automation
    • Guide to setup agent-service
  • Advanced Data Types
    • QData
  • Methods
  • Standard Actions Methods
    • Execute Methods
  • UI Action Methods
    • extractGroup
  • File Action Methods
  • UI Element Advanced
  • UI Checks
  • Extraction Rules
  • Assertion Operations
  • Error Codes : Automation
  • Error Code: Execution
  • JSpreadSheetUtil Methods
  • Functions
    • Primitive
      • CONCATENATE
    • Date & Time
    • Text
  • Other Information
    • FAQ
    • Troubleshooting
      • UI Methods
Powered by GitBook
On this page

Was this helpful?

  1. Using QATTS
  2. Guide to API Automation
  3. Response

Writing Response Schema

Your guide to knowing how to write a response schema

PreviousResponseNextGuide to Web Automation

Last updated 2 years ago

Was this helpful?

The Following is the process to Write a Response Schema

First Click on the 3 dotted icon and click on the NEW.

Give Name and Match String as per the requirement.

  • Name - Here we give the name that is related to response body.

  • Match String - Here we give the any Key parameter of the response body which should be as it is in the response body.

Click on the three dots and Select the Name value that you have given and save the data.

The lower sections it derived in five elements Response Field value, DataType , Assert Operation, Assert Data and Product Element(optional).

Response Field Value - This is to map the Key parameter in the Response Body, in other words here we are locating the element in the response body so that we can check that if it is equal to the input element that we have given in the request template.

Data Type - This depends on the value parameter i.e. if it is an numerical value we use Integer, if it is Alphabets we use String as data type, if it is true or false then we use Boolean as Data Type.

Assertion Operation- Here we give the operator based on the requirement such =, >=,<,> for the Integer data type, and for string data type we use equals, Stringlength= e.t.c.

Assert Data- There are two ways to Assert the data.

  • By Parameterized Product Element - Here we give ${Productelement} in this format which was parameterized in the request which helps to check the data from the response is equal to the request that had given from the default param.

  • By Giving Raw Data - Here the expected data will be given. for example if we take statusCode in API Header we expect the outcome as 200, so we can type 200 as the outcome.

Product Element - This is for filtering the data in the output that needed. For example, in the response it has 40 lines of data but if checked only 2-3 lines of data shown, by giving product element of selected data it can acquire required data output.