Skip to main content

[WS] Get Elements Count


getElementsCount(ResponseObject response, String locator, FailureHandling flowControl)

Get the number of characters of the expected elements in the (JSON/XML) response of a web service call.


ParametersParameter typeMandatory Description

The object that represents an HTTP response.

locatorString RequiredThe element locator that Katalon uses to look for the expected data. To learn more about element locators, you can refer to this document:

Handle Response messages.

flowControlFailure handling OptionalSpecify failure handling schema to determine whether the execution should be allowed to continue or stop. To learn more about failure handling settings, you can refer to this document:

Failure handling.


The number of characters of the expected elements.


Given the following response from a sample POST a new user POST request:

We want to count the number of characters of the password element in the response after sending the request. We use the WS.getElementsCount keyword as follows:

import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import static com.kms.katalon.core.testobject.ObjectRepository.findWindowsObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.cucumber.keyword.CucumberBuiltinKeywords as CucumberKW
import as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testng.keyword.TestNGBuiltinKeywords as TestNGKW
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import as Windows
import internal.GlobalVariable as GlobalVariable
import org.openqa.selenium.Keys as Keys

'Send a POST request and returns its response'
def response = WS.sendRequest(findTestObject('POST a new user'))

'Get the number of characters of the selected element in the response'
elementsCount = WS.getElementsCount(response, 'password')