Introduction
As a complete scriptless automation testing platform, Qualitia helps testing RESTFul APIs. Executing API service requires few header parameters to be set before initialization of the service. Qualitia gives you provision to set all the header parameters centrally in the restgenericheaders.properties file. This makes managing all the header parameters easy at single place.
You will find this file at Qualitia installed location (%localAppData%/QualitiaWDClient > app-6.0.0 > WebDriver > config).
For information about setting these parameters for executing test cases using Qualitia offline package, refer to the Configuring Generic Headers for API Actions section.
REST.Request.RemoveGenericHeaders
This action helps you skip the generic headers you set in the restgenericheaders.properties file.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| HeaderKey | Enter the header key which you want to skip from the the restgenericheaders.properties file. | Yes | String |
Example:
REST.Request.RemoveGenericHeaders "Content-type"
REST.Request.ResetGenericHeaders
This action helps you reset the generic headers which you have skipped earlier in the test case. The sequence of this action must be set post REST.Request.RemoveGenericHeaders.
This action does not have any parameters.
Example:
REST.Request.ResetGenericHeaders
REST.Request.SetHeaders
This action stores key value pair of the header under specified variable (HeaderLable). Headers stored under the variable then can be used later in the test case using the HeaderLable (variable name).
You may store multiple headers using test data. This action must be used before executing API service.
Headers set using this action will override the headers set in the restgenericheaders.properties file.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| HeaderLable | Enter the variable name under which you want to store the key=value pair of the header. | Yes | String |
| HeaderKey | Enter the header key which you want to set for the API service to be executed. | Yes | String |
| HeaderValue | Enter the value for the key set above. | Yes | String |
Example:
REST.Request.SetHeaders "H1" "If-Match" "a8f34"
REST.Request.SetHeaders "H2" "accept" "application/xml"
Final Output: While considering H2 as a header label, system will override the values provided (accept=application/xml) in the earlier action (REST.SetGenericHeader) while executing the API service.
REST.Request.SetQueryParameters
This action helps you set query parameters for the API service you want to execute. Query parameters you set here are applicable only for the API service you use in the step followed by this action.
You may set multiple query parameters using test data. This action must be used before executing API service.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| QueryKey | Enter the key which you want to set for the API service to be executed. | Yes | String |
| QueryValue | Enter the value for the key set above. | Yes | String |
Example:
REST.Request.SetQueryParameters "draftId" "1031143439"
REST.Request.ClearQueryParameters
This action clears the query parameters you set earlier in the test case. If you are using more than one web service actions in a single test case, it is important to clear query parameters set earlier (if any) using this action, else, step may fail.
This action does not have any parameters.
Example:
REST.Request.ClearQueryParameters
REST.Auth.Basic
This action helps you set the basic authentication details for the API service you want to execute. Authentication details you provide here are applicable for the entire session of the test case or test suite.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Username | Enter the username for authentication. | Yes | String |
| Password | Enter the password for authentication. Password should be given in the specific format to be encrypted. Format: Encrypt(<PASSWORD>) | Yes | String |
Example:
REST.Auth.Basic "Qualitia" "Encrypt(Qualitia123)"
When the focus is moved away from the parameter, Qualitia will automatically encrypt the data ABC and result in a secured text like "vHpmlfI4R3PQkCN4sZnuqw==þNWE3ZDdkNjE3N2JmNDM2ODgxMzQwYWI1MTA3YWNjMDc="
REST.Auth.Digest
This action helps you set the digest authentication details for the API service you want to execute. Authentication details you provide here are applicable for the entire session of the test case or test suite.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Username | Enter the username for authentication. | Yes | String |
| Password | Enter the password for authentication. Password should be given in the specific format to be encrypted. Format: Encrypt(<PASSWORD>) | Yes | String |
Example:
REST.Auth.Digest "Qualitia" "Encrypt(Qualitia123)"
When the focus is moved away from the parameter, Qualitia will automatically encrypt the data ABC and result in a secured text like "vHpmlfI4R3PQkCN4sZnuqw==þNWE3ZDdkNjE3N2JmNDM2ODgxMzQwYWI1MTA3YWNjMDc="
REST.Auth.Bearer
This action helps you set the bearer authentication details for the API service you want to execute. Authentication details you provide here are applicable for the entire session of the test case or test suite.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Token | Enter the token to access API service you want to execute. | Yes | String |
Example:
REST.Auth.Bearer "haiosehtoiasjgpaodsjcuasworijgdsf"
REST.Auth.JWT
This action helps you set the jwt authentication details for the API service you want to execute. Authentication details you provide here are applicable for the entire session of the test case or test suite.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Token | Enter the token to access API service you want to execute. | Yes | String |
Example:
REST.Auth.JWT "haiosehtoiasjgpaodsjcuasworijgdsf"
REST.GET.ExecuteAPI
This action helps to pull the desired data using GET method while executing the API service.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
This action supports XML or JSON application file types.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. File types supported are XML and JSON. | Yes | String |
ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
External certificate files are not supported. To store HTML API responses, ReponseFilePath should contain file path to .html file. The action fails in case the response is in html format and ReponseFilePath contains path to the .xml or .json file.
Example:
REST.GET.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "" "False" "C:\Users\Qualitia\Request-Cust_List.xml" "200"
REST.GET.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "HeaderLebel" "False" "C:\Users\Qualitia\Request-Cust_List.json" "4xx"
REST.POST.ExecuteAPI
This action helps to add the desired data using POST method while executing the API service.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
This action supports XML or JSON application file types.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file from which you want to post the data. File types supported are XML and JSON. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. File types supported are XML and JSON. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
To store HTML API responses, ReponseFilePath should contain file path to .html file. The action fails in case the response is in html format and ReponseFilePath contains path to the .xml or .json file.
Example:
REST.POST.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "" "False" "C:\Users\Qualitia\Request-Cust_List.xml" "2xx,3xx"
REST.POST.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "HeaderLebel" "False" "C:\Users\Qualitia\Request-Cust_List.json" "200,300"
REST.PUT.ExecuteAPI
This action helps to update the desired data using PUT method while executing the API service.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
This action supports XML or JSON application file types.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file from which you want to post the data. File types supported are XML and JSON. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. File types supported are XML and JSON. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
To store HTML API responses, ReponseFilePath should contain file path to .html file. The action fails in case the response is in html format and ReponseFilePath contains path to the .xml or .json file.
Example:
REST.PUT.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "" "False" "C:\Users\Qualitia\Request-Cust_List.xml" "400"
REST.PUT.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "HeaderLebel" "False" "C:\Users\Qualitia\Request-Cust_List.json" "2xx,400"
REST.DELETE.ExecuteAPI
This action helps to remove the desired data using DELETE method while executing the API service.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
This action supports XML or JSON application file types.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file from which you want to post the data. File types supported are XML and JSON. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. File types supported are XML and JSON. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
To store HTML API responses, ReponseFilePath should contain file path to .html file. The action fails in case the response is in html format and ReponseFilePath contains path to the .xml or .json file.
Example:
REST.DELETE.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "" "False" "C:\Users\Qualitia\Request-Cust_List.xml" "300"
REST.DELETE.ExecuteAPI “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" "Basic" "HeaderLebel" "False" "C:\Users\Qualitia\Request-Cust_List.json" "500,2xx"
REST.GET.ExecuteAPIFormData
This action helps to pull the desired information using GET method while executing the API service with the help of form-data. The form-data can contain one or multiple sets of key-value pairs which will eventually help in executing the specified request method.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.GET.ExecuteAPIFormData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "3xx"
REST.POST.ExecuteAPIFormData
This action helps to add desired information using POST method while executing the API service with the help of form-data. The form-data can contain one or multiple sets of key-value pairs which will eventually help in executing the specified request method.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| FormData | Enter the key value pairs of the form data to be used while executing the service. Multiple pairs should be separated by a caret sign (^). If you want to use file to provide form data, add all the form data in some file and provide absolute path to that file as a parameter. Data in the file should be well formatted. | Optional | Array |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.POST.ExecuteAPIFormData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” "File=C:\Users\Qualitia\Request-Cust_List.json" “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "3xx"
REST.PUT.ExecuteAPIFormData
This action helps to update desired information using PUT method while executing the API service with the help of form-data. The form-data can contain one or multiple sets of key-value pairs which will eventually help in executing the specified request method.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the base URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| FormData | Enter the key value pairs of the form data to be used while executing the service. Multiple pairs should be separated by a caret sign (^). If you want to use file to provide form data, add all the form data in some file and provide absolute path to that file as a parameter. Data in the file should be well formatted. | Optional | Array |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.PUT.ExecuteAPIFormData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” "File=C:\Users\Qualitia\Request-Cust_List.json" “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "3xx"
REST.DELETE.ExecuteAPIFormData
This action helps to remove desired information using DELETE method while executing the API service with the help of form-data. The form-data can contain one or multiple sets of key-value pairs which will eventually help in executing the specified request method.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the base URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| FormData | Enter the key value pairs of the form data to be used while executing the service. Multiple pairs should be separated by a caret sign (^). If you want to use file to provide form data, add all the form data in some file and provide absolute path to that file as a parameter. Data in the file should be well formatted. | Optional | Array |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.DELETE.ExecuteAPIFormData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” "File=C:\Users\Qualitia\Request-Cust_List.json" “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "400"
REST.GET.ExecuteAPIDownloadRawData
This action helps to pull the desired information using GET method. You can download raw data file after executing the action giving the desired download location.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| DownloadLocation | Enter the folder directory location where you want to store the raw data after executing the test case. | Yes | String |
ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.GET.ExecuteAPIDownloadRawData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "D:\New Folder\RawDataFiles" "300"
REST.PUT.ExecuteAPIDownloadRawData
This action helps to update desired information using PUT method. It uses raw data while executing API service. You can download raw data file after executing the action giving desired download location.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file which has REST request-related information. In this file, you can specify the details which you want to update. | ||
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| DownloadLocation | Enter the folder directory location where you want to store the raw data after executing the test case. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.PUT.ExecuteAPIDownloadRawData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” “C:\Users\Qualitia\Request-Cust_List.json” “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "D:\New Folder\RawDataFiles" "300"
REST.POST.ExecuteAPIDownloadRawData
This action helps to add desired information using POST method. It uses raw data while executing API service. You can download raw data file after executing the action giving desired download location.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file which has REST request-related information. In this file, you can specify the details which you want to add. | ||
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| DownloadLocation | Enter the folder directory location where you want to store the raw data after executing the test case. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.POST.ExecuteAPIDownloadRawData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” “C:\Users\Qualitia\Request-Cust_List.json” “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "D:\New Folder\RawDataFiles" "300"
REST.DELETE.ExecuteAPIDownloadRawData
This action helps to delete desired information using DELETE method. It uses raw data while executing API service. You can download raw data file after executing the action giving desired download location.
This action can work independently or it can be used in a combination of other REST actions like REST.Request.SetGenericHeaders, REST.Request.SetHeaders, REST.Request.SetQueryParameters, REST.Auth.Basic/Digest/Bearer/JWT, based on the test case requirements.
You can also store the information related to HTTP Status, HTTP REQUEST TIME, and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| BaseURL | Enter the URL where you want to execute the API service. | Yes | String |
| BasePath | Enter the base path where you want to execute API service. You can include path in the BaseURL parameter itself. In that case, you may keep this parameter blank. | Optional | String |
| RequestFilepath | Enter the absolute path to the file which has REST request-related information. In this file, you can specify the details which you want to DELETE. | ||
| AuthenticationType | Enter authentication type you want to use while executing the API service. Values for this field can be either: Basic, Bearer, JWT, or Digest. Keeping this field blank will be taken as no authentication. For Basic, Bearer, JWT, and Digest authentication types, details will be taken from the previous steps where details are provided. | Optional | String |
| HeaderLabel | Enter the header label in case you have specified it earlier in the test case/task. | Optional | String |
| SSLFlag | Using this parameter, you can decide whether you want to consider SSL certificate while executing the API service.
| Optional | String |
| ResponseFilepath | Enter the absolute path to the file where you want to store the response you get after the service is executed. | Yes | String |
| DownloadLocation | Enter the folder directory location where you want to store the raw data after executing the test case. | Yes | String |
| ExpectedHTTPStatusCode | You can give the http status code that you expect at the end of the API service execution. From all the available forty different status code, you can provide any value that you expect. In case you are not sure about the exact expected value, you can also give the category of http status code. For example, 1xx, 2xx, and so forth. Multiple codes or code ranges can be given separated by comma (,). | Optional | String |
Example:
REST.DELETE.ExecuteAPIDownloadRawData “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT” “C:\Users\Qualitia\Request-Cust_List.json” “Bearer” "HeaderLabel1” "True" “C:\Users\Qualitia\Reponse-Cust_List.json” "D:\New Folder\RawDataFiles" "300"
REST.Response.StoreStatusCode
This action stores the status of the API service after execution under the specified variable. You can use the status code based on the test case requirements using the variable name.
This action has to be used immediately followed by the API service action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| key | Enter the variable name under which you want to store the status code of the API service executed. | Yes | String |
Example:
REST.Response.StoreStatusCode "Status"
REST.Response.StoreHeaders
This action stores the headers received after the service is executed under the specified variable. You can use the header data based on the test case requirements using the variable name.
This action has to be used immediately followed by the API service action.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| key | Enter the variable name under which you want to store the header data of the API service executed. | Yes | String |
Example:
REST.Response.StoreHeaders "HeaderData"
REST.Response.StoreHeaderValue
This action stores the specified header value from the response given by API service under the specified key. You can then use the stored value based on your test case requirements.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| key | Enter the variable name under which you want to store the header value of the specified key. | Yes | String |
| HeaderKey | Enter the header key whose value you want to store from the response header. | Yes | String |
Example:
REST.Response.StoreHeaderValue "Key" "Content-type"
REST.Response.VerifyStatusCode
This action verifies the status of the API service executed against the status specified by the user. This helps in deciding the test case or test suite flow based on the API service status.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Key | This is the variable name under which the status is stored using the REST.StoreStatusCode action. | Yes | String |
| ExpectedStatus | Enter the expected status here to verify against the actual status of the API service executed. | Yes | String |
Example:
REST.Response.VerifyStatusCode "Status" "ExpectedStatus"
REST.Response.VerifyHeaders
This action verifies the header data of the API service executed against the status specified by the user. This helps in deciding the test case or test suite flow based on the header data.
You can give multiple sets of key and value pairs using test data.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| Key | This is the variable name under which the status is stored using the REST.StoreStatusCode action. | Yes | String |
| ExpectedStatus | Enter expected status here to verify against actual status of the API service executed. | Yes | String |
Example:
REST.Response.VerifyHeaders "Status" "ExpectedStatus"
XML.UpdateNodeValue
This action reads the specified XML file and updates the inner value of the specified node.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file from which you want to update the value. | Yes | String |
| Xpath | Enter the path to the node (Xpath) whose value you want to update. | Yes | String |
| value | Enter the value which you want to add in the specified node. | Yes | String |
Example: Refer to the image above
XML.UpdateNodeValue “C:\Users\Qualitia\Actors_List.xml” "//actors/actor[@id='1']" “Abraham Kennedy”
If you execute this action in the XML mentioned above, this John Doe will be replaced by Abraham Kennedy.
XML.StoreNodeValue
This action reads the specified XML file and stores the inner value of the specified node under the specified key. The key value can be retrieved using the key name.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file from which you want to get and store the value. | Yes | String |
| Xpath | Enter the path to the node (XPath) from which you want to read and store the inner text. | Yes | String |
strKey | Enter the key name under which you want to store the node value (inner text from the node). | Yes | String |
Example: Refer to the image above
XML.StoreNodeValue “C:\Users\Qualitia\Actors_List.xml” "//actors/actor[@id="3"]" “ActorName”
If you execute this action in the XML mentioned above, this William Kennedy will be stored under the key name ActorName. You can use the value stored under the ActorName key in the test case execution flow.
XML.StoreAttributeValue
This action reads the XML file and stores the value of the specified attribute under the key. The key value can be retrieved using the key name.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
| Key_Result | Enter the key name under which you want to store the attribute value. | Yes | String |
XmlFilePath | Enter the absolute path to the XML file from which you want to get and store the value. | Yes | String |
| Xpath | Enter the path to the attribute (XPath) from which you want to read and store the value. | Yes | String |
AttributeName | Enter the attribute name whose value you want to store. | Yes | String |
Example: Refer to the image above
XML.StoreAttributeValue “Key” “C:\Users\Qualitia\Actors_List.xml” "//actors/actor" “id”
In this example above, as there are multiple nodes available under the specified xpath, value of the first node will be stored under the specified key.
XML.StoreNodeCount
This action reads the XML file and stores the count of the specified node under the key. The key value can be retrieved using the key name.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
Key_NodeCount | Enter the key name under which you want to store the node count. | Yes | String |
XmlFilePath | Enter the absolute path to the XML file from which you want to get and store the node count. | Yes | String |
| Xpath | Enter the path to the node (XPath) from which you want to store the count. | Yes | String |
Example: Refer to the image above
XML.StoreNodeCount “Key” “C:\Users\Qualitia\Actors_List.xml” "//actors"
In this example mentioned above, node count of the node actors will be stored in the specified key.
XML.VerifyIfNodeExists
This action reads the XML file and verifies whether the specified node exists in the XML document.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file from which you want to get and store the existence of the node. | Yes | String |
| Xpath | Enter the path to the node (XPath) whose existence you want to verify. | Yes | String |
| Existence | Value for this parameter can be either True or False.
| No | String |
Example: Refer to the image above
Xml.VerifyIfNodeExists “C:\Users\Qualitia\Actors_List.xml” "//actors/actor" "True"
This action will verify whether the specified node exists in the XML file.
XML.VerifyIfAttributeExists
This action reads the XML file and verifies whether the specified attribute exists in the XML document.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file from which you want to get and store the existence of the attribute. | Yes | String |
| Xpath | Enter the path to the attribute (XPath) whose existence you want to verify. | Yes | String |
| AttributeName | Enter the attribute name whose existence you want to verify. | ||
| Existence | Value for this parameter can be either True or False.
| No | String |
Example: Refer to the image above
Xml.VerifyIfAttributeExists “C:\Users\Qualitia\Actors_List.xml” "//actors/actor[@id=1]" "True"
This action will verify whether the specified ID attribute exists in the XML file.
XML.UpdateAttributeValue
This action reads the specified XML file and updates the inner value of the specified attribute.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file in which you want to update the value. | Yes | String |
| Xpath | Enter the path to the attribute (Xpath) whose value you want to update. | Yes | String |
| AttributeName | Enter the attribute name whose value you want to update. | Yes | String |
| value | Enter the value which you want to add in the specified attribute. | Yes | String |
Example: Refer to the image above
XML.UpdateAttributeValue “C:\Users\Qualitia\Actors_List.xml” "//actors/actor[@id=1]" "id" “4”
This action will update the attribute value of the specified attribute to the given value (here 4).
XML.StoreEvaluatedXPathResult
This action stores the result of the requested xpath under the specified key. The result can be anything including (but not limited to) inner value of the node and attribute and so forth. You must create request XML based on the required result.
The result stored under the key can be retrieved using key name.
If the requested Xpath is returning multiple sets of values, Qualitia stores these values under key provided by user. Also, if there is no value to store under the key, Qualitia stores blank space.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
XmlFilePath | Enter the absolute path to the XML file from which you want to store the value. | Yes | String |
| Xpath | Enter the path to the attribute (Xpath) whose value you want to store. | Yes | String |
| Key | Enter the key name under which you want to store the result of the requested xpath. | Yes | String |
Example: Refer to the image above
XML.StoreEvaluatedXPathResult “C:\Users\Qualitia\Actors_List.xml” "//actors/text()" "Key"
Here, this action will store the empty space in the specified key, because there is no inner text present for the node <actors>.
XML.StoreEvaluatedXPathResult “C:\Users\Qualitia\Actors_List.xml” "//actors" "Key"
Here, this action will return all the values from the actors node, including child nodes. In this example above, Qualitia stores John Doe Jane Doe William Kennedy inside the key.
{
"firstName": "John",
"lastName" : "doe",
"age" : 26,
"address" : {
"streetAddress": "naist street",
"city" : "Nara",
"postalCode" : "6300192"
},
"phoneNumbers": [
{
"type" : "iPhone",
"number": "0123-4567-8888"
},
{
"type" : "home",
"number": "0123-4567-8910"
}
]
}
JSON.AddNode
This action adds the specified node (key=value pair) in the specified JSON file.
If you want to add multiple values under the key, you must give values in the correct format accordingly.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute file path to the JSON file where you want to add the node. | Yes | String |
| JSONPath | Enter the JSON path where you want to add the new node. Use $ if you want to add node at root level. | Yes | String |
| JSONKey | Enter the key of the node to be added in the JSON file. | No | String |
| JSONValue | Enter the value to be added for the key mentioned above. | No | String |
| JSONValueType | Enter the data type of the value being added as a value. Value type can be Boolean or Numeric. Keep the value type blank in case the data type is JSONObject, JSONArray, or String. | No | String |
Example: Refer to the example above
Adding node with single value:
JSON.AddNode “C:\Users\Qualitia\Cust_Details.json” “$.address” “PostalCode” "6932331" "Numeric"
End of the execution, this action add a new node as state and value as California under the node address.
Adding node with an array:
JSON.AddNode “C:\Users\Qualitia\Cust_Details.json” “$.address” “StateCode” "["CA" , "California"]" ""
End of the execution, this action add a new node as state and value as CA and California under the node address.
JSON.AddNode “C:\Users\Qualitia\Cust_Details.json” “$.phoneNumbers” “ ” "~{ "type" : "landline", "number": "0123-4567-3263" ~}" ""
End of the execution, this action add a new node as to display landline number inside the node phoneNumbers.
JSON.RemoveNode
This action removes the specified node from specified JSON file.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute file path to the JSON file from which you want to remove the node. | Yes | String |
| JSONPath | Enter the node path which you want to remove from the specified file. This action will remove all the data present inside the node including array. If JSON path contains array, ensure you use an [] with index. Index starts from 0. | Yes | String |
Example: Refer to the example above
JSON.RemoveNode “C:\Users\Qualitia\Cust_Details.json” “$.address.postalCode”
End of the execution, the node postalCode will be removed from the JSON file.
JSON.ConvertStringToFile
This action takes the JSON data given in the parameter and adds it in the specified JSON file.
In case the JSON file does not exist at the specified location, this action creates a new JSON file. Also, if the file contains some data, this action will overwrite old data with new data.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| JSONString | Enter the JSON string which you want to add in the JSON file. | Yes | String |
| OutputJSONFilePath | Enter the directory where you want to store the JSON file. | Yes | String |
Example:
JSON.ConvertStringToFile "~{ "firstName": "John", "lastName" : "doe", "age" : 26 ~}" “C:\Users\Qualitia\Cust_list.json”
End of the execution, a JSON new file will be added under the specified location with data as provided here.
JSON.ValidateStringSyntax
This action validates the JSON data given in the parameter.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| JSONString | Enter the JSON string which you want to validate. | Yes | String |
Example:
JSON.ValidateStringSyntax "~{ "firstName": "John", "lastName" : "doe", "age" : 26 ~}"
End of the execution, if the data is valid, action will pass, else action will fail.
JSON.StoreArray
This action stores the array data from the specified JSON path under the specified key. The key value can be retrieved using the key name.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute path to the JSON file from which you want to get and store array data. | Yes | String |
| JSONPath | Enter the JSON path whose data you want to get and store under the specified key. If JSON path contains array, ensure you use an [] with index. Index starts from 0. | Yes | String |
| Key | Enter the key under which you want to store the array data. | Yes | String |
Example:
JSON.StoreArray "C:\Users\Qualitia\Cust_Details.json" "$.phoneNumbers" "PhoneNumbers"
End of the execution, the array data present under the phoneNumbers JSON key will be stored under the PhoneNumbers key.
JSON.StoreAllUniqueKey
This action stores all the keys present in the JSON file. Multiple keys are stored separated by comma.
While executing this action, multiple instances of single key are counted as a single instance and it will be stored only once.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute path to the JSON file from which you want to get and store keys. | Yes | String |
| Key | Enter the key under which you want to store the JSON keys. | Yes | String |
Example:
JSON.StoreAllUniqueKey "C:\Users\Qualitia\Cust_Details.json" "AllKeys"
End of the execution, the complete list of JSON keys will be stored under the AllKeys key. Here AllKeys will store "firstName","lastName","age","address","streetAddress","city","postalCode","phoneNumbers","type","number".
JSON.StoreTotalKeyCount
This action stores the total number of keys available in the specified JSON file. The number is stored under the specified key.
While executing this action, multiple instances of single key are counted as a single instance and it will be counted only once.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute path to the JSON file from which you want to get and store total key count. | Yes | String |
| Key | Enter the key under which you want to store the JSON key count. | Yes | String |
Example:
JSON.StoreTotalKeyCount "C:\Users\Qualitia\Cust_Details.json" "TotalKeyCount"
End of the execution, the total number of keys will be stored under the TotalKeyCount (here, 10) key.
JSON.StoreSpecificKeyCount
This action stores the total number of instances of specified JSON key available in JSON file. The number is stored under the specified key.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute path to the JSON file from which you want to get and store total number of instances of the specified key. | Yes | String |
| JSONKey | Enter the key name for which you want to store the count. | Yes | String |
| Key | Enter the key under which you want to store the JSON key count. (case-sensitive) | Yes | String |
Example:
JSON.StoreSpecificKeyCount "C:\Users\Qualitia\Cust_Details.json" "TotalKeyCount" "type"
End of the execution, the total number of instances of the key type will be stored under the variable TotalKeyCount. Here, number 2 will be stored.
JSON.UpdateValue
This action reads JSON file and updates the JSON key value as per the given parameter.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
jsonFilePath | Enter the absolute path to the JSON file in which you want to set the value. | Yes | String |
| Jsonpath | Enter the path to the node (J Path) to which you want to set the value. If JSON path contains array, ensure you use an [] with index. Index starts from 0. | Yes | String |
| value | Enter the value which you want to set against the specified attribute. | Yes | String |
| JSONValueType | Enter the data type of the values to be added. Values can be Numeric and Boolean. Keep the value type blank in case the data type is JSONObject, JSONArray, or String. | Yes | String |
Example:
- Updating single value:
JSON.UpdateValue “C:\Users\Qualitia\Cust_Details.json” “$.address.postalCode” “6300194”
This action will update the value of the attribute postalCode to the value given in the parameter (here, 6300194).
- Updating value from the array: (see the example below)
JSON.UpdateValue “C:\Users\Qualitia\Cust_Details.json” “$[0].address.postalCode” “6300194”
JSON.StoreValue
This action reads JSON file, navigates to the JSON path, and stores the value of the specified attribute in the key. The key value can be retrieved using the key name.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
JsonFilePath | Enter the absolute path to the JSON file from which you want to store the value. | Yes | String |
| Jsonpath | Enter the path to the node (J Path) from which you want to read and store the value. | Yes | String |
| strKey | Enter the key name under which you want to store the value. | Yes | String |
Example: Refer to the example above
JSON.StoreValue “C:\Users\Qualitia\Cust_Details.json” “$.address.postalCode” “PostalCode”
This action will store the value present under the attribute postalCode under the key PostalCode.
JSON.UpdateValue
This action reads JSON file and updates the attribute value as per the given parameter.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
jsonFilePath | Enter the absolute path to the JSON file in which you want to set the value. | Yes | String |
| Jsonpath | Enter the path to the node (J Path) to which you want to set the value. | Yes | String |
| value | Enter the value which you want to set against the specified attribute. | Yes | String |
Example: Refer to the example above
JSON.UpdateValue “C:\Users\Qualitia\Cust_Details.json” “$.address.postalCode” “630-0194”
This action will update the value of the attribute postalCode to the value given in the parameter (here 630-0194).
JSON.StoreJsonPathCount
This action stores the count of specified JSON node under the key. The key value can be retrieved using the key name.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
jsonFilePath | Enter the absolute path to the JSON file in which you want to set the value. | Yes | String |
| Jsonpath | Enter the path to the node (J Path) to which you want to set the value. | Yes | String |
| value | Enter the value which you want to set against the specified attribute. | Yes | String |
Example: Refer to the example above
JSON.StoreJsonPathCount “C:\Users\Qualitia\Cust_Details.json” “$.address.postalCode” “630-0194”
This action will update the value of the attribute postalCode to the value given in the parameter (here 630-0194).
ValidateStringSyntaxinFile
This action validates the data given in the specified JSON or XML file.
Input Parameters:
| Parameter Name | Parameter Description | Mandatory | Data Types |
|---|---|---|---|
| FilePath | Enter the absolute path to the JSON/XML file from which you want to validate the data. | Yes | String |
Example:
ValidateStringSyntaxinFile "C:\Users\Qualitia\Cust_Details.json"
End of the execution, if the data from the specified file is valid, action will pass, else action will fail.
REST.ExecuteService
This action executes the specified REST request. Qualitia gives you provision to store the response at the specified file path location in the JSON format, if required.
You can store the information related to HTTP Status and Header into the variable and use these values to develop test case flow after executing this action.
URLs with invalid/expired SSL certificates are not supported.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
BaseUrl | Enter the base URL where you want to execute the request. | Yes | String |
ApiMethod | Enter the API method you want to execute on the specified URL. | Yes | String |
| RequestMethod | Enter the method you want to execute on the API url mentioned above. | Yes | String |
| RequestJsonFilePath | Enter the absolute path to the file which has REST request related information in the JSON format. In this file, you can enter the details which you want to Get, Push and so forth. | No | String |
| ResultJsonFilePath | Enter the absolute path to the file in which you want to store the REST result. | No | String |
| AuthenticationType | Enter the authentication type you want to use when executing the REST request. Qualitia supports Basic authentication types. | Yes | String |
| UserName | Enter the username if the authentication type selected is Basic. | No | String |
| Password | Enter the password if the authentication type selected is Basic. | No | String |
| RequestHeader | Enter the request headers you want to pass when executing the REST request. Multiple headers should be separated by semi colon (;). | No | String |
Example:
REST.ExecuteService “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" “POST” “C:\Users\Qualitia\Request-Cust_List.json” “C:\Users\Qualitia\Response-Cust_List.json” "Basic" “john.doe@gmail.com” “john.doe@123” "Content-Type=application/x-www-;Authentication=Basic fasdhlsdv"
SOAP.ExecuteService
This action executes the SOAP request in the specified XML file. You can also store response in the XML file, if required.
You can store the information related to HTTP Status and Header into the variable and use these values to develop test case flow after executing this action.
URLs with invalid/expired SSL certificates are not supported.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
ServiceUrl | Enter the service URL where you want to execute the request. | Yes | String |
| SoapAction | Specify the method from your SOAP requests which you want to execute here. | No | String |
RequestMethod | Enter method you want to execute on the specified URL. | Yes | String |
| RequestXmlPath | Enter the absolute path to the file which has REST request related information in the JSON format. In this file, you can enter the details which you want to Get, Push and so forth. | No | String |
| ResponseXmlPath | Enter the absolute path to the XML file where the results will be stored. | Yes | String |
| requestHeaders | Enter the request headers you want to pass when executing the REST request. Multiple headers should be separated by semi colon (;). | No | String |
Example:
SOAP.ExecuteService “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "ProjectMapping/OAT" “POST” “C:\Users\Qualitia\Request-Cust_List.xml” “C:\Users\Qualitia\Response-Cust_List.xml” "Content-Type=application/x-www-;Authentication=Basic fasdhlsdv"
REST.ExecuteAPIService
This action executes the specified REST request. You can enable or disable the SSL certificate while executing this action. Qualitia gives you provision to store the response at the specified file path location in the JSON format, if required.
You can store the information related to HTTP Status and Header into the variable and use these values to develop test case flow after executing this action.
Input Parameters:
Parameter Name | Parameter Description | Mandatory | Data Type |
|---|---|---|---|
URL | Enter the complete REST URL. | Yes | String |
| RequestMethod | Enter the method you want to execute on the API url mentioned above. | Yes | String |
| RequestJsonFilePath | Enter the absolute path to the file which has REST request related information in the JSON format. In this file, you can enter the details which you want to Get, Push and so forth. | No | String |
| ResultJsonFilePath | Enter the absolute path to the file in which you want to store the REST result. | No | String |
| AuthenticationType | Enter the authentication type you want to use when executing the REST request. Qualitia supports Basic authentication types. | Yes | String |
| UserName | Enter the username if the authentication type selected is Basic. | No | String |
| Password | Enter the password if the authentication type selected is Basic. | No | String |
| RequestHeader | Enter the request headers you want to pass when executing the REST request. Multiple headers should be separated by semi colon (;). | No | String |
| SSLCertificateVerification | You can use this parameter to enable or disable the SSL certificate while executing this action.
| No | String |
Example:
REST.ExecuteAPIService “https://<HOST_NAME>:<PORT_NUMBER>/<REST_URL>” "POST” “C:\Users\Qualitia\Request-Cust_List.json” “C:\Users\Qualitia\Response-Cust_List.json” "Basic" “john.doe@gmail.com” “john.doe@123” "Content-Type=application/x-www-;Authentication=Basic fasdhlsdv" "True"
