WSBuiltInKeywords (com.kms.katalon.core.webservice)

com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords

Inherited fields
Fields inherited from class	Fields
`class com.kms.katalon.core.keyword.BuiltinKeywords`	`__$stMC`

Methods Summary

Methods
Type	Name and description
`static boolean`	`containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex, com.kms.katalon.core.model.FailureHandling flowControl)` Verify that an expected text appear in the returned data from a web service call
`static boolean`	`containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex)` Verify that an expected text appear in the returned data from a web service call
`static com.kms.katalon.core.testobject.ResponseObject`	`sendRequest(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)` Send a HTTP Request to web server
`static com.kms.katalon.core.testobject.ResponseObject`	`sendRequest(com.kms.katalon.core.testobject.RequestObject request)` Send a HTTP Request to web server
`static com.kms.katalon.core.testobject.ResponseObject`	`sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)` Send a HTTP Request to web server and verify the response
`static com.kms.katalon.core.testobject.ResponseObject`	`sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request)` Send a HTTP Request to web server and verify the response
`static boolean`	`verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value, com.kms.katalon.core.model.FailureHandling flowControl)` Verify that there is an element with expected property value appear in the returned data from a web service call
`static boolean`	`verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value)` Verify that there is an element with expected property value appear in the returned data from a web service call
`static boolean`	`verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text, com.kms.katalon.core.model.FailureHandling flowControl)` Verify that there is an element with expected text appear in the returned data from a web service call
`static boolean`	`verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text)` Verify that there is an element with expected text appear in the returned data from a web service call
`static boolean`	`verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count, com.kms.katalon.core.model.FailureHandling flowControl)` Verify number of expected elements (JSON/XML) in the response (output) of a web service call
`static boolean`	`verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count)` Verify number of expected elements (JSON/XML) in the response (output) of a web service call
`static boolean`	`verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode, com.kms.katalon.core.model.FailureHandling flowControl)` Verify status code in the returned data from a web service call
`static boolean`	`verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode)` Verify status code in the returned data from a web service call
`static boolean`	`verifyResponseStatusCodeInRange(com.kms.katalon.core.testobject.ResponseObject responseObject, int fromStatusCode, int toStatusCode, com.kms.katalon.core.model.FailureHandling flowControl)` Verify status code valid in a range of status codes in the returned data from a web service call
`static boolean`	`verifyResponseStatusCodeInRange(com.kms.katalon.core.testobject.ResponseObject responseObject, int fromStatusCode, int toStatusCode)` Verify status code valid in a range of status codes in the returned data from a web service call

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class com.kms.katalon.core.keyword.BuiltinKeywords`	com.kms.katalon.core.keyword.BuiltinKeywords#setProperty(java.lang.String, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#getProperty(java.lang.String), com.kms.katalon.core.keyword.BuiltinKeywords#concatenate([Ljava.lang.String;), com.kms.katalon.core.keyword.BuiltinKeywords#concatenate([Ljava.lang.String;, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#comment(java.lang.String), com.kms.katalon.core.keyword.BuiltinKeywords#delay(java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#delay(java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#invokeMethod(java.lang.String, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#getMetaClass(), com.kms.katalon.core.keyword.BuiltinKeywords#setMetaClass(groovy.lang.MetaClass), com.kms.katalon.core.keyword.BuiltinKeywords#verifyMatch(java.lang.String, java.lang.String, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyMatch(java.lang.String, java.lang.String, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotMatch(java.lang.String, java.lang.String, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotMatch(java.lang.String, java.lang.String, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#verifyEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThan(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThan(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThanOrEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThanOrEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThan(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThan(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThanOrEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThanOrEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#callTestCase(com.kms.katalon.core.testcase.TestCase, java.util.Map, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#callTestCase(com.kms.katalon.core.testcase.TestCase, java.util.Map), com.kms.katalon.core.keyword.BuiltinKeywords#verifyCheckpoint(com.kms.katalon.core.checkpoint.Checkpoint, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyCheckpoint(com.kms.katalon.core.checkpoint.Checkpoint, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#wait(long, int), com.kms.katalon.core.keyword.BuiltinKeywords#wait(long), com.kms.katalon.core.keyword.BuiltinKeywords#wait(), com.kms.katalon.core.keyword.BuiltinKeywords#equals(java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#toString(), com.kms.katalon.core.keyword.BuiltinKeywords#hashCode(), com.kms.katalon.core.keyword.BuiltinKeywords#getClass(), com.kms.katalon.core.keyword.BuiltinKeywords#notify(), com.kms.katalon.core.keyword.BuiltinKeywords#notifyAll()
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify that an expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if your text is found, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    string - the text you want to look for
    useRegex - use regular expression or not
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex)
    
    Verify that an expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if your text is found, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    string - the text you want to look for
    useRegex - use regular expression or not
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequest(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Send a HTTP Request to web server
    Returns:
    @throws Exception
    Parameters:
    request - the object represents for a HTTP Request, user need to define it from Object Repository->New->Web Service Request, and get it by ObjectRepository.findRequestObject("requestObjectId")
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequest(com.kms.katalon.core.testobject.RequestObject request)
    
    Send a HTTP Request to web server
    Returns:
    @throws Exception
    Parameters:
    request - the object represents for a HTTP Request, user need to define it from Object Repository->New->Web Service Request, and get it by ObjectRepository.findRequestObject("requestObjectId")
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Send a HTTP Request to web server and verify the response
    Returns:
    @throws Exception
    Parameters:
    request - the object represents for a HTTP Request, user need to define it from Object Repository->New->Web Service Request, and get it by ObjectRepository.findRequestObject("requestObjectId")
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request)
    
    Send a HTTP Request to web server and verify the response
    Returns:
    @throws Exception
    Parameters:
    request - the object represents for a HTTP Request, user need to define it from Object Repository->New->Web Service Request, and get it by ObjectRepository.findRequestObject("requestObjectId")
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify that there is an element with expected property value appear in the returned data from a web service call
    throws:
    StepErrorException
    
    Returns:
    true if your expectation is met, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    value - the expected value of element you want to verify in the responded data (usually is JSON/XML)
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value)
    
    Verify that there is an element with expected property value appear in the returned data from a web service call
    throws:
    StepErrorException
    
    Returns:
    true if your expectation is met, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    value - the expected value of element you want to verify in the responded data (usually is JSON/XML)
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify that there is an element with expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    throws:
    StepErrorException
    
    Returns:
    true if your element text is found, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    text - the expected text of element you want to verify in the responded data (usually is JSON/XML)
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text)
    
    Verify that there is an element with expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    throws:
    StepErrorException
    
    Returns:
    true if your element text is found, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    text - the expected text of element you want to verify in the responded data (usually is JSON/XML)
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    Exception
    
    Returns:
    true if your expectation is met, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    count - the expected number of element(s) should appear in the responded data (usually is JSON/XML)
    flowControl
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count)
    
    Verify number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    Exception
    
    Returns:
    true if your expectation is met, otherwise false
    Parameters:
    response - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    locator - an expression Katalon will use to go through and look for expected element(s), please refer to our user guide for how to write it
    count - the expected number of element(s) should appear in the responded data (usually is JSON/XML)
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify status code in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if the response status code is the same as the expected status code, otherwise false
    Parameters:
    responseObject - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    expectedStatusCode - the expected status code
    flowControl - FailureHandling
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode)
    
    Verify status code in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if the response status code is the same as the expected status code, otherwise false
    Parameters:
    responseObject - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    expectedStatusCode - the expected status code
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(com.kms.katalon.core.testobject.ResponseObject responseObject, int fromStatusCode, int toStatusCode, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Verify status code valid in a range of status codes in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false
    Parameters:
    responseObject - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    fromStatusCode - from status code
    toStatusCode - to status code
    flowControl - FailureHandling
  - @CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(com.kms.katalon.core.testobject.ResponseObject responseObject, int fromStatusCode, int toStatusCode)
    
    Verify status code valid in a range of status codes in the returned data from a web service call
    throws:
    StepFailedException
    
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false
    Parameters:
    responseObject - the object represents for a HTTP Response, user can get responded content type, data, header properties (sometimes user may want to get cookie from response header)
    fromStatusCode - from status code
    toStatusCode - to status code

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class WSBuiltInKeywords

Methods Summary

Inherited Methods Summary

Method Detail

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(com.kms.katalon.core.testobject.ResponseObject response, String string, boolean useRegex)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequest(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequest(com.kms.katalon.core.testobject.RequestObject request)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_REQUEST) static com.kms.katalon.core.testobject.ResponseObject sendRequestAndVerify(com.kms.katalon.core.testobject.RequestObject request)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(com.kms.katalon.core.testobject.ResponseObject response, String locator, Object value)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(com.kms.katalon.core.testobject.ResponseObject response, String locator, String text)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(com.kms.katalon.core.testobject.ResponseObject response, String locator, int count)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode, com.kms.katalon.core.model.FailureHandling flowControl)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(com.kms.katalon.core.testobject.ResponseObject responseObject, int expectedStatusCode)

@CompileStatic @com.kms.katalon.core.annotation.Keyword(keywordObject = StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(com.kms.katalon.core.testobject.ResponseObject responseObject, int fromStatusCode, int toStatusCode)