WSBuiltInKeywords (Katalon Studio API Specification)

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

@CompileStatic
class WSBuiltInKeywords
extends BuiltinKeywords

Constructor Summary

Constructors
Constructor and description
`WSBuiltInKeywords ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static boolean`	`containsString(ResponseObject response, String string, boolean useRegex, FailureHandling flowControl)` Verify that an expected text appear in the returned data from a web service call
	`static boolean`	`containsString(ResponseObject response, String string, boolean useRegex)` Verify that an expected text appear in the returned data from a web service call
	`static Object`	`getElementPropertyValue(ResponseObject response, String locator, FailureHandling flowControl)` Get property value of an element (defined by a locator) in the returned data from a web service call
	`static Object`	`getElementPropertyValue(ResponseObject response, String locator)` Get property value of an element (defined by a locator) in the returned data from a web service call
	`static String`	`getElementText(ResponseObject response, String locator, FailureHandling flowControl)` Get text of the element (defined by a locator) which appears in the returned data from a web service call
	`static String`	`getElementText(ResponseObject response, String locator)` Get text of the element (defined by a locator) which appears in the returned data from a web service call
	`static int`	`getElementsCount(ResponseObject response, String locator, FailureHandling flowControl)` Get the number of expected elements (JSON/XML) in the response (output) of a web service call
	`static int`	`getElementsCount(ResponseObject response, String locator)` Get the number of expected elements (JSON/XML) in the response (output) of a web service call
	`static boolean`	`getHarFileGeneration()` Checks HAR file generation option is enabled or not.
	`static boolean`	`getHarFileGeneration(FailureHandling flowControl)` Checks HAR file generation option is enabled or not.
	`static int`	`getResponseStatusCode(ResponseObject responseObject, FailureHandling flowControl)` Get status code in the returned data from a web service call
	`static int`	`getResponseStatusCode(ResponseObject responseObject)` Get status code in the returned data from a web service call
	`static ResponseObject`	`sendRequest(RequestObject request, FailureHandling flowControl)` Send a HTTP Request to web server
	`static ResponseObject`	`sendRequest(RequestObject request)` Send a HTTP Request to web server
	`static ResponseObject`	`sendRequestAndVerify(RequestObject request, FailureHandling flowControl)` Send a HTTP Request to web server and verify the response
	`static ResponseObject`	`sendRequestAndVerify(RequestObject request)` Send a HTTP Request to web server and verify the response
	`static void`	`setHarFileGeneration(boolean enable)` Katalon Studio will generate HAR file for each Web Service request by default.
	`static void`	`setHarFileGeneration(boolean enable, FailureHandling flowControl)` Katalon Studio will generate HAR file for each Web Service request by default.
	`static boolean`	`validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema, FailureHandling flowControl)` Validate a GraphQL request body against a GraphQL schema
	`static boolean`	`validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema)` Validate a GraphQL request body against a GraphQL schema
	`static boolean`	`validateJsonAgainstSchema(String jsonObject, String jsonSchema, FailureHandling flowControl)` Validate a JSON object against a JSON schema
	`static boolean`	`validateJsonAgainstSchema(String jsonObject, String jsonSchema)` Validate a JSON object against a JSON schema
	`static boolean`	`validateJsonAgainstSchema(ResponseObject response, String jsonSchema)` Validate a response against a JSON schema
	`static boolean`	`validateJsonAgainstSchema(ResponseObject response, String jsonSchema, FailureHandling flowControl)` Validate a response against a JSON schema
	`static boolean`	`validateOpenAPIAgainstSpecification(RequestObject request, String specSrc)` Validate an OpenAPI/Swagger request against an OpenAPI/Swagger specification
	`static boolean`	`validateOpenAPIAgainstSpecification(RequestObject request, String specSrc, FailureHandling flowControl)` Validate an OpenAPI/Swagger request against an OpenAPI/Swagger specification
	`static boolean`	`validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc)` Validate an OpenAPI/Swagger response against an OpenAPI/Swagger specification
	`static boolean`	`validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc, FailureHandling flowControl)` Validate an OpenAPI/Swagger response against an OpenAPI/Swagger specification
	`static boolean`	`validateXmlAgainstSchema(String xmlObject, String xmlSchema, FailureHandling flowControl)` Validate an XML object against an XML schema
	`static boolean`	`validateXmlAgainstSchema(String xmlObject, String xmlSchema)` Validate an XML object against an XML schema
	`static boolean`	`validateXmlAgainstSchema(ResponseObject response, String xmlSchema)` Validate a response against an XML schema
	`static boolean`	`validateXmlAgainstSchema(ResponseObject response, String xmlSchema, FailureHandling flowControl)` Validate a response against an XML schema
	`static boolean`	`verifyElementPropertyValue(ResponseObject response, String locator, Object value, 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(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(ResponseObject response, String locator, String text, FailureHandling flowControl)` Verify that there is an element with expected text appear in the returned data from a web service call
	`static boolean`	`verifyElementText(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(ResponseObject response, String locator, int count, FailureHandling flowControl)` Verify number of expected elements (JSON/XML) in the response (output) of a web service call
	`static boolean`	`verifyElementsCount(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(ResponseObject responseObject, int expectedStatusCode, FailureHandling flowControl)` Verify status code in the returned data from a web service call
	`static boolean`	`verifyResponseStatusCode(ResponseObject responseObject, int expectedStatusCode)` Verify status code in the returned data from a web service call
	`static boolean`	`verifyResponseStatusCodeInRange(ResponseObject responseObject, int fromStatusCode, int toStatusCode, FailureHandling flowControl)` Verify status code valid in a range of status codes in the returned data from a web service call
	`static boolean`	`verifyResponseStatusCodeInRange(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 BuiltinKeywords`	`callTestCase, callTestCase, comment, concatenate, concatenate, delay, delay, verifyCheckpoint, verifyCheckpoint, verifyEqual, verifyEqual, verifyGreaterThan, verifyGreaterThan, verifyGreaterThanOrEqual, verifyGreaterThanOrEqual, verifyLessThan, verifyLessThan, verifyLessThanOrEqual, verifyLessThanOrEqual, verifyMatch, verifyMatch, verifyNotEqual, verifyNotEqual, verifyNotMatch, verifyNotMatch`

- Constructor Detail
  - WSBuiltInKeywords()
- Method Detail
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(ResponseObject response, String string, boolean useRegex, FailureHandling flowControl)
    
    Verify that an expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    
    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
    Returns:
    true if your text is found, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(ResponseObject response, String string, boolean useRegex)
    
    Verify that an expected text appear in the returned data from a web service call
    throws:
    StepFailedException
    
    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
    Returns:
    true if your text is found, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static Object getElementPropertyValue(ResponseObject response, String locator, FailureHandling flowControl)
    
    Get property value of an element (defined by a locator) in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    flowControl
    Returns:
    property value of the expected element
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static Object getElementPropertyValue(ResponseObject response, String locator)
    
    Get property value of an element (defined by a locator) in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    Returns:
    property value of the expected element
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static String getElementText(ResponseObject response, String locator, FailureHandling flowControl)
    
    Get text of the element (defined by a locator) which appears in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    flowControl
    Returns:
    text of the expected element
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static String getElementText(ResponseObject response, String locator)
    
    Get text of the element (defined by a locator) which appears in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    Returns:
    text of the expected element
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getElementsCount(ResponseObject response, String locator, FailureHandling flowControl)
    
    Get the number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    flowControl
    Returns:
    the number of expected elements
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getElementsCount(ResponseObject response, String locator)
    
    Get the number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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
    Returns:
    the number of expected elements
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean getHarFileGeneration()
    
    Checks HAR file generation option is enabled or not.
    throws:
    StepFailedException If Katalon Studio could not get the setting
    
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false
    Since:
    8.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean getHarFileGeneration(FailureHandling flowControl)
    
    Checks HAR file generation option is enabled or not.
    throws:
    StepFailedException If Katalon Studio could not get the setting
    
    Parameters:
    flowControl - FailureHandling
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false
    Since:
    8.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getResponseStatusCode(ResponseObject responseObject, FailureHandling flowControl)
    
    Get status code in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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)
    flowControl
    Returns:
    the response status code
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getResponseStatusCode(ResponseObject responseObject)
    
    Get status code in the returned data from a web service call
    throws:
    StepErrorException
    throws:
    StepFailedException
    
    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)
    Returns:
    the response status code
    Since:
    7.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequest(RequestObject request, FailureHandling flowControl)
    
    Send a HTTP Request to web server
    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
    Returns:
    @throws Exception
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequest(RequestObject request)
    
    Send a HTTP Request to web server
    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")
    Returns:
    @throws Exception
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequestAndVerify(RequestObject request, FailureHandling flowControl)
    
    Send a HTTP Request to web server and verify the response
    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
    Returns:
    @throws Exception
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequestAndVerify(RequestObject request)
    
    Send a HTTP Request to web server and verify the response
    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")
    Returns:
    @throws Exception
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void setHarFileGeneration(boolean enable)
    
    Katalon Studio will generate HAR file for each Web Service request by default. This keyword will allow us can enable or disable HAR file generations on demand.
    throws:
    StepFailedException If Katalon Studio could not save the setting
    
    Parameters:
    enable - true if enable HAR file generation. Otherwise, false.
    Since:
    8.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void setHarFileGeneration(boolean enable, FailureHandling flowControl)
    
    Katalon Studio will generate HAR file for each Web Service request by default. This keyword will allow us can enable or disable HAR file generations on demand.
    throws:
    StepFailedException If Katalon Studio could not save the setting
    
    Parameters:
    enable - true if enable HAR file generation. Otherwise, false.
    flowControl - FailureHandling
    Since:
    8.2.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema, FailureHandling flowControl)
    
    Validate a GraphQL request body against a GraphQL schema
    throws:
    StepFailedException If could not find the schema file, the request does not have a body content, or the request did not pass the validation
    
    Parameters:
    request - The request object to be validated, of type RequestObject
    graphqlSchema - The GraphQL schema to validate against, which can be a JSON String, an URL, or a File path
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop, of type FailureHandling
    Returns:
    true if the request passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema)
    
    Validate a GraphQL request body against a GraphQL schema
    throws:
    StepFailedException If could not find the schema file, the request does not have a body content, or the request did not pass the validation
    
    Parameters:
    request - The request object to be validated, of type RequestObject
    graphqlSchema - The GraphQL schema to validate against, which can be a JSON String, an URL, or a File path
    Returns:
    true if the request passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(String jsonObject, String jsonSchema, FailureHandling flowControl)
    
    Validate a JSON object against a JSON schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    jsonObject - The JSON object to be validated, of type String
    jsonSchema - The JSON schema to validate against, which can be a JSON String, an URL, or a File path
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop, of type FailureHandling
    Returns:
    true if the JSON object passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(String jsonObject, String jsonSchema)
    
    Validate a JSON object against a JSON schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    jsonObject - The JSON object to be validated, of type String
    jsonSchema - The JSON schema to validate against, which can be a JSON String, an URL, or a File path
    Returns:
    true if the JSON object passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(ResponseObject response, String jsonSchema)
    
    Validate a response against a JSON schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    response - The response object to be validated, of type ResponseObject
    jsonSchema - The JSON schema to validate against, which can be a JSON String, an URL, or a File path
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(ResponseObject response, String jsonSchema, FailureHandling flowControl)
    
    Validate a response against a JSON schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    response - The response object to be validated, of type ResponseObject
    jsonSchema - The JSON schema to validate against, which can be a JSON String, an URL, or a File path
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop, of type FailureHandling
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(RequestObject request, String specSrc)
    
    Validate an OpenAPI/Swagger request against an OpenAPI/Swagger specification
    throws:
    StepFailedException If could not find the schema file or the request did not pass the validation
    
    Parameters:
    request - Specify the request object that needs to be validated
    specSrc - Specify the OpenAPI/Swagger specification used to validate the OpenAPI/Swagger object
    Returns:
    true if the request passed the validation, false otherwise
    Since:
    9.7.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(RequestObject request, String specSrc, FailureHandling flowControl)
    
    Validate an OpenAPI/Swagger request against an OpenAPI/Swagger specification
    throws:
    StepFailedException If could not find the schema file or the request did not pass the validation
    
    Parameters:
    request - Specify the request object that needs to be validated
    specSrc - Specify the OpenAPI/Swagger specification used to validate the OpenAPI/Swagger object
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop
    Returns:
    true if the request passed the validation, false otherwise
    Since:
    9.7.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc)
    
    Validate an OpenAPI/Swagger response against an OpenAPI/Swagger specification
    throws:
    StepFailedException If could not find the schema file or the response did not pass the validation
    
    Parameters:
    response - Specify the response object that needs to be validated
    request - Specify the request for the response that needs to be validated
    specSrc - Specify the OpenAPI/Swagger specification used to validate the OpenAPI/Swagger object
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    9.7.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc, FailureHandling flowControl)
    
    Validate an OpenAPI/Swagger response against an OpenAPI/Swagger specification
    throws:
    StepFailedException If could not find the schema file or the response did not pass the validation
    
    Parameters:
    response - Specify the response object that needs to be validated
    request - Specify the request for the response that needs to be validated
    specSrc - Specify the OpenAPI/Swagger specification used to validate the OpenAPI/Swagger object
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    9.7.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(String xmlObject, String xmlSchema, FailureHandling flowControl)
    
    Validate an XML object against an XML schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    xmlObject - The XML object to be validated
    xmlSchema - The XML schema to validate against, which can be a JSON String, an URL, or a File path
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop, of type FailureHandling
    Returns:
    true if the XML object passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(String xmlObject, String xmlSchema)
    
    Validate an XML object against an XML schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    xmlObject - The XML object to be validated
    xmlSchema - The XML schema to validate against, which can be a JSON String, an URL, or a File path
    Returns:
    true if the XML object passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(ResponseObject response, String xmlSchema)
    
    Validate a response against an XML schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    response - The response object to be validated, of type ResponseObject
    xmlSchema - The XML schema to validate against, which can be a JSON String, an URL, or a File path
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(ResponseObject response, String xmlSchema, FailureHandling flowControl)
    
    Validate a response against an XML schema
    throws:
    StepFailedException If could not find the schema file or the response didn't pass the validation
    
    Parameters:
    response - The response object to be validated, of type ResponseObject
    xmlSchema - The XML schema to validate against, which can be a JSON String, an URL, or a File path
    flowControl - Specify failure handling schema to determine whether the execution should be allowed to continue or stop, of type FailureHandling
    Returns:
    true if the response passed the validation, false otherwise
    Since:
    8.4.0
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(ResponseObject response, String locator, Object value, FailureHandling flowControl)
    
    Verify that there is an element with expected property value appear in the returned data from a web service call
    throws:
    StepErrorException
    
    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
    Returns:
    true if your expectation is met, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(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
    
    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)
    Returns:
    true if your expectation is met, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(ResponseObject response, String locator, String text, 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
    
    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
    Returns:
    true if your element text is found, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(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
    
    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)
    Returns:
    true if your element text is found, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(ResponseObject response, String locator, int count, FailureHandling flowControl)
    
    Verify number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    Exception
    
    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
    Returns:
    true if your expectation is met, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(ResponseObject response, String locator, int count)
    
    Verify number of expected elements (JSON/XML) in the response (output) of a web service call
    throws:
    Exception
    
    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)
    Returns:
    true if your expectation is met, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(ResponseObject responseObject, int expectedStatusCode, FailureHandling flowControl)
    
    Verify status code in the returned data from a web service call
    throws:
    StepFailedException
    
    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
    Returns:
    true if the response status code is the same as the expected status code, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(ResponseObject responseObject, int expectedStatusCode)
    
    Verify status code in the returned data from a web service call
    throws:
    StepFailedException
    
    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
    Returns:
    true if the response status code is the same as the expected status code, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(ResponseObject responseObject, int fromStatusCode, int toStatusCode, FailureHandling flowControl)
    
    Verify status code valid in a range of status codes in the returned data from a web service call
    throws:
    StepFailedException
    
    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
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(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
    
    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
    Returns:
    true if the response status code is in a range of the expected status code, otherwise false

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class WSBuiltInKeywords

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

WSBuiltInKeywords()

Method Detail

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(ResponseObject response, String string, boolean useRegex, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_TEXT) static boolean containsString(ResponseObject response, String string, boolean useRegex)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static Object getElementPropertyValue(ResponseObject response, String locator, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static Object getElementPropertyValue(ResponseObject response, String locator)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static String getElementText(ResponseObject response, String locator, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static String getElementText(ResponseObject response, String locator)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getElementsCount(ResponseObject response, String locator, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getElementsCount(ResponseObject response, String locator)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean getHarFileGeneration()

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static boolean getHarFileGeneration(FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getResponseStatusCode(ResponseObject responseObject, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static int getResponseStatusCode(ResponseObject responseObject)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequest(RequestObject request, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequest(RequestObject request)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequestAndVerify(RequestObject request, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static ResponseObject sendRequestAndVerify(RequestObject request)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void setHarFileGeneration(boolean enable)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void setHarFileGeneration(boolean enable, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateGraphqlRequestAgainstSchema(RequestObject request, String graphqlSchema)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(String jsonObject, String jsonSchema, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(String jsonObject, String jsonSchema)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(ResponseObject response, String jsonSchema)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateJsonAgainstSchema(ResponseObject response, String jsonSchema, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(RequestObject request, String specSrc)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(RequestObject request, String specSrc, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateOpenAPIAgainstSpecification(ResponseObject response, RequestObject request, String specSrc, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(String xmlObject, String xmlSchema, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(String xmlObject, String xmlSchema)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(ResponseObject response, String xmlSchema)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_REQUEST) static boolean validateXmlAgainstSchema(ResponseObject response, String xmlSchema, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(ResponseObject response, String locator, Object value, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementPropertyValue(ResponseObject response, String locator, Object value)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(ResponseObject response, String locator, String text, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementText(ResponseObject response, String locator, String text)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(ResponseObject response, String locator, int count, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyElementsCount(ResponseObject response, String locator, int count)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(ResponseObject responseObject, int expectedStatusCode, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCode(ResponseObject responseObject, int expectedStatusCode)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(ResponseObject responseObject, int fromStatusCode, int toStatusCode, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_ELEMENT) static boolean verifyResponseStatusCodeInRange(ResponseObject responseObject, int fromStatusCode, int toStatusCode)